Interface AddressOrBuilder (1.18.0)

Version 1.18.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 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 interface AddressOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAddress()

public abstract String getAddress()

The static IP address represented by this resource.

optional string address = 462920692;

Returns

Type	Description
String	The address.

getAddressBytes()

public abstract ByteString getAddressBytes()

The static IP address represented by this resource.

optional string address = 462920692;

Returns

Type	Description
ByteString	The bytes for address.

getAddressType()

public abstract 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 abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
ByteString	The bytes for creationTimestamp.

getDescription()

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

getId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns

Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getUsersList()

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

repeated string users = 111578632;

Returns

Type	Description
List<String>	A list containing the users.

hasAddress()

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