Class UsableSubnetwork (1.39.0)

public final class UsableSubnetwork extends GeneratedMessageV3 implements UsableSubnetworkOrBuilder

Subnetwork which the current user has compute.subnetworks.use permission on.

Protobuf type google.cloud.compute.v1.UsableSubnetwork

Static Fields

EXTERNAL_IPV6_PREFIX_FIELD_NUMBER

public static final int EXTERNAL_IPV6_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

INTERNAL_IPV6_PREFIX_FIELD_NUMBER

public static final int INTERNAL_IPV6_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

IPV6_ACCESS_TYPE_FIELD_NUMBER

public static final int IPV6_ACCESS_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

IP_CIDR_RANGE_FIELD_NUMBER

public static final int IP_CIDR_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PURPOSE_FIELD_NUMBER

public static final int PURPOSE_FIELD_NUMBER
Field Value
TypeDescription
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
TypeDescription
int

SECONDARY_IP_RANGES_FIELD_NUMBER

public static final int SECONDARY_IP_RANGES_FIELD_NUMBER
Field Value
TypeDescription
int

STACK_TYPE_FIELD_NUMBER

public static final int STACK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UsableSubnetwork getDefaultInstance()
Returns
TypeDescription
UsableSubnetwork

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UsableSubnetwork.Builder newBuilder()
Returns
TypeDescription
UsableSubnetwork.Builder

newBuilder(UsableSubnetwork prototype)

public static UsableSubnetwork.Builder newBuilder(UsableSubnetwork prototype)
Parameter
NameDescription
prototypeUsableSubnetwork
Returns
TypeDescription
UsableSubnetwork.Builder

parseDelimitedFrom(InputStream input)

public static UsableSubnetwork parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UsableSubnetwork parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UsableSubnetwork parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UsableSubnetwork parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UsableSubnetwork parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UsableSubnetwork parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UsableSubnetwork parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UsableSubnetwork
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UsableSubnetwork> parser()
Returns
TypeDescription
Parser<UsableSubnetwork>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UsableSubnetwork getDefaultInstanceForType()
Returns
TypeDescription
UsableSubnetwork

getExternalIpv6Prefix()

public String getExternalIpv6Prefix()

[Output Only] The external IPv6 address range that is assigned to this subnetwork.

optional string external_ipv6_prefix = 139299190;

Returns
TypeDescription
String

The externalIpv6Prefix.

getExternalIpv6PrefixBytes()

public ByteString getExternalIpv6PrefixBytes()

[Output Only] The external IPv6 address range that is assigned to this subnetwork.

optional string external_ipv6_prefix = 139299190;

Returns
TypeDescription
ByteString

The bytes for externalIpv6Prefix.

getInternalIpv6Prefix()

public String getInternalIpv6Prefix()

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

optional string internal_ipv6_prefix = 506270056;

Returns
TypeDescription
String

The internalIpv6Prefix.

getInternalIpv6PrefixBytes()

public ByteString getInternalIpv6PrefixBytes()

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

optional string internal_ipv6_prefix = 506270056;

Returns
TypeDescription
ByteString

The bytes for internalIpv6Prefix.

getIpCidrRange()

public String getIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
String

The ipCidrRange.

getIpCidrRangeBytes()

public ByteString getIpCidrRangeBytes()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
ByteString

The bytes for ipCidrRange.

getIpv6AccessType()

public String 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.

optional string ipv6_access_type = 504658653;

Returns
TypeDescription
String

The ipv6AccessType.

getIpv6AccessTypeBytes()

public ByteString getIpv6AccessTypeBytes()

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.

optional string ipv6_access_type = 504658653;

Returns
TypeDescription
ByteString

The bytes for ipv6AccessType.

getNetwork()

public String getNetwork()

Network URL.

optional string network = 232872494;

Returns
TypeDescription
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Network URL.

optional string network = 232872494;

Returns
TypeDescription
ByteString

The bytes for network.

getParserForType()

public Parser<UsableSubnetwork> getParserForType()
Returns
TypeDescription
Parser<UsableSubnetwork>
Overrides

getPurpose()

public String getPurpose()

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
TypeDescription
String

The purpose.

getPurposeBytes()

public ByteString getPurposeBytes()

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
TypeDescription
ByteString

The bytes for purpose.

getRole()

public String getRole()

The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE 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.

optional string role = 3506294;

Returns
TypeDescription
String

The role.

getRoleBytes()

public ByteString getRoleBytes()

The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE 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.

optional string role = 3506294;

Returns
TypeDescription
ByteString

The bytes for role.

getSecondaryIpRanges(int index)

public UsableSubnetworkSecondaryRange getSecondaryIpRanges(int index)

Secondary IP ranges.

repeated .google.cloud.compute.v1.UsableSubnetworkSecondaryRange secondary_ip_ranges = 136658915;

Parameter
NameDescription
indexint
Returns
TypeDescription
UsableSubnetworkSecondaryRange

getSecondaryIpRangesCount()

public int getSecondaryIpRangesCount()

Secondary IP ranges.

repeated .google.cloud.compute.v1.UsableSubnetworkSecondaryRange secondary_ip_ranges = 136658915;

Returns
TypeDescription
int

getSecondaryIpRangesList()

public List<UsableSubnetworkSecondaryRange> getSecondaryIpRangesList()

Secondary IP ranges.

repeated .google.cloud.compute.v1.UsableSubnetworkSecondaryRange secondary_ip_ranges = 136658915;

Returns
TypeDescription
List<UsableSubnetworkSecondaryRange>

getSecondaryIpRangesOrBuilder(int index)

public UsableSubnetworkSecondaryRangeOrBuilder getSecondaryIpRangesOrBuilder(int index)

Secondary IP ranges.

repeated .google.cloud.compute.v1.UsableSubnetworkSecondaryRange secondary_ip_ranges = 136658915;

Parameter
NameDescription
indexint
Returns
TypeDescription
UsableSubnetworkSecondaryRangeOrBuilder

getSecondaryIpRangesOrBuilderList()

public List<? extends UsableSubnetworkSecondaryRangeOrBuilder> getSecondaryIpRangesOrBuilderList()

Secondary IP ranges.

repeated .google.cloud.compute.v1.UsableSubnetworkSecondaryRange secondary_ip_ranges = 136658915;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.UsableSubnetworkSecondaryRangeOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStackType()

public String 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.

optional string stack_type = 425908881;

Returns
TypeDescription
String

The stackType.

getStackTypeBytes()

public ByteString getStackTypeBytes()

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.

optional string stack_type = 425908881;

Returns
TypeDescription
ByteString

The bytes for stackType.

getSubnetwork()

public String getSubnetwork()

Subnetwork URL.

optional string subnetwork = 307827694;

Returns
TypeDescription
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

Subnetwork URL.

optional string subnetwork = 307827694;

Returns
TypeDescription
ByteString

The bytes for subnetwork.

hasExternalIpv6Prefix()

public boolean hasExternalIpv6Prefix()

[Output Only] The external IPv6 address range that is assigned to this subnetwork.

optional string external_ipv6_prefix = 139299190;

Returns
TypeDescription
boolean

Whether the externalIpv6Prefix field is set.

hasInternalIpv6Prefix()

public boolean hasInternalIpv6Prefix()

[Output Only] The internal IPv6 address range that is assigned to this subnetwork.

optional string internal_ipv6_prefix = 506270056;

Returns
TypeDescription
boolean

Whether the internalIpv6Prefix field is set.

hasIpCidrRange()

public boolean hasIpCidrRange()

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

optional string ip_cidr_range = 98117322;

Returns
TypeDescription
boolean

Whether the ipCidrRange field is set.

hasIpv6AccessType()

public boolean hasIpv6AccessType()

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.

optional string ipv6_access_type = 504658653;

Returns
TypeDescription
boolean

Whether the ipv6AccessType field is set.

hasNetwork()

public boolean hasNetwork()

Network URL.

optional string network = 232872494;

Returns
TypeDescription
boolean

Whether the network field is set.

hasPurpose()

public boolean hasPurpose()

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
TypeDescription
boolean

Whether the purpose field is set.

hasRole()

public boolean hasRole()

The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE 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.

optional string role = 3506294;

Returns
TypeDescription
boolean

Whether the role field is set.

hasStackType()

public boolean hasStackType()

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.

optional string stack_type = 425908881;

Returns
TypeDescription
boolean

Whether the stackType field is set.

hasSubnetwork()

public boolean hasSubnetwork()

Subnetwork URL.

optional string subnetwork = 307827694;

Returns
TypeDescription
boolean

Whether the subnetwork field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UsableSubnetwork.Builder newBuilderForType()
Returns
TypeDescription
UsableSubnetwork.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UsableSubnetwork.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UsableSubnetwork.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UsableSubnetwork.Builder toBuilder()
Returns
TypeDescription
UsableSubnetwork.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException