Reference documentation and code samples for the Compute V1 Client class UsableSubnetwork.
Subnetwork which the current user has compute.subnetworks.use permission on.
Generated from protobuf message google.cloud.compute.v1.UsableSubnetwork
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ external_ipv6_prefix |
string
[Output Only] The external IPv6 address range that is assigned to this subnetwork. |
↳ internal_ipv6_prefix |
string
[Output Only] The internal IPv6 address range that is assigned to this subnetwork. |
↳ ip_cidr_range |
string
The range of internal addresses that are owned by this subnetwork. |
↳ 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. |
↳ network |
string
Network URL. |
↳ purpose |
string
The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER. Check the Purpose enum for the list of possible values. |
↳ role |
string
The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. 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<Google\Cloud\Compute\V1\UsableSubnetworkSecondaryRange>
Secondary IP ranges. |
↳ 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 to IPV4_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 using patch. Check the StackType enum for the list of possible values. |
↳ subnetwork |
string
Subnetwork URL. |
getExternalIpv6Prefix
[Output Only] The external IPv6 address range that is assigned to this subnetwork.
| Returns | |
|---|---|
| Type | Description |
string | |
hasExternalIpv6Prefix
clearExternalIpv6Prefix
setExternalIpv6Prefix
[Output Only] The external IPv6 address range that is assigned to this subnetwork.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInternalIpv6Prefix
[Output Only] The internal IPv6 address range that is assigned to this subnetwork.
| Returns | |
|---|---|
| Type | Description |
string | |
hasInternalIpv6Prefix
clearInternalIpv6Prefix
setInternalIpv6Prefix
[Output Only] The internal IPv6 address range that is assigned to this subnetwork.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpCidrRange
The range of internal addresses that are owned by this subnetwork.
| Returns | |
|---|---|
| Type | Description |
string | |
hasIpCidrRange
clearIpCidrRange
setIpCidrRange
The range of internal addresses that are owned by this subnetwork.
| 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 | |
getNetwork
Network URL.
| Returns | |
|---|---|
| Type | Description |
string | |
hasNetwork
clearNetwork
setNetwork
Network URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPurpose
The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.
Check the Purpose enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasPurpose
clearPurpose
setPurpose
The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.
Check the Purpose 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 = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. 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 = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. 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
Secondary IP ranges.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSecondaryIpRanges
Secondary IP ranges.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\UsableSubnetworkSecondaryRange>
|
| 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 to IPV4_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 using patch.
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 to IPV4_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 using patch.
Check the StackType enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubnetwork
Subnetwork URL.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSubnetwork
clearSubnetwork
setSubnetwork
Subnetwork URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |