com.google.api.services.compute.model.TargetVpnGateway 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 a Target VPN Gateway resource. The target VPN gateway resource represents a Classic
* Cloud VPN gateway. For more information, read the the Cloud VPN Overview.
*
* 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 TargetVpnGateway extends com.google.api.client.json.GenericJson {
/**
* [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 property when you create the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using
* compute.forwardingRules.insert and associated with a VPN gateway.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List forwardingRules;
/**
* [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;
/**
* [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
* 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 TargetVpnGateway, 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 a TargetVpnGateway.
* 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])?` which means the first
* character must be a lowercase letter, and all following characters must be a dash, lowercase
* letter, or digit, except the last character, which cannot be a dash.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* URL of the network to which this VPN gateway is attached. Provided by the client when the VPN
* gateway is created.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String network;
/**
* [Output Only] URL of the region where the target VPN gateway resides. You must specify this
* field as part of the HTTP request URL. It is not settable as a field in the request body.
* 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 VPN gateway, which can be one of the following: CREATING,
* READY, FAILED, or DELETING.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String status;
/**
* [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the
* compute.vpntunnels.insert method and associated with a VPN gateway.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List tunnels;
/**
* [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 TargetVpnGateway setCreationTimestamp(java.lang.String creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
/**
* An optional description of this resource. Provide this property 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 property when you create the resource.
* @param description description or {@code null} for none
*/
public TargetVpnGateway setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using
* compute.forwardingRules.insert and associated with a VPN gateway.
* @return value or {@code null} for none
*/
public java.util.List getForwardingRules() {
return forwardingRules;
}
/**
* [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using
* compute.forwardingRules.insert and associated with a VPN gateway.
* @param forwardingRules forwardingRules or {@code null} for none
*/
public TargetVpnGateway setForwardingRules(java.util.List forwardingRules) {
this.forwardingRules = forwardingRules;
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 TargetVpnGateway setId(java.math.BigInteger id) {
this.id = id;
return this;
}
/**
* [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
* @param kind kind or {@code null} for none
*/
public TargetVpnGateway setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* A fingerprint for the labels being applied to this TargetVpnGateway, 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 a TargetVpnGateway.
* @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 TargetVpnGateway, 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 a TargetVpnGateway.
* @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 TargetVpnGateway, 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 a TargetVpnGateway.
* @see #encodeLabelFingerprint()
* @param labelFingerprint labelFingerprint or {@code null} for none
*/
public TargetVpnGateway setLabelFingerprint(java.lang.String labelFingerprint) {
this.labelFingerprint = labelFingerprint;
return this;
}
/**
* A fingerprint for the labels being applied to this TargetVpnGateway, 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 a TargetVpnGateway.
* @see #setLabelFingerprint()
*
*
* The value is encoded Base64 or {@code null} for none.
*
*
* @since 1.14
*/
public TargetVpnGateway 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 TargetVpnGateway 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])?` which means the first
* character must be a lowercase letter, and all following characters must be a dash, lowercase
* letter, or digit, except the last character, which cannot be a dash.
* @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])?` which means the first
* character must be a lowercase letter, and all following characters must be a dash, lowercase
* letter, or digit, except the last character, which cannot be a dash.
* @param name name or {@code null} for none
*/
public TargetVpnGateway setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* URL of the network to which this VPN gateway is attached. Provided by the client when the VPN
* gateway is created.
* @return value or {@code null} for none
*/
public java.lang.String getNetwork() {
return network;
}
/**
* URL of the network to which this VPN gateway is attached. Provided by the client when the VPN
* gateway is created.
* @param network network or {@code null} for none
*/
public TargetVpnGateway setNetwork(java.lang.String network) {
this.network = network;
return this;
}
/**
* [Output Only] URL of the region where the target VPN gateway resides. You must specify this
* field as part of the HTTP request URL. It is not settable as a field in the request body.
* @return value or {@code null} for none
*/
public java.lang.String getRegion() {
return region;
}
/**
* [Output Only] URL of the region where the target VPN gateway resides. You must specify this
* field as part of the HTTP request URL. It is not settable as a field in the request body.
* @param region region or {@code null} for none
*/
public TargetVpnGateway 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 TargetVpnGateway setSelfLink(java.lang.String selfLink) {
this.selfLink = selfLink;
return this;
}
/**
* [Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
* READY, FAILED, or DELETING.
* @return value or {@code null} for none
*/
public java.lang.String getStatus() {
return status;
}
/**
* [Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
* READY, FAILED, or DELETING.
* @param status status or {@code null} for none
*/
public TargetVpnGateway setStatus(java.lang.String status) {
this.status = status;
return this;
}
/**
* [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the
* compute.vpntunnels.insert method and associated with a VPN gateway.
* @return value or {@code null} for none
*/
public java.util.List getTunnels() {
return tunnels;
}
/**
* [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the
* compute.vpntunnels.insert method and associated with a VPN gateway.
* @param tunnels tunnels or {@code null} for none
*/
public TargetVpnGateway setTunnels(java.util.List tunnels) {
this.tunnels = tunnels;
return this;
}
@Override
public TargetVpnGateway set(String fieldName, Object value) {
return (TargetVpnGateway) super.set(fieldName, value);
}
@Override
public TargetVpnGateway clone() {
return (TargetVpnGateway) super.clone();
}
}