Class Subnetwork.Builder (1.63.0) 

public static final class Subnetwork.Builder extends GeneratedMessageV3.Builder<Subnetwork.Builder> implements SubnetworkOrBuilder

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.

Protobuf type google.cloud.compute.v1.Subnetwork

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Subnetwork.Builder

Implements

SubnetworkOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSecondaryIpRanges(Iterable<? extends SubnetworkSecondaryRange> values)

public Subnetwork.Builder addAllSecondaryIpRanges(Iterable<? extends SubnetworkSecondaryRange> values)

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 a patch request.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.SubnetworkSecondaryRange>
Returns
Type Description
Subnetwork.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Subnetwork.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Subnetwork.Builder
Overrides

addSecondaryIpRanges(SubnetworkSecondaryRange value)

public Subnetwork.Builder addSecondaryIpRanges(SubnetworkSecondaryRange value)

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 a patch request.

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

Parameter
Name Description
value SubnetworkSecondaryRange
Returns
Type Description
Subnetwork.Builder

addSecondaryIpRanges(SubnetworkSecondaryRange.Builder builderForValue)

public Subnetwork.Builder addSecondaryIpRanges(SubnetworkSecondaryRange.Builder builderForValue)

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 a patch request.

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

Parameter
Name Description
builderForValue SubnetworkSecondaryRange.Builder
Returns
Type Description
Subnetwork.Builder

addSecondaryIpRanges(int index, SubnetworkSecondaryRange value)

public Subnetwork.Builder addSecondaryIpRanges(int index, SubnetworkSecondaryRange value)

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 a patch request.

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

Parameters
Name Description
index int
value SubnetworkSecondaryRange
Returns
Type Description
Subnetwork.Builder

addSecondaryIpRanges(int index, SubnetworkSecondaryRange.Builder builderForValue)

public Subnetwork.Builder addSecondaryIpRanges(int index, SubnetworkSecondaryRange.Builder builderForValue)

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 a patch request.

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

Parameters
Name Description
index int
builderForValue SubnetworkSecondaryRange.Builder
Returns
Type Description
Subnetwork.Builder

addSecondaryIpRangesBuilder()

public SubnetworkSecondaryRange.Builder addSecondaryIpRangesBuilder()

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 a patch request.

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

Returns
Type Description
SubnetworkSecondaryRange.Builder

addSecondaryIpRangesBuilder(int index)

public SubnetworkSecondaryRange.Builder addSecondaryIpRangesBuilder(int index)

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 a patch request.

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

Parameter
Name Description
index int
Returns
Type Description
SubnetworkSecondaryRange.Builder

build()

public Subnetwork build()
Returns
Type Description
Subnetwork

buildPartial()

public Subnetwork buildPartial()
Returns
Type Description
Subnetwork

clear()

public Subnetwork.Builder clear()
Returns
Type Description
Subnetwork.Builder
Overrides

clearCreationTimestamp()

public Subnetwork.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearDescription()

public Subnetwork.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearEnableFlowLogs()

public Subnetwork.Builder clearEnableFlowLogs()

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 to REGIONAL_MANAGED_PROXY.

optional bool enable_flow_logs = 151544420;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearExternalIpv6Prefix()

public Subnetwork.Builder clearExternalIpv6Prefix()

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

optional string external_ipv6_prefix = 139299190;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Subnetwork.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Subnetwork.Builder
Overrides

clearFingerprint()

public Subnetwork.Builder clearFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearGatewayAddress()

public Subnetwork.Builder clearGatewayAddress()

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

optional string gateway_address = 459867385;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearId()

public Subnetwork.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearInternalIpv6Prefix()

public Subnetwork.Builder clearInternalIpv6Prefix()

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

optional string internal_ipv6_prefix = 506270056;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearIpCidrRange()

public Subnetwork.Builder clearIpCidrRange()

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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearIpv6AccessType()

public Subnetwork.Builder clearIpv6AccessType()

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
Type Description
Subnetwork.Builder

This builder for chaining.

clearIpv6CidrRange()

public Subnetwork.Builder clearIpv6CidrRange()

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearKind()

public Subnetwork.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearLogConfig()

public Subnetwork.Builder clearLogConfig()

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Returns
Type Description
Subnetwork.Builder

clearName()

public Subnetwork.Builder clearName()

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearNetwork()

public Subnetwork.Builder clearNetwork()

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.

optional string network = 232872494;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Subnetwork.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Subnetwork.Builder
Overrides

clearPrivateIpGoogleAccess()

public Subnetwork.Builder clearPrivateIpGoogleAccess()

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.

optional bool private_ip_google_access = 421491790;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearPrivateIpv6GoogleAccess()

public Subnetwork.Builder clearPrivateIpv6GoogleAccess()

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearPurpose()

public Subnetwork.Builder clearPurpose()

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearRegion()

public Subnetwork.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearReservedInternalRange()

public Subnetwork.Builder clearReservedInternalRange()

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearRole()

public Subnetwork.Builder clearRole()

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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
Type Description
Subnetwork.Builder

This builder for chaining.

clearSecondaryIpRanges()

public Subnetwork.Builder clearSecondaryIpRanges()

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 a patch request.

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

Returns
Type Description
Subnetwork.Builder

clearSelfLink()

public Subnetwork.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clearStackType()

public Subnetwork.Builder clearStackType()

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
Type Description
Subnetwork.Builder

This builder for chaining.

clearState()

public Subnetwork.Builder clearState()

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
Subnetwork.Builder

This builder for chaining.

clone()

public Subnetwork.Builder clone()
Returns
Type Description
Subnetwork.Builder
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Subnetwork getDefaultInstanceForType()
Returns
Type Description
Subnetwork

getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableFlowLogs()

public boolean 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 to REGIONAL_MANAGED_PROXY.

optional bool enable_flow_logs = 151544420;

Returns
Type Description
boolean

The enableFlowLogs.

getExternalIpv6Prefix()

public String getExternalIpv6Prefix()

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

optional string external_ipv6_prefix = 139299190;

Returns
Type Description
String

The externalIpv6Prefix.

getExternalIpv6PrefixBytes()

public ByteString getExternalIpv6PrefixBytes()

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

optional string external_ipv6_prefix = 139299190;

Returns
Type Description
ByteString

The bytes for externalIpv6Prefix.

getFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getGatewayAddress()

public String getGatewayAddress()

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

optional string gateway_address = 459867385;

Returns
Type Description
String

The gatewayAddress.

getGatewayAddressBytes()

public ByteString getGatewayAddressBytes()

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

optional string gateway_address = 459867385;

Returns
Type Description
ByteString

The bytes for gatewayAddress.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getInternalIpv6Prefix()

public String getInternalIpv6Prefix()

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

optional string internal_ipv6_prefix = 506270056;

Returns
Type Description
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
Type Description
ByteString

The bytes for internalIpv6Prefix.

getIpCidrRange()

public String 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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Returns
Type Description
String

The ipCidrRange.

getIpCidrRangeBytes()

public ByteString getIpCidrRangeBytes()

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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for ipv6AccessType.

getIpv6CidrRange()

public String getIpv6CidrRange()

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Returns
Type Description
String

The ipv6CidrRange.

getIpv6CidrRangeBytes()

public ByteString getIpv6CidrRangeBytes()

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Returns
Type Description
ByteString

The bytes for ipv6CidrRange.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLogConfig()

public SubnetworkLogConfig getLogConfig()

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Returns
Type Description
SubnetworkLogConfig

The logConfig.

getLogConfigBuilder()

public SubnetworkLogConfig.Builder getLogConfigBuilder()

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Returns
Type Description
SubnetworkLogConfig.Builder

getLogConfigOrBuilder()

public SubnetworkLogConfigOrBuilder getLogConfigOrBuilder()

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Returns
Type Description
SubnetworkLogConfigOrBuilder

getName()

public String 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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

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

optional string network = 232872494;

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

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.

optional string network = 232872494;

Returns
Type Description
ByteString

The bytes for network.

getPrivateIpGoogleAccess()

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

optional bool private_ip_google_access = 421491790;

Returns
Type Description
boolean

The privateIpGoogleAccess.

getPrivateIpv6GoogleAccess()

public String getPrivateIpv6GoogleAccess()

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Returns
Type Description
String

The privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccessBytes()

public ByteString getPrivateIpv6GoogleAccessBytes()

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Returns
Type Description
ByteString

The bytes for privateIpv6GoogleAccess.

getPurpose()

public String getPurpose()

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
Type Description
String

The purpose.

getPurposeBytes()

public ByteString getPurposeBytes()

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
Type Description
ByteString

The bytes for purpose.

getRegion()

public String getRegion()

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

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getReservedInternalRange()

public String getReservedInternalRange()

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Returns
Type Description
String

The reservedInternalRange.

getReservedInternalRangeBytes()

public ByteString getReservedInternalRangeBytes()

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Returns
Type Description
ByteString

The bytes for reservedInternalRange.

getRole()

public String getRole()

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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
Type Description
String

The role.

getRoleBytes()

public ByteString getRoleBytes()

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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
Type Description
ByteString

The bytes for role.

getSecondaryIpRanges(int index)

public SubnetworkSecondaryRange getSecondaryIpRanges(int index)

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 a patch request.

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

Parameter
Name Description
index int
Returns
Type Description
SubnetworkSecondaryRange

getSecondaryIpRangesBuilder(int index)

public SubnetworkSecondaryRange.Builder getSecondaryIpRangesBuilder(int index)

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 a patch request.

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

Parameter
Name Description
index int
Returns
Type Description
SubnetworkSecondaryRange.Builder

getSecondaryIpRangesBuilderList()

public List<SubnetworkSecondaryRange.Builder> getSecondaryIpRangesBuilderList()

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 a patch request.

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

Returns
Type Description
List<Builder>

getSecondaryIpRangesCount()

public int getSecondaryIpRangesCount()

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 a patch request.

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

Returns
Type Description
int

getSecondaryIpRangesList()

public List<SubnetworkSecondaryRange> getSecondaryIpRangesList()

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 a patch request.

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

Returns
Type Description
List<SubnetworkSecondaryRange>

getSecondaryIpRangesOrBuilder(int index)

public SubnetworkSecondaryRangeOrBuilder getSecondaryIpRangesOrBuilder(int index)

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 a patch request.

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

Parameter
Name Description
index int
Returns
Type Description
SubnetworkSecondaryRangeOrBuilder

getSecondaryIpRangesOrBuilderList()

public List<? extends SubnetworkSecondaryRangeOrBuilder> getSecondaryIpRangesOrBuilderList()

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 a patch request.

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

Returns
Type Description
List<? extends com.google.cloud.compute.v1.SubnetworkSecondaryRangeOrBuilder>

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

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
Type Description
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
Type Description
ByteString

The bytes for stackType.

getState()

public String getState()

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasEnableFlowLogs()

public boolean hasEnableFlowLogs()

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 to REGIONAL_MANAGED_PROXY.

optional bool enable_flow_logs = 151544420;

Returns
Type Description
boolean

Whether the enableFlowLogs field is set.

hasExternalIpv6Prefix()

public boolean hasExternalIpv6Prefix()

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

optional string external_ipv6_prefix = 139299190;

Returns
Type Description
boolean

Whether the externalIpv6Prefix field is set.

hasFingerprint()

public boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasGatewayAddress()

public boolean hasGatewayAddress()

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

optional string gateway_address = 459867385;

Returns
Type Description
boolean

Whether the gatewayAddress field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id 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
Type Description
boolean

Whether the internalIpv6Prefix field is set.

hasIpCidrRange()

public boolean hasIpCidrRange()

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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Returns
Type Description
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
Type Description
boolean

Whether the ipv6AccessType field is set.

hasIpv6CidrRange()

public boolean hasIpv6CidrRange()

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Returns
Type Description
boolean

Whether the ipv6CidrRange field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLogConfig()

public boolean hasLogConfig()

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Returns
Type Description
boolean

Whether the logConfig field is set.

hasName()

public boolean hasName()

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasNetwork()

public boolean hasNetwork()

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.

optional string network = 232872494;

Returns
Type Description
boolean

Whether the network field is set.

hasPrivateIpGoogleAccess()

public boolean hasPrivateIpGoogleAccess()

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.

optional bool private_ip_google_access = 421491790;

Returns
Type Description
boolean

Whether the privateIpGoogleAccess field is set.

hasPrivateIpv6GoogleAccess()

public boolean hasPrivateIpv6GoogleAccess()

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Returns
Type Description
boolean

Whether the privateIpv6GoogleAccess field is set.

hasPurpose()

public boolean hasPurpose()

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
Type Description
boolean

Whether the purpose field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasReservedInternalRange()

public boolean hasReservedInternalRange()

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Returns
Type Description
boolean

Whether the reservedInternalRange field is set.

hasRole()

public boolean hasRole()

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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
Type Description
boolean

Whether the role field is set.

hasSelfLink()

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink 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
Type Description
boolean

Whether the stackType field is set.

hasState()

public boolean hasState()

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Returns
Type Description
boolean

Whether the state field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Subnetwork other)

public Subnetwork.Builder mergeFrom(Subnetwork other)
Parameter
Name Description
other Subnetwork
Returns
Type Description
Subnetwork.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Subnetwork.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subnetwork.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Subnetwork.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Subnetwork.Builder
Overrides

mergeLogConfig(SubnetworkLogConfig value)

public Subnetwork.Builder mergeLogConfig(SubnetworkLogConfig value)

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Parameter
Name Description
value SubnetworkLogConfig
Returns
Type Description
Subnetwork.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Subnetwork.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Subnetwork.Builder
Overrides

removeSecondaryIpRanges(int index)

public Subnetwork.Builder removeSecondaryIpRanges(int index)

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 a patch request.

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

Parameter
Name Description
index int
Returns
Type Description
Subnetwork.Builder

setCreationTimestamp(String value)

public Subnetwork.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Subnetwork.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setDescription(String value)

public Subnetwork.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Subnetwork.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setEnableFlowLogs(boolean value)

public Subnetwork.Builder setEnableFlowLogs(boolean value)

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 to REGIONAL_MANAGED_PROXY.

optional bool enable_flow_logs = 151544420;

Parameter
Name Description
value boolean

The enableFlowLogs to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setExternalIpv6Prefix(String value)

public Subnetwork.Builder setExternalIpv6Prefix(String value)

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

optional string external_ipv6_prefix = 139299190;

Parameter
Name Description
value String

The externalIpv6Prefix to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setExternalIpv6PrefixBytes(ByteString value)

public Subnetwork.Builder setExternalIpv6PrefixBytes(ByteString value)

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

optional string external_ipv6_prefix = 139299190;

Parameter
Name Description
value ByteString

The bytes for externalIpv6Prefix to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Subnetwork.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Subnetwork.Builder
Overrides

setFingerprint(String value)

public Subnetwork.Builder setFingerprint(String value)

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.

optional string fingerprint = 234678500;

Parameter
Name Description
value String

The fingerprint to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public Subnetwork.Builder setFingerprintBytes(ByteString value)

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.

optional string fingerprint = 234678500;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setGatewayAddress(String value)

public Subnetwork.Builder setGatewayAddress(String value)

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

optional string gateway_address = 459867385;

Parameter
Name Description
value String

The gatewayAddress to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setGatewayAddressBytes(ByteString value)

public Subnetwork.Builder setGatewayAddressBytes(ByteString value)

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

optional string gateway_address = 459867385;

Parameter
Name Description
value ByteString

The bytes for gatewayAddress to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setId(long value)

public Subnetwork.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setInternalIpv6Prefix(String value)

public Subnetwork.Builder setInternalIpv6Prefix(String value)

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

optional string internal_ipv6_prefix = 506270056;

Parameter
Name Description
value String

The internalIpv6Prefix to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setInternalIpv6PrefixBytes(ByteString value)

public Subnetwork.Builder setInternalIpv6PrefixBytes(ByteString value)

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

optional string internal_ipv6_prefix = 506270056;

Parameter
Name Description
value ByteString

The bytes for internalIpv6Prefix to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpCidrRange(String value)

public Subnetwork.Builder setIpCidrRange(String value)

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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Parameter
Name Description
value String

The ipCidrRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpCidrRangeBytes(ByteString value)

public Subnetwork.Builder setIpCidrRangeBytes(ByteString value)

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 the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

optional string ip_cidr_range = 98117322;

Parameter
Name Description
value ByteString

The bytes for ipCidrRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpv6AccessType(String value)

public Subnetwork.Builder setIpv6AccessType(String value)

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;

Parameter
Name Description
value String

The ipv6AccessType to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpv6AccessTypeBytes(ByteString value)

public Subnetwork.Builder setIpv6AccessTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for ipv6AccessType to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpv6CidrRange(String value)

public Subnetwork.Builder setIpv6CidrRange(String value)

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Parameter
Name Description
value String

The ipv6CidrRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setIpv6CidrRangeBytes(ByteString value)

public Subnetwork.Builder setIpv6CidrRangeBytes(ByteString value)

[Output Only] This field is for internal use.

optional string ipv6_cidr_range = 273141258;

Parameter
Name Description
value ByteString

The bytes for ipv6CidrRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setKind(String value)

public Subnetwork.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Subnetwork.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setLogConfig(SubnetworkLogConfig value)

public Subnetwork.Builder setLogConfig(SubnetworkLogConfig value)

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Parameter
Name Description
value SubnetworkLogConfig
Returns
Type Description
Subnetwork.Builder

setLogConfig(SubnetworkLogConfig.Builder builderForValue)

public Subnetwork.Builder setLogConfig(SubnetworkLogConfig.Builder builderForValue)

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

optional .google.cloud.compute.v1.SubnetworkLogConfig log_config = 351299741;

Parameter
Name Description
builderForValue SubnetworkLogConfig.Builder
Returns
Type Description
Subnetwork.Builder

setName(String value)

public Subnetwork.Builder setName(String value)

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Subnetwork.Builder setNameBytes(ByteString value)

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setNetwork(String value)

public Subnetwork.Builder setNetwork(String value)

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.

optional string network = 232872494;

Parameter
Name Description
value String

The network to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public Subnetwork.Builder setNetworkBytes(ByteString value)

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.

optional string network = 232872494;

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setPrivateIpGoogleAccess(boolean value)

public Subnetwork.Builder setPrivateIpGoogleAccess(boolean value)

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.

optional bool private_ip_google_access = 421491790;

Parameter
Name Description
value boolean

The privateIpGoogleAccess to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setPrivateIpv6GoogleAccess(String value)

public Subnetwork.Builder setPrivateIpv6GoogleAccess(String value)

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Parameter
Name Description
value String

The privateIpv6GoogleAccess to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setPrivateIpv6GoogleAccessBytes(ByteString value)

public Subnetwork.Builder setPrivateIpv6GoogleAccessBytes(ByteString value)

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Parameter
Name Description
value ByteString

The bytes for privateIpv6GoogleAccess to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setPurpose(String value)

public Subnetwork.Builder setPurpose(String value)

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Parameter
Name Description
value String

The purpose to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setPurposeBytes(ByteString value)

public Subnetwork.Builder setPurposeBytes(ByteString value)

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Parameter
Name Description
value ByteString

The bytes for purpose to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setRegion(String value)

public Subnetwork.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public Subnetwork.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Subnetwork.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Subnetwork.Builder
Overrides

setReservedInternalRange(String value)

public Subnetwork.Builder setReservedInternalRange(String value)

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Parameter
Name Description
value String

The reservedInternalRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setReservedInternalRangeBytes(ByteString value)

public Subnetwork.Builder setReservedInternalRangeBytes(ByteString value)

The URL of the reserved internal range.

optional string reserved_internal_range = 286248754;

Parameter
Name Description
value ByteString

The bytes for reservedInternalRange to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setRole(String value)

public Subnetwork.Builder setRole(String value)

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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;

Parameter
Name Description
value String

The role to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setRoleBytes(ByteString value)

public Subnetwork.Builder setRoleBytes(ByteString value)

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or 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;

Parameter
Name Description
value ByteString

The bytes for role to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setSecondaryIpRanges(int index, SubnetworkSecondaryRange value)

public Subnetwork.Builder setSecondaryIpRanges(int index, SubnetworkSecondaryRange value)

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 a patch request.

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

Parameters
Name Description
index int
value SubnetworkSecondaryRange
Returns
Type Description
Subnetwork.Builder

setSecondaryIpRanges(int index, SubnetworkSecondaryRange.Builder builderForValue)

public Subnetwork.Builder setSecondaryIpRanges(int index, SubnetworkSecondaryRange.Builder builderForValue)

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 a patch request.

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

Parameters
Name Description
index int
builderForValue SubnetworkSecondaryRange.Builder
Returns
Type Description
Subnetwork.Builder

setSelfLink(String value)

public Subnetwork.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Subnetwork.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setStackType(String value)

public Subnetwork.Builder setStackType(String value)

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;

Parameter
Name Description
value String

The stackType to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setStackTypeBytes(ByteString value)

public Subnetwork.Builder setStackTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for stackType to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setState(String value)

public Subnetwork.Builder setState(String value)

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Parameter
Name Description
value String

The state to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setStateBytes(ByteString value)

public Subnetwork.Builder setStateBytes(ByteString value)

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 of READY Check the State enum for the list of possible values.

optional string state = 109757585;

Parameter
Name Description
value ByteString

The bytes for state to set.
Returns
Type Description
Subnetwork.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Subnetwork.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Subnetwork.Builder
Overrides