com.google.cloud.compute.v1

Interface AddressOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Address, Address.Builder

public interface AddressOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAddress() The static IP address represented by this resource.
com.google.protobuf.ByteString	getAddressBytes() The static IP address represented by this resource.
String	getAddressType() The type of address to reserve, either INTERNAL or EXTERNAL.
com.google.protobuf.ByteString	getAddressTypeBytes() The type of address to reserve, either INTERNAL or EXTERNAL.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
com.google.protobuf.ByteString	getCreationTimestampBytes() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
com.google.protobuf.ByteString	getDescriptionBytes() An optional description of this resource.
long	getId() [Output Only] The unique identifier for the resource.
String	getIpv6EndpointType() The endpoint type of this address, which should be VM or NETLB.
com.google.protobuf.ByteString	getIpv6EndpointTypeBytes() The endpoint type of this address, which should be VM or NETLB.
String	getIpVersion() The IP version that will be used by this address.
com.google.protobuf.ByteString	getIpVersionBytes() The IP version that will be used by this address.
String	getKind() [Output Only] Type of the resource.
com.google.protobuf.ByteString	getKindBytes() [Output Only] Type of the resource.
String	getName() Name of the resource.
com.google.protobuf.ByteString	getNameBytes() Name of the resource.
String	getNetwork() The URL of the network in which to reserve the address.
com.google.protobuf.ByteString	getNetworkBytes() The URL of the network in which to reserve the address.
String	getNetworkTier() This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
com.google.protobuf.ByteString	getNetworkTierBytes() This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
int	getPrefixLength() The prefix length if the resource represents an IP range.
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.
com.google.protobuf.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.
String	getRegion() [Output Only] The URL of the region where a regional address resides.
com.google.protobuf.ByteString	getRegionBytes() [Output Only] The URL of the region where a regional address resides.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
com.google.protobuf.ByteString	getSelfLinkBytes() [Output Only] Server-defined URL for the resource.
String	getStatus() [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
com.google.protobuf.ByteString	getStatusBytes() [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
String	getSubnetwork() The URL of the subnetwork in which to reserve the address.
com.google.protobuf.ByteString	getSubnetworkBytes() The URL of the subnetwork in which to reserve the address.
String	getUsers(int index) [Output Only] The URLs of the resources that are using this address.
com.google.protobuf.ByteString	getUsersBytes(int index) [Output Only] The URLs of the resources that are using this address.
int	getUsersCount() [Output Only] The URLs of the resources that are using this address.
List<String>	getUsersList() [Output Only] The URLs of the resources that are using this address.
boolean	hasAddress() The static IP address represented by this resource.
boolean	hasAddressType() The type of address to reserve, either INTERNAL or EXTERNAL.
boolean	hasCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
boolean	hasDescription() An optional description of this resource.
boolean	hasId() [Output Only] The unique identifier for the resource.
boolean	hasIpv6EndpointType() The endpoint type of this address, which should be VM or NETLB.
boolean	hasIpVersion() The IP version that will be used by this address.
boolean	hasKind() [Output Only] Type of the resource.
boolean	hasName() Name of the resource.
boolean	hasNetwork() The URL of the network in which to reserve the address.
boolean	hasNetworkTier() This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
boolean	hasPrefixLength() The prefix length if the resource represents an IP range.
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.
boolean	hasRegion() [Output Only] The URL of the region where a regional address resides.
boolean	hasSelfLink() [Output Only] Server-defined URL for the resource.
boolean	hasStatus() [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
boolean	hasSubnetwork() The URL of the subnetwork in which to reserve the address.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAddress

boolean hasAddress()

 The static IP address represented by this resource.
 

optional string address = 462920692;

Returns:

Whether the address field is set.

getAddress

String getAddress()

 The static IP address represented by this resource.
 

optional string address = 462920692;

Returns:

The address.

getAddressBytes

com.google.protobuf.ByteString getAddressBytes()

 The static IP address represented by this resource.
 

optional string address = 462920692;

Returns:

The bytes for address.

hasAddressType

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:

Whether the addressType field is set.

getAddressType

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:

The addressType.

getAddressTypeBytes

com.google.protobuf.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:

The bytes for addressType.

hasCreationTimestamp

boolean hasCreationTimestamp()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

Whether the creationTimestamp field is set.

getCreationTimestamp

String getCreationTimestamp()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

The creationTimestamp.

getCreationTimestampBytes

com.google.protobuf.ByteString getCreationTimestampBytes()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

The bytes for creationTimestamp.

hasDescription

boolean hasDescription()

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

optional string description = 422937596;

Returns:

Whether the description field is set.

getDescription

String getDescription()

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

optional string description = 422937596;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns:

The bytes for description.

hasId

boolean hasId()

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

optional uint64 id = 3355;

Returns:

Whether the id field is set.

getId

long getId()

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

optional uint64 id = 3355;

Returns:

The id.

hasIpVersion

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:

Whether the ipVersion field is set.

getIpVersion

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:

The ipVersion.

getIpVersionBytes

com.google.protobuf.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:

The bytes for ipVersion.

hasIpv6EndpointType

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:

Whether the ipv6EndpointType field is set.

getIpv6EndpointType

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:

The ipv6EndpointType.

getIpv6EndpointTypeBytes

com.google.protobuf.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:

The bytes for ipv6EndpointType.

hasKind

boolean hasKind()

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

optional string kind = 3292052;

Returns:

Whether the kind field is set.

getKind

String getKind()

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

optional string kind = 3292052;

Returns:

The kind.

getKindBytes

com.google.protobuf.ByteString getKindBytes()

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

optional string kind = 3292052;

Returns:

The bytes for kind.

hasName

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]([-a-z0-9]*[a-z0-9])?`. 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:

Whether the name field is set.

getName

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]([-a-z0-9]*[a-z0-9])?`. 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:

The name.

getNameBytes

com.google.protobuf.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]([-a-z0-9]*[a-z0-9])?`. 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:

The bytes for name.

hasNetwork

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:

Whether the network field is set.

getNetwork

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:

The network.

getNetworkBytes

com.google.protobuf.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:

The bytes for network.

hasNetworkTier

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:

Whether the networkTier field is set.

getNetworkTier

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:

The networkTier.

getNetworkTierBytes

com.google.protobuf.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:

The bytes for networkTier.

hasPrefixLength

boolean hasPrefixLength()

 The prefix length if the resource represents an IP range.
 

optional int32 prefix_length = 453565747;

Returns:

Whether the prefixLength field is set.

getPrefixLength

int getPrefixLength()

 The prefix length if the resource represents an IP range.
 

optional int32 prefix_length = 453565747;

Returns:

The prefixLength.

hasPurpose

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:

Whether the purpose field is set.

getPurpose

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:

The purpose.

getPurposeBytes

com.google.protobuf.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:

The bytes for purpose.

hasRegion

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:

Whether the region field is set.

getRegion

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:

The region.

getRegionBytes

com.google.protobuf.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:

The bytes for region.

hasSelfLink

boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns:

Whether the selfLink field is set.

getSelfLink

String getSelfLink()

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

optional string self_link = 456214797;

Returns:

The selfLink.

getSelfLinkBytes

com.google.protobuf.ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns:

The bytes for selfLink.

hasStatus

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:

Whether the status field is set.

getStatus

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:

The status.

getStatusBytes

com.google.protobuf.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:

The bytes for status.

hasSubnetwork

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:

Whether the subnetwork field is set.

getSubnetwork

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:

The subnetwork.

getSubnetworkBytes

com.google.protobuf.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:

The bytes for subnetwork.

getUsersList

List<String> getUsersList()

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

repeated string users = 111578632;

Returns:

A list containing the users.

getUsersCount

int getUsersCount()

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

repeated string users = 111578632;

Returns:

The count of users.

getUsers

String getUsers(int index)

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

repeated string users = 111578632;

Parameters:

index - The index of the element to return.

Returns:

The users at the given index.

getUsersBytes

com.google.protobuf.ByteString getUsersBytes(int index)

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

repeated string users = 111578632;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the users at the given index.