Class Address.Builder (1.30.0)

Version 1.30.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public static final class Address.Builder extends GeneratedMessageV3.Builder<Address.Builder> implements AddressOrBuilder

Represents an IP Address resource. Google Compute Engine has two IP Address resources: * Global (external and internal) * Regional (external and internal) For more information, see Reserving a static external IP address.

Protobuf type google.cloud.compute.v1.Address

Inheritance

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

Implements

AddressOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllUsers(Iterable<String> values)

public Address.Builder addAllUsers(Iterable<String> values)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameter
Name	Description
values	Iterable<String> The users to add.

Returns
Type	Description
Address.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Address.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addUsers(String value)

public Address.Builder addUsers(String value)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameter
Name	Description
value	String The users to add.

Returns
Type	Description
Address.Builder	This builder for chaining.

addUsersBytes(ByteString value)

public Address.Builder addUsersBytes(ByteString value)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameter
Name	Description
value	ByteString The bytes of the users to add.

Returns
Type	Description
Address.Builder	This builder for chaining.

build()

public Address build()

Returns
Type	Description
Address

buildPartial()

public Address buildPartial()

Returns
Type	Description
Address

clear()

public Address.Builder clear()

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAddress()

public Address.Builder clearAddress()

The static IP address represented by this resource.

optional string address = 462920692;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearAddressType()

public Address.Builder clearAddressType()

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearCreationTimestamp()

public Address.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearDescription()

public Address.Builder clearDescription()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Address.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public Address.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearIpVersion()

public Address.Builder clearIpVersion()

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearIpv6EndpointType()

public Address.Builder clearIpv6EndpointType()

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearKind()

public Address.Builder clearKind()

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearName()

public Address.Builder clearName()

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearNetwork()

public Address.Builder clearNetwork()

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearNetworkTier()

public Address.Builder clearNetworkTier()

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Address.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPrefixLength()

public Address.Builder clearPrefixLength()

The prefix length if the resource represents an IP range.

optional int32 prefix_length = 453565747;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearPurpose()

public Address.Builder clearPurpose()

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. Check the Purpose enum for the list of possible values.

optional string purpose = 316407070;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearRegion()

public Address.Builder clearRegion()

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearSelfLink()

public Address.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearStatus()

public Address.Builder clearStatus()

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearSubnetwork()

public Address.Builder clearSubnetwork()

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Returns
Type	Description
Address.Builder	This builder for chaining.

clearUsers()

public Address.Builder clearUsers()

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Returns
Type	Description
Address.Builder	This builder for chaining.

clone()

public Address.Builder clone()

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAddress()

public String getAddress()

The static IP address represented by this resource.

optional string address = 462920692;

Returns
Type	Description
String	The address.

getAddressBytes()

public ByteString getAddressBytes()

The static IP address represented by this resource.

optional string address = 462920692;

Returns
Type	Description
ByteString	The bytes for address.

getAddressType()

public String getAddressType()

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Returns
Type	Description
String	The addressType.

getAddressTypeBytes()

public ByteString getAddressTypeBytes()

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Returns
Type	Description
ByteString	The bytes for addressType.

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 Address getDefaultInstanceForType()

Returns
Type	Description
Address

getDescription()

public String getDescription()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getIpVersion()

public String getIpVersion()

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
String	The ipVersion.

getIpVersionBytes()

public ByteString getIpVersionBytes()

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
ByteString	The bytes for ipVersion.

getIpv6EndpointType()

public String getIpv6EndpointType()

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Returns
Type	Description
String	The ipv6EndpointType.

getIpv6EndpointTypeBytes()

public ByteString getIpv6EndpointTypeBytes()

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Returns
Type	Description
ByteString	The bytes for ipv6EndpointType.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

public String getNetwork()

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Returns
Type	Description
String	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Returns
Type	Description
ByteString	The bytes for network.

getNetworkTier()

public String getNetworkTier()

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
String	The networkTier.

getNetworkTierBytes()

public ByteString getNetworkTierBytes()

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
ByteString	The bytes for networkTier.

getPrefixLength()

public int getPrefixLength()

The prefix length if the resource represents an IP range.

optional int32 prefix_length = 453565747;

Returns
Type	Description
int	The prefixLength.

getPurpose()

public String getPurpose()

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. 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 this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. 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()

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Returns
Type	Description
String	The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Returns
Type	Description
ByteString	The bytes for region.

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.

getStatus()

public String getStatus()

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type	Description
String	The status.

getStatusBytes()

public ByteString getStatusBytes()

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type	Description
ByteString	The bytes for status.

getSubnetwork()

public String getSubnetwork()

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Returns
Type	Description
String	The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Returns
Type	Description
ByteString	The bytes for subnetwork.

getUsers(int index)

public String getUsers(int index)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The users at the given index.

getUsersBytes(int index)

public ByteString getUsersBytes(int index)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the users at the given index.

getUsersCount()

public int getUsersCount()

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Returns
Type	Description
int	The count of users.

getUsersList()

public ProtocolStringList getUsersList()

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Returns
Type	Description
ProtocolStringList	A list containing the users.

hasAddress()

public boolean hasAddress()

The static IP address represented by this resource.

optional string address = 462920692;

Returns
Type	Description
boolean	Whether the address field is set.

hasAddressType()

public boolean hasAddressType()

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Returns
Type	Description
boolean	Whether the addressType field is set.

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 field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
boolean	Whether the description 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.

hasIpVersion()

public boolean hasIpVersion()

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
boolean	Whether the ipVersion field is set.

hasIpv6EndpointType()

public boolean hasIpv6EndpointType()

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Returns
Type	Description
boolean	Whether the ipv6EndpointType field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasName()

public boolean hasName()

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
Type	Description
boolean	Whether the name field is set.

hasNetwork()

public boolean hasNetwork()

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Returns
Type	Description
boolean	Whether the network field is set.

hasNetworkTier()

public boolean hasNetworkTier()

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
boolean	Whether the networkTier field is set.

hasPrefixLength()

public boolean hasPrefixLength()

The prefix length if the resource represents an IP range.

optional int32 prefix_length = 453565747;

Returns
Type	Description
boolean	Whether the prefixLength field is set.

hasPurpose()

public boolean hasPurpose()

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. 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()

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Returns
Type	Description
boolean	Whether the region 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.

hasStatus()

public boolean hasStatus()

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type	Description
boolean	Whether the status field is set.

hasSubnetwork()

public boolean hasSubnetwork()

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Returns
Type	Description
boolean	Whether the subnetwork field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Address other)

public Address.Builder mergeFrom(Address other)

Parameter
Name	Description
other	Address

Returns
Type	Description
Address.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Address.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Address.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Address.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Address.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Address.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAddress(String value)

public Address.Builder setAddress(String value)

The static IP address represented by this resource.

optional string address = 462920692;

Parameter
Name	Description
value	String The address to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setAddressBytes(ByteString value)

public Address.Builder setAddressBytes(ByteString value)

The static IP address represented by this resource.

optional string address = 462920692;

Parameter
Name	Description
value	ByteString The bytes for address to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setAddressType(String value)

public Address.Builder setAddressType(String value)

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Parameter
Name	Description
value	String The addressType to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setAddressTypeBytes(ByteString value)

public Address.Builder setAddressTypeBytes(ByteString value)

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

optional string address_type = 264307877;

Parameter
Name	Description
value	ByteString The bytes for addressType to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setCreationTimestamp(String value)

public Address.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
Address.Builder	This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Address.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
Address.Builder	This builder for chaining.

setDescription(String value)

public Address.Builder setDescription(String value)

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Address.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Address.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(long value)

public Address.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
Address.Builder	This builder for chaining.

setIpVersion(String value)

public Address.Builder setIpVersion(String value)

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Parameter
Name	Description
value	String The ipVersion to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setIpVersionBytes(ByteString value)

public Address.Builder setIpVersionBytes(ByteString value)

The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Parameter
Name	Description
value	ByteString The bytes for ipVersion to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setIpv6EndpointType(String value)

public Address.Builder setIpv6EndpointType(String value)

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Parameter
Name	Description
value	String The ipv6EndpointType to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setIpv6EndpointTypeBytes(ByteString value)

public Address.Builder setIpv6EndpointTypeBytes(ByteString value)

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Check the Ipv6EndpointType enum for the list of possible values.

optional string ipv6_endpoint_type = 97501004;

Parameter
Name	Description
value	ByteString The bytes for ipv6EndpointType to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setKind(String value)

public Address.Builder setKind(String value)

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Parameter
Name	Description
value	String The kind to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setKindBytes(ByteString value)

public Address.Builder setKindBytes(ByteString value)

[Output Only] Type of the resource. Always compute#address for addresses.

optional string kind = 3292052;

Parameter
Name	Description
value	ByteString The bytes for kind to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setName(String value)

public Address.Builder setName(String value)

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Address.Builder setNameBytes(ByteString value)

Name of the resource. Provided by the client when the resource is created. 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setNetwork(String value)

public Address.Builder setNetwork(String value)

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Parameter
Name	Description
value	String The network to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setNetworkBytes(ByteString value)

public Address.Builder setNetworkBytes(ByteString value)

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

optional string network = 232872494;

Parameter
Name	Description
value	ByteString The bytes for network to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setNetworkTier(String value)

public Address.Builder setNetworkTier(String value)

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Parameter
Name	Description
value	String The networkTier to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setNetworkTierBytes(ByteString value)

public Address.Builder setNetworkTierBytes(ByteString value)

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Parameter
Name	Description
value	ByteString The bytes for networkTier to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setPrefixLength(int value)

public Address.Builder setPrefixLength(int value)

The prefix length if the resource represents an IP range.

optional int32 prefix_length = 453565747;

Parameter
Name	Description
value	int The prefixLength to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setPurpose(String value)

public Address.Builder setPurpose(String value)

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. 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
Address.Builder	This builder for chaining.

setPurposeBytes(ByteString value)

public Address.Builder setPurposeBytes(ByteString value)

The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. 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
Address.Builder	This builder for chaining.

setRegion(String value)

public Address.Builder setRegion(String value)

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Parameter
Name	Description
value	String The region to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setRegionBytes(ByteString value)

public Address.Builder setRegionBytes(ByteString value)

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

optional string region = 138946292;

Parameter
Name	Description
value	ByteString The bytes for region to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSelfLink(String value)

public Address.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
Address.Builder	This builder for chaining.

setSelfLinkBytes(ByteString value)

public Address.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
Address.Builder	This builder for chaining.

setStatus(String value)

public Address.Builder setStatus(String value)

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
Name	Description
value	String The status to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setStatusBytes(ByteString value)

public Address.Builder setStatusBytes(ByteString value)

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
Name	Description
value	ByteString The bytes for status to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setSubnetwork(String value)

public Address.Builder setSubnetwork(String value)

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Parameter
Name	Description
value	String The subnetwork to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setSubnetworkBytes(ByteString value)

public Address.Builder setSubnetworkBytes(ByteString value)

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

optional string subnetwork = 307827694;

Parameter
Name	Description
value	ByteString The bytes for subnetwork to set.

Returns
Type	Description
Address.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Address.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Address.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUsers(int index, String value)

public Address.Builder setUsers(int index, String value)

[Output Only] The URLs of the resources that are using this address.

repeated string users = 111578632;

Parameters
Name	Description
index	int The index to set the value at.
value	String The users to set.

Returns
Type	Description
Address.Builder	This builder for chaining.