- 1.62.0 (latest)
- 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 static final class Address.Builder extends GeneratedMessageV3.Builder<Address.Builder> implements AddressOrBuilderRepresents 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.BuilderImplements
AddressOrBuilderStatic 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 | |
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 | StringThe 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 | ByteStringThe 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 | |
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 | |
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. 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. |
clearLabelFingerprint()
public Address.Builder clearLabelFingerprint()A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
Address.Builder | This builder for chaining. |
clearLabels()
public Address.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
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 | |
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 | |
containsLabels(String key)
public boolean containsLabels(String key)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
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. 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. 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. |
getLabelFingerprint()
public String getLabelFingerprint()A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
String | The labelFingerprint. |
getLabelFingerprintBytes()
public ByteString getLabelFingerprintBytes()A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for labelFingerprint. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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 | intThe 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 | intThe 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. 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. |
hasLabelFingerprint()
public boolean hasLabelFingerprint()A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the labelFingerprint 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 | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Address.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Address.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
putAllLabels(Map<String,String> values)
public Address.Builder putAllLabels(Map<String,String> values)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
putLabels(String key, String value)
public Address.Builder putLabels(String key, String value)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
removeLabels(String key)
public Address.Builder removeLabels(String key)Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | |
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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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 | longThe 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. Check the IpVersion enum for the list of possible values.
optional string ip_version = 294959552;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe 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. Check the IpVersion enum for the list of possible values.
optional string ip_version = 294959552;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe bytes for kind to set. |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | This builder for chaining. |
setLabelFingerprint(String value)
public Address.Builder setLabelFingerprint(String value)A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe labelFingerprint to set. |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | This builder for chaining. |
setLabelFingerprintBytes(ByteString value)
public Address.Builder setLabelFingerprintBytes(ByteString value)A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
optional string label_fingerprint = 178124825;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for labelFingerprint 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | intThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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 | intThe index to set the value at. |
value | StringThe users to set. |
| Returns | |
|---|---|
| Type | Description |
Address.Builder | This builder for chaining. |