subnets

Creates, updates, deletes, gets or lists a subnets resource.

Overview

Name	subnets
Type	Resource
Id	google.vmwareengine.subnets

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet
gatewayIp	string	The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.
ipCidrRange	string	The IP address range of the subnet in CIDR format '10.0.0.0/24'.
state	string	Output only. The state of the resource.
type	string	Output only. The type of the subnet. For example "management" or "userDefined".
vlanId	integer (int32)	Output only. VLAN ID of the VLAN on which the subnet is configured

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet
gatewayIp	string	The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.
ipCidrRange	string	The IP address range of the subnet in CIDR format '10.0.0.0/24'.
state	string	Output only. The state of the resource.
type	string	Output only. The type of the subnet. For example "management" or "userDefined".
vlanId	integer (int32)	Output only. VLAN ID of the VLAN on which the subnet is configured

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId, subnetsId		Gets details of a single subnet.
list	select	projectsId, locationsId, privateCloudsId	pageSize, pageToken	Lists subnets in a given private cloud.
patch	update	projectsId, locationsId, privateCloudsId, subnetsId	updateMask	Updates the parameters of a single subnet. Only fields specified in update_mask are applied. Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
privateCloudsId	string
projectsId	string
subnetsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single subnet.

SELECT
name,
gatewayIp,
ipCidrRange,
state,
type,
vlanId
FROM google.vmwareengine.subnets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND subnetsId = '{{ subnetsId }}' -- required;

list

Lists subnets in a given private cloud.

SELECT
name,
gatewayIp,
ipCidrRange,
state,
type,
vlanId
FROM google.vmwareengine.subnets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

UPDATE examples

patch

Updates the parameters of a single subnet. Only fields specified in update_mask are applied. Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

UPDATE google.vmwareengine.subnets
SET 
data__ipCidrRange = '{{ ipCidrRange }}',
data__gatewayIp = '{{ gatewayIp }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND subnetsId = '{{ subnetsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;