com.google.api.services.compute.model.Address Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.compute.model;
/**
* Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global
* (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses)
* * [Regional (external and
* internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) For more
* information, see Reserving a static external IP address.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class Address extends com.google.api.client.json.GenericJson {
/**
* The static IP address represented by this resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String address;
/**
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to
* EXTERNAL.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String addressType;
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String creationTimestamp;
/**
* An optional description of this resource. Provide this field when you create the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.math.BigInteger id;
/**
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String ipVersion;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String ipv6EndpointType;
/**
* [Output Only] Type of the resource. Always compute#address for addresses.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String labelFingerprint;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map labels;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String network;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String networkTier;
/**
* The prefix length if the resource represents an IP range.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer prefixLength;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String purpose;
/**
* [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.*
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String region;
/**
* [Output Only] Server-defined URL for the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String selfLink;
/**
* [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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String status;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String subnetwork;
/**
* [Output Only] The URLs of the resources that are using this address.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List users;
/**
* The static IP address represented by this resource.
* @return value or {@code null} for none
*/
public java.lang.String getAddress() {
return address;
}
/**
* The static IP address represented by this resource.
* @param address address or {@code null} for none
*/
public Address setAddress(java.lang.String address) {
this.address = address;
return this;
}
/**
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to
* EXTERNAL.
* @return value or {@code null} for none
*/
public java.lang.String getAddressType() {
return addressType;
}
/**
* The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to
* EXTERNAL.
* @param addressType addressType or {@code null} for none
*/
public Address setAddressType(java.lang.String addressType) {
this.addressType = addressType;
return this;
}
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* @return value or {@code null} for none
*/
public java.lang.String getCreationTimestamp() {
return creationTimestamp;
}
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* @param creationTimestamp creationTimestamp or {@code null} for none
*/
public Address setCreationTimestamp(java.lang.String creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
/**
* An optional description of this resource. Provide this field when you create the resource.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* An optional description of this resource. Provide this field when you create the resource.
* @param description description or {@code null} for none
*/
public Address setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* @return value or {@code null} for none
*/
public java.math.BigInteger getId() {
return id;
}
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* @param id id or {@code null} for none
*/
public Address setId(java.math.BigInteger id) {
this.id = id;
return this;
}
/**
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* @return value or {@code null} for none
*/
public java.lang.String getIpVersion() {
return ipVersion;
}
/**
* The IP version that will be used by this address. Valid options are IPV4 or IPV6.
* @param ipVersion ipVersion or {@code null} for none
*/
public Address setIpVersion(java.lang.String ipVersion) {
this.ipVersion = ipVersion;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getIpv6EndpointType() {
return ipv6EndpointType;
}
/**
* 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.
* @param ipv6EndpointType ipv6EndpointType or {@code null} for none
*/
public Address setIpv6EndpointType(java.lang.String ipv6EndpointType) {
this.ipv6EndpointType = ipv6EndpointType;
return this;
}
/**
* [Output Only] Type of the resource. Always compute#address for addresses.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* [Output Only] Type of the resource. Always compute#address for addresses.
* @param kind kind or {@code null} for none
*/
public Address setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* 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.
* @see #decodeLabelFingerprint()
* @return value or {@code null} for none
*/
public java.lang.String getLabelFingerprint() {
return labelFingerprint;
}
/**
* 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.
* @see #getLabelFingerprint()
* @return Base64 decoded value or {@code null} for none
*
* @since 1.14
*/
public byte[] decodeLabelFingerprint() {
return com.google.api.client.util.Base64.decodeBase64(labelFingerprint);
}
/**
* 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.
* @see #encodeLabelFingerprint()
* @param labelFingerprint labelFingerprint or {@code null} for none
*/
public Address setLabelFingerprint(java.lang.String labelFingerprint) {
this.labelFingerprint = labelFingerprint;
return this;
}
/**
* 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.
* @see #setLabelFingerprint()
*
*
* The value is encoded Base64 or {@code null} for none.
*
*
* @since 1.14
*/
public Address encodeLabelFingerprint(byte[] labelFingerprint) {
this.labelFingerprint = com.google.api.client.util.Base64.encodeBase64URLSafeString(labelFingerprint);
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.util.Map getLabels() {
return labels;
}
/**
* 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.
* @param labels labels or {@code null} for none
*/
public Address setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* 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.
* @param name name or {@code null} for none
*/
public Address setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getNetwork() {
return network;
}
/**
* 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.
* @param network network or {@code null} for none
*/
public Address setNetwork(java.lang.String network) {
this.network = network;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getNetworkTier() {
return networkTier;
}
/**
* 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.
* @param networkTier networkTier or {@code null} for none
*/
public Address setNetworkTier(java.lang.String networkTier) {
this.networkTier = networkTier;
return this;
}
/**
* The prefix length if the resource represents an IP range.
* @return value or {@code null} for none
*/
public java.lang.Integer getPrefixLength() {
return prefixLength;
}
/**
* The prefix length if the resource represents an IP range.
* @param prefixLength prefixLength or {@code null} for none
*/
public Address setPrefixLength(java.lang.Integer prefixLength) {
this.prefixLength = prefixLength;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getPurpose() {
return purpose;
}
/**
* 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.
* @param purpose purpose or {@code null} for none
*/
public Address setPurpose(java.lang.String purpose) {
this.purpose = purpose;
return this;
}
/**
* [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.*
* @return value or {@code null} for none
*/
public java.lang.String getRegion() {
return region;
}
/**
* [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.*
* @param region region or {@code null} for none
*/
public Address setRegion(java.lang.String region) {
this.region = region;
return this;
}
/**
* [Output Only] Server-defined URL for the resource.
* @return value or {@code null} for none
*/
public java.lang.String getSelfLink() {
return selfLink;
}
/**
* [Output Only] Server-defined URL for the resource.
* @param selfLink selfLink or {@code null} for none
*/
public Address setSelfLink(java.lang.String selfLink) {
this.selfLink = selfLink;
return this;
}
/**
* [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.
* @return value or {@code null} for none
*/
public java.lang.String getStatus() {
return status;
}
/**
* [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.
* @param status status or {@code null} for none
*/
public Address setStatus(java.lang.String status) {
this.status = status;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getSubnetwork() {
return subnetwork;
}
/**
* 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.
* @param subnetwork subnetwork or {@code null} for none
*/
public Address setSubnetwork(java.lang.String subnetwork) {
this.subnetwork = subnetwork;
return this;
}
/**
* [Output Only] The URLs of the resources that are using this address.
* @return value or {@code null} for none
*/
public java.util.List getUsers() {
return users;
}
/**
* [Output Only] The URLs of the resources that are using this address.
* @param users users or {@code null} for none
*/
public Address setUsers(java.util.List users) {
this.users = users;
return this;
}
@Override
public Address set(String fieldName, Object value) {
return (Address) super.set(fieldName, value);
}
@Override
public Address clone() {
return (Address) super.clone();
}
}