# Compute V1 Client - Class Subnetwork (2.10.0)

2.10.0 (latest) 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.0.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.1 1.21.0 1.20.0 1.19.0 1.18.1 1.17.0 1.16.2 1.14.0 1.13.0 1.12.1 1.11.1 1.10.1 1.9.1 1.8.3 1.7.1 1.6.1 1.5.0 Reference documentation and code samples for the Compute V1 Client class Subnetwork.

Represents a Subnetwork resource.

A subnetwork (also known as a subnet) is a logical partition of a Virtual
Private Cloud network with one primary IP range and zero or more secondary
IP ranges. For more information, read
Virtual Private Cloud (VPC) Network.

Generated from protobuf message `google.cloud.compute.v1.Subnetwork`

## Namespace

Google \\ Cloud \\ Compute \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ allow_subnet_cidr_routes_overlap` | `bool` Whether this subnetwork's ranges can conflict with existing custom routes. Setting this to true allows this subnetwork's primary and secondary ranges to overlap with (and contain) custom routes that have already been configured on the corresponding network. For example if a static route has range 10.1.0.0/16, a subnet range 10.0.0.0/8 could only be created if allow_conflicting_routes=true. Overlapping is only allowed on subnetwork operations; routes whose ranges conflict with this subnetwork's ranges won't be allowed unless route.allow_conflicting_subnetworks is set to true. Typically packets destined to IPs within the subnetwork (which may contain private/sensitive data) are prevented from leaving the virtual network. Setting this field to true will disable this feature. The default value is false and applies to all existing subnetworks and automatically created subnetworks. |
| `↳ creation_timestamp` | `string` Output only. \[Output Only\] Creation timestamp inRFC3339 text format. |
| `↳ description` | `string` An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. |
| `↳ enable_flow_logs` | `bool` Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead. |
| `↳ external_ipv6_prefix` | `string` The external IPv6 address range that is owned by this subnetwork. |
| `↳ fingerprint` | `string` Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. |
| `↳ gateway_address` | `string` Output only. \[Output Only\] The gateway address for default routes to reach destination addresses outside this subnetwork. |
| `↳ id` | `int|string` Output only. \[Output Only\] The unique identifier for the resource. This identifier is defined by the server. |
| `↳ internal_ipv6_prefix` | `string` The internal IPv6 address range that is owned by this subnetwork. |
| `↳ ip_cidr_range` | `string` The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in theValid ranges list. The range can be expanded after creation usingexpandIpCidrRange. |
| `↳ ip_collection` | `string` Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack or IPv6-only subnetwork with external access using BYOIP: - Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name |
| `↳ ipv6_access_type` | `string` The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. Check the Ipv6AccessType enum for the list of possible values. |
| `↳ ipv6_cidr_range` | `string` Output only. \[Output Only\] This field is for internal use. |
| `↳ ipv6_gce_endpoint` | `string` Output only. \[Output Only\] Possible endpoints of this subnetwork. It can be one of the following: - VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. Check the Ipv6GceEndpoint enum for the list of possible values. |
| `↳ kind` | `string` Output only. \[Output Only\] Type of the resource. Always compute#subnetwork for Subnetwork resources. |
| `↳ log_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkLogConfig` This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. |
| `↳ name` | `string` The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| `↳ network` | `string` The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. |
| `↳ params` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkParams` Input only. \[Input Only\] Additional params passed with the request, but not persisted as part of resource payload. |
| `↳ private_ip_google_access` | `bool` Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. |
| `↳ private_ipv6_google_access` | `string` This field is for internal use. This field can be both set at resource creation time and updated usingpatch. Check the PrivateIpv6GoogleAccess enum for the list of possible values. |
| `↳ purpose` | `string` Check the Purpose enum for the list of possible values. |
| `↳ region` | `string` URL of the region where the Subnetwork resides. This field can be set only at resource creation time. |
| `↳ reserved_internal_range` | `string` The URL of the reserved internal range. |
| `↳ resolve_subnet_mask` | `string` Configures subnet mask resolution for this subnetwork. Check the ResolveSubnetMask enum for the list of possible values. |
| `↳ role` | `string` The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. Check the Role enum for the list of possible values. |
| `↳ secondary_ip_ranges` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkSecondaryRange>` An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges. |
| `↳ self_link` | `string` \[Output Only\] Server-defined URL for the resource. |
| `↳ stack_type` | `string` The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated usingpatch. Check the StackType enum for the list of possible values. |
| `↳ state` | `string` Output only. \[Output Only\] The state of the subnetwork, which can be one of the following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status ofREADY Check the State enum for the list of possible values. |
| `↳ system_reserved_external_ipv6_ranges` | `string[]` Output only. \[Output Only\] The array of external IPv6 network ranges reserved from the subnetwork's external IPv6 range for system use. |
| `↳ system_reserved_internal_ipv6_ranges` | `string[]` Output only. \[Output Only\] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. |
| `↳ utilization_details` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkUtilizationDetails` Output only. \[Output Only\] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. |

### getAllowSubnetCidrRoutesOverlap

Whether this subnetwork's ranges can conflict with existing custom routes.

Setting this to true allows this subnetwork's primary and secondary ranges
to overlap with (and contain) custom routes that have already been
configured on the corresponding network.
For example if a static route has range 10.1.0.0/16, a subnet
range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
Overlapping is only allowed on subnetwork operations; routes
whose ranges conflict with this subnetwork's ranges won't be allowed unless
route.allow_conflicting_subnetworks is set to true.
Typically packets destined to IPs within the subnetwork (which may contain
private/sensitive data) are prevented from leaving the virtual network.
Setting this field to true will disable this feature.
The default value is false and applies to all existing subnetworks and
automatically created subnetworks.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasAllowSubnetCidrRoutesOverlap

### clearAllowSubnetCidrRoutesOverlap

### setAllowSubnetCidrRoutesOverlap

Whether this subnetwork's ranges can conflict with existing custom routes.

Setting this to true allows this subnetwork's primary and secondary ranges
to overlap with (and contain) custom routes that have already been
configured on the corresponding network.
For example if a static route has range 10.1.0.0/16, a subnet
range 10.0.0.0/8 could only be created if allow_conflicting_routes=true.
Overlapping is only allowed on subnetwork operations; routes
whose ranges conflict with this subnetwork's ranges won't be allowed unless
route.allow_conflicting_subnetworks is set to true.
Typically packets destined to IPs within the subnetwork (which may contain
private/sensitive data) are prevented from leaving the virtual network.
Setting this field to true will disable this feature.
The default value is false and applies to all existing subnetworks and
automatically created subnetworks.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreationTimestamp

Output only. \[Output Only\] Creation timestamp inRFC3339
text format.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasCreationTimestamp

### clearCreationTimestamp

### setCreationTimestamp

Output only. \[Output Only\] Creation timestamp inRFC3339
text format.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDescription

An optional description of this resource. Provide this property when you
create the resource. This field can be set only at resource creation time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasDescription

### clearDescription

### setDescription

An optional description of this resource. Provide this property when you
create the resource. This field can be set only at resource creation time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEnableFlowLogs

Whether to enable flow logging for this subnetwork. If this field is not
explicitly set, it will not appear in get listings. If not set
the default behavior is determined by the org policy, if there is no org
policy specified, then it will default to disabled. This field isn't
supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasEnableFlowLogs

### clearEnableFlowLogs

### setEnableFlowLogs

Whether to enable flow logging for this subnetwork. If this field is not
explicitly set, it will not appear in get listings. If not set
the default behavior is determined by the org policy, if there is no org
policy specified, then it will default to disabled. This field isn't
supported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getExternalIpv6Prefix

The external IPv6 address range that is owned by this
subnetwork.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasExternalIpv6Prefix

### clearExternalIpv6Prefix

### setExternalIpv6Prefix

The external IPv6 address range that is owned by this
subnetwork.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFingerprint

Fingerprint of this resource. A hash of the contents stored in this object.

This field is used in optimistic locking. This field will be ignored when
inserting a Subnetwork. An up-to-date fingerprint must be
provided in order to update the Subnetwork, otherwise the
request will fail with error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to
retrieve a Subnetwork.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasFingerprint

### clearFingerprint

### setFingerprint

Fingerprint of this resource. A hash of the contents stored in this object.

This field is used in optimistic locking. This field will be ignored when
inserting a Subnetwork. An up-to-date fingerprint must be
provided in order to update the Subnetwork, otherwise the
request will fail with error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to
retrieve a Subnetwork.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGatewayAddress

Output only. \[Output Only\] The gateway address for default routes to reach destination
addresses outside this subnetwork.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasGatewayAddress

### clearGatewayAddress

### setGatewayAddress

Output only. \[Output Only\] The gateway address for default routes to reach destination
addresses outside this subnetwork.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getId

Output only. \[Output Only\] The unique identifier for the resource. This identifier is
defined by the server.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### hasId

### clearId

### setId

Output only. \[Output Only\] The unique identifier for the resource. This identifier is
defined by the server.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getInternalIpv6Prefix

The internal IPv6 address range that is owned by this
subnetwork.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasInternalIpv6Prefix

### clearInternalIpv6Prefix

### setInternalIpv6Prefix

The internal IPv6 address range that is owned by this
subnetwork.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIpCidrRange

The range of internal addresses that are owned by this subnetwork.

Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
be unique and non-overlapping within a network. Only IPv4 is supported.
This field is set at resource creation time. The range can be any range
listed in theValid
ranges list. The range can be expanded after creation usingexpandIpCidrRange.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasIpCidrRange

### clearIpCidrRange

### setIpCidrRange

The range of internal addresses that are owned by this subnetwork.

Provide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must
be unique and non-overlapping within a network. Only IPv4 is supported.
This field is set at resource creation time. The range can be any range
listed in theValid
ranges list. The range can be expanded after creation usingexpandIpCidrRange.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIpCollection

Reference to the source of IP, like a PublicDelegatedPrefix
(PDP) for BYOIP. The PDP must be a sub-PDP in
EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
mode.

Use one of the following formats to specify a sub-PDP when creating a dual
stack or IPv6-only subnetwork with external access using BYOIP:
-
Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
-
Partial URL, as in

- projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
- regions/region/publicDelegatedPrefixes/sub-pdp-name

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasIpCollection

### clearIpCollection

### setIpCollection

Reference to the source of IP, like a PublicDelegatedPrefix
(PDP) for BYOIP. The PDP must be a sub-PDP in
EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION
mode.

Use one of the following formats to specify a sub-PDP when creating a dual
stack or IPv6-only subnetwork with external access using BYOIP:
-
Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
-
Partial URL, as in

- projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name
- regions/region/publicDelegatedPrefixes/sub-pdp-name

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIpv6AccessType

The access type of IPv6 address this subnet holds. It's immutable and can
only be specified during creation or the first time the subnet is updated
into IPV4_IPV6 dual stack.

Check the Ipv6AccessType enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasIpv6AccessType

### clearIpv6AccessType

### setIpv6AccessType

The access type of IPv6 address this subnet holds. It's immutable and can
only be specified during creation or the first time the subnet is updated
into IPV4_IPV6 dual stack.

Check the Ipv6AccessType enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIpv6CidrRange

Output only. \[Output Only\] This field is for internal use.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasIpv6CidrRange

### clearIpv6CidrRange

### setIpv6CidrRange

Output only. \[Output Only\] This field is for internal use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIpv6GceEndpoint

Output only. \[Output Only\] Possible endpoints of this subnetwork. It can be one of the
following:

- VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb.

<!-- -->

- VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. Check the Ipv6GceEndpoint enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasIpv6GceEndpoint

### clearIpv6GceEndpoint

### setIpv6GceEndpoint

Output only. \[Output Only\] Possible endpoints of this subnetwork. It can be one of the
following:

- VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb.

<!-- -->

- VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly. Check the Ipv6GceEndpoint enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getKind

Output only. \[Output Only\] Type of the resource. Always compute#subnetwork
for Subnetwork resources.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasKind

### clearKind

### setKind

Output only. \[Output Only\] Type of the resource. Always compute#subnetwork
for Subnetwork resources.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLogConfig

This field denotes the VPC flow logging options for this subnetwork.

If logging is enabled, logs are exported to Cloud Logging.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkLogConfig|null` |   |

### hasLogConfig

### clearLogConfig

### setLogConfig

This field denotes the VPC flow logging options for this subnetwork.

If logging is enabled, logs are exported to Cloud Logging.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkLogConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getName

The name of the resource, provided by the client when initially creating
the resource. The name must be 1-63 characters long, and comply withRFC1035.

Specifically, the name must be 1-63 characters long and match the regular
expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
character must be a lowercase letter, and all following characters must
be a dash, lowercase letter, or digit, except the last character, which
cannot be a dash.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasName

### clearName

### setName

The name of the resource, provided by the client when initially creating
the resource. The name must be 1-63 characters long, and comply withRFC1035.

Specifically, the name must be 1-63 characters long and match the regular
expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
character must be a lowercase letter, and all following characters must
be a dash, lowercase letter, or digit, except the last character, which
cannot be a dash.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getNetwork

The URL of the network to which this subnetwork belongs, provided by the
client when initially creating the subnetwork. This field can be set only
at resource creation time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasNetwork

### clearNetwork

### setNetwork

The URL of the network to which this subnetwork belongs, provided by the
client when initially creating the subnetwork. This field can be set only
at resource creation time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParams

Input only. \[Input Only\] Additional params passed with the request, but not persisted
as part of resource payload.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkParams|null` |   |

### hasParams

### clearParams

### setParams

Input only. \[Input Only\] Additional params passed with the request, but not persisted
as part of resource payload.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkParams` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPrivateIpGoogleAccess

Whether the VMs in this subnet can access Google services without assigned
external IP addresses. This field can be both set at resource creation
time and updated using setPrivateIpGoogleAccess.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasPrivateIpGoogleAccess

### clearPrivateIpGoogleAccess

### setPrivateIpGoogleAccess

Whether the VMs in this subnet can access Google services without assigned
external IP addresses. This field can be both set at resource creation
time and updated using setPrivateIpGoogleAccess.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPrivateIpv6GoogleAccess

This field is for internal use.

This field can be both set at resource creation time and updated usingpatch.
Check the PrivateIpv6GoogleAccess enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasPrivateIpv6GoogleAccess

### clearPrivateIpv6GoogleAccess

### setPrivateIpv6GoogleAccess

This field is for internal use.

This field can be both set at resource creation time and updated usingpatch.
Check the PrivateIpv6GoogleAccess enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPurpose

Check the Purpose enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasPurpose

### clearPurpose

### setPurpose

Check the Purpose enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRegion

URL of the region where the Subnetwork resides. This
field can be set only at resource creation time.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasRegion

### clearRegion

### setRegion

URL of the region where the Subnetwork resides. This
field can be set only at resource creation time.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReservedInternalRange

The URL of the reserved internal range.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasReservedInternalRange

### clearReservedInternalRange

### setReservedInternalRange

The URL of the reserved internal range.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getResolveSubnetMask

Configures subnet mask resolution for this subnetwork.

Check the ResolveSubnetMask enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasResolveSubnetMask

### clearResolveSubnetMask

### setResolveSubnetMask

Configures subnet mask resolution for this subnetwork.

Check the ResolveSubnetMask enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRole

The role of subnetwork. Currently, this field is only used when
purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
subnetwork is one that is currently being used for Envoy-based load
balancers in a region. A BACKUP subnetwork is one that is
ready to be promoted to ACTIVE or is currently draining.

This field can be updated with a patch request.
Check the Role enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasRole

### clearRole

### setRole

The role of subnetwork. Currently, this field is only used when
purpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE
subnetwork is one that is currently being used for Envoy-based load
balancers in a region. A BACKUP subnetwork is one that is
ready to be promoted to ACTIVE or is currently draining.

This field can be updated with a patch request.
Check the Role enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSecondaryIpRanges

An array of configurations for secondary IP ranges for VM instances
contained in this subnetwork. The primary IP of such VM must belong to the
primary ipCidrRange of the subnetwork. The alias IPs may belong to either
primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkSecondaryRange>` |   |

### setSecondaryIpRanges

An array of configurations for secondary IP ranges for VM instances
contained in this subnetwork. The primary IP of such VM must belong to the
primary ipCidrRange of the subnetwork. The alias IPs may belong to either
primary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkSecondaryRange>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSelfLink

\[Output Only\] Server-defined URL for the resource.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasSelfLink

### clearSelfLink

### setSelfLink

\[Output Only\] Server-defined URL for the resource.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStackType

The stack type for the subnet. If set to IPV4_ONLY, new VMs
in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
IPv6 addresses. If not specified, IPV4_ONLY is used.

This field can be both set at resource creation time and updated usingpatch.
Check the StackType enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasStackType

### clearStackType

### setStackType

The stack type for the subnet. If set to IPV4_ONLY, new VMs
in the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and
IPv6 addresses. If not specified, IPV4_ONLY is used.

This field can be both set at resource creation time and updated usingpatch.
Check the StackType enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getState

Output only. \[Output Only\] The state of the subnetwork, which can be one of the
following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
connections to the load balancer are being drained. A subnetwork that is
draining cannot be used or modified until it reaches a status ofREADY
Check the State enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasState

### clearState

### setState

Output only. \[Output Only\] The state of the subnetwork, which can be one of the
following values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the
purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that
connections to the load balancer are being drained. A subnetwork that is
draining cannot be used or modified until it reaches a status ofREADY
Check the State enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSystemReservedExternalIpv6Ranges

Output only. \[Output Only\] The array of external IPv6 network ranges reserved from
the subnetwork's external IPv6 range for system use.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setSystemReservedExternalIpv6Ranges

Output only. \[Output Only\] The array of external IPv6 network ranges reserved from
the subnetwork's external IPv6 range for system use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSystemReservedInternalIpv6Ranges

Output only. \[Output Only\] The array of internal IPv6 network ranges reserved from
the subnetwork's internal IPv6 range for system use.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setSystemReservedInternalIpv6Ranges

Output only. \[Output Only\] The array of internal IPv6 network ranges reserved from
the subnetwork's internal IPv6 range for system use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUtilizationDetails

Output only. \[Output Only\] The current IP utilization of all subnetwork ranges. Contains
the total number of allocated and free IPs in each range.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkUtilizationDetails|null` |   |

### hasUtilizationDetails

### clearUtilizationDetails

### setUtilizationDetails

Output only. \[Output Only\] The current IP utilization of all subnetwork ranges. Contains
the total number of allocated and free IPs in each range.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.SubnetworkUtilizationDetails` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |