- 1.58.0 (latest)
- 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 final class Address extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AddressImplements
AddressOrBuilderStatic Fields
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
Type | Description |
int |
ADDRESS_TYPE_FIELD_NUMBER
public static final int ADDRESS_TYPE_FIELD_NUMBER
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Type | Description |
int |
IP_VERSION_FIELD_NUMBER
public static final int IP_VERSION_FIELD_NUMBER
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Type | Description |
int |
NETWORK_TIER_FIELD_NUMBER
public static final int NETWORK_TIER_FIELD_NUMBER
Type | Description |
int |
PREFIX_LENGTH_FIELD_NUMBER
public static final int PREFIX_LENGTH_FIELD_NUMBER
Type | Description |
int |
PURPOSE_FIELD_NUMBER
public static final int PURPOSE_FIELD_NUMBER
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Type | Description |
int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Type | Description |
int |
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER
Type | Description |
int |
USERS_FIELD_NUMBER
public static final int USERS_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Address getDefaultInstance()
Type | Description |
Address |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static Address.Builder newBuilder()
Type | Description |
Address.Builder |
newBuilder(Address prototype)
public static Address.Builder newBuilder(Address prototype)
Name | Description |
prototype | Address |
Type | Description |
Address.Builder |
parseDelimitedFrom(InputStream input)
public static Address parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
Address |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Address parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
IOException |
parseFrom(byte[] data)
public static Address parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Address parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Address parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Address parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Address parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
Address |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Address parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
IOException |
parseFrom(InputStream input)
public static Address parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
Address |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Address parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Address parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Address parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Address |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Address> parser()
Type | Description |
Parser<Address> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getAddress()
public String getAddress()
The static IP address represented by this resource.
optional string address = 462920692;
Type | Description |
String | The address. |
getAddressBytes()
public ByteString getAddressBytes()
The static IP address represented by this resource.
optional string address = 462920692;
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;
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;
Type | Description |
ByteString | The bytes for addressType. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public Address getDefaultInstanceForType()
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;
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;
Type | Description |
ByteString | The bytes for description. |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
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;
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;
Type | Description |
ByteString | The bytes for ipVersion. |
getKind()
public String getKind()
[Output Only] Type of the resource. Always compute#address for addresses.
optional string kind = 3292052;
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#address for addresses.
optional string kind = 3292052;
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;
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;
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;
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;
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;
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;
Type | Description |
ByteString | The bytes for networkTier. |
getParserForType()
public Parser<Address> getParserForType()
Type | Description |
Parser<Address> |
getPrefixLength()
public int getPrefixLength()
The prefix length if the resource represents an IP range.
optional int32 prefix_length = 453565747;
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;
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;
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;
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;
Type | Description |
ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
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;
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;
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;
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;
Type | Description |
ByteString | The bytes for subnetwork. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
getUsers(int index)
public String getUsers(int index)
[Output Only] The URLs of the resources that are using this address.
repeated string users = 111578632;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
Type | Description |
ProtocolStringList | A list containing the users. |
hasAddress()
public boolean hasAddress()
The static IP address represented by this resource.
optional string address = 462920692;
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;
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;
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;
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;
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;
Type | Description |
boolean | Whether the ipVersion field is set. |
hasKind()
public boolean hasKind()
[Output Only] Type of the resource. Always compute#address for addresses.
optional string kind = 3292052;
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;
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;
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;
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;
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;
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;
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;
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;
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;
Type | Description |
boolean | Whether the subnetwork field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public Address.Builder newBuilderForType()
Type | Description |
Address.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Address.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
Address.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public Address.Builder toBuilder()
Type | Description |
Address.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |