com.google.api.services.compute.model.VpnTunnel 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 Cloud VPN Tunnel resource. For more information about VPN, 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 VpnTunnel 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] Detailed status message for the VPN tunnel.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String detailedStatus;
/**
* [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;
/**
* IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.
* Acceptable IKE versions are 1 or 2. The default version is 2.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer ikeVersion;
/**
* [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
* 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 VpnTunnel, 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 VpnTunnel.
* 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;
/**
* Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List localTrafficSelector;
/**
* 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 peer side external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. This field is exclusive with the field
* peerGcpGateway.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String peerExternalGateway;
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number
* of IDs in use depends on the external VPN gateway redundancy type.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer peerExternalGatewayInterface;
/**
* URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the
* client when the VPN tunnel is created. This field can be used when creating highly available
* VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer
* Google Cloud VPN gateway.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String peerGcpGateway;
/**
* IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for
* Classic VPN tunnels.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String peerIp;
/**
* [Output Only] URL of the region where the VPN tunnel 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;
/**
* Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List remoteTrafficSelector;
/**
* URL of the router resource to be used for dynamic routing.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String router;
/**
* [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;
/**
* Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
* gateway.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String sharedSecret;
/**
* Hash of the shared secret.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String sharedSecretHash;
/**
* [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING:
* Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive
* all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule,
* and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first
* handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the
* peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR:
* Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. -
* DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation
* has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets
* from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access.
* - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. -
* STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or
* the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP,
* probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an
* HA-VPN tunnel.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String status;
/**
* URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client
* when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String targetVpnGateway;
/**
* URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when
* the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High
* Availability VPN gateway resource is created.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String vpnGateway;
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values
* are: `0`, `1`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer vpnGatewayInterface;
/**
* [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 VpnTunnel 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 VpnTunnel setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* [Output Only] Detailed status message for the VPN tunnel.
* @return value or {@code null} for none
*/
public java.lang.String getDetailedStatus() {
return detailedStatus;
}
/**
* [Output Only] Detailed status message for the VPN tunnel.
* @param detailedStatus detailedStatus or {@code null} for none
*/
public VpnTunnel setDetailedStatus(java.lang.String detailedStatus) {
this.detailedStatus = detailedStatus;
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 VpnTunnel setId(java.math.BigInteger id) {
this.id = id;
return this;
}
/**
* IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.
* Acceptable IKE versions are 1 or 2. The default version is 2.
* @return value or {@code null} for none
*/
public java.lang.Integer getIkeVersion() {
return ikeVersion;
}
/**
* IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.
* Acceptable IKE versions are 1 or 2. The default version is 2.
* @param ikeVersion ikeVersion or {@code null} for none
*/
public VpnTunnel setIkeVersion(java.lang.Integer ikeVersion) {
this.ikeVersion = ikeVersion;
return this;
}
/**
* [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
* @param kind kind or {@code null} for none
*/
public VpnTunnel setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* A fingerprint for the labels being applied to this VpnTunnel, 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 VpnTunnel.
* @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 VpnTunnel, 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 VpnTunnel.
* @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 VpnTunnel, 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 VpnTunnel.
* @see #encodeLabelFingerprint()
* @param labelFingerprint labelFingerprint or {@code null} for none
*/
public VpnTunnel setLabelFingerprint(java.lang.String labelFingerprint) {
this.labelFingerprint = labelFingerprint;
return this;
}
/**
* A fingerprint for the labels being applied to this VpnTunnel, 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 VpnTunnel.
* @see #setLabelFingerprint()
*
*
* The value is encoded Base64 or {@code null} for none.
*
*
* @since 1.14
*/
public VpnTunnel 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 VpnTunnel setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* @return value or {@code null} for none
*/
public java.util.List getLocalTrafficSelector() {
return localTrafficSelector;
}
/**
* Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* @param localTrafficSelector localTrafficSelector or {@code null} for none
*/
public VpnTunnel setLocalTrafficSelector(java.util.List localTrafficSelector) {
this.localTrafficSelector = localTrafficSelector;
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 VpnTunnel setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. This field is exclusive with the field
* peerGcpGateway.
* @return value or {@code null} for none
*/
public java.lang.String getPeerExternalGateway() {
return peerExternalGateway;
}
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. This field is exclusive with the field
* peerGcpGateway.
* @param peerExternalGateway peerExternalGateway or {@code null} for none
*/
public VpnTunnel setPeerExternalGateway(java.lang.String peerExternalGateway) {
this.peerExternalGateway = peerExternalGateway;
return this;
}
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number
* of IDs in use depends on the external VPN gateway redundancy type.
* @return value or {@code null} for none
*/
public java.lang.Integer getPeerExternalGatewayInterface() {
return peerExternalGatewayInterface;
}
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by
* the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number
* of IDs in use depends on the external VPN gateway redundancy type.
* @param peerExternalGatewayInterface peerExternalGatewayInterface or {@code null} for none
*/
public VpnTunnel setPeerExternalGatewayInterface(java.lang.Integer peerExternalGatewayInterface) {
this.peerExternalGatewayInterface = peerExternalGatewayInterface;
return this;
}
/**
* URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the
* client when the VPN tunnel is created. This field can be used when creating highly available
* VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer
* Google Cloud VPN gateway.
* @return value or {@code null} for none
*/
public java.lang.String getPeerGcpGateway() {
return peerGcpGateway;
}
/**
* URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the
* client when the VPN tunnel is created. This field can be used when creating highly available
* VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer
* Google Cloud VPN gateway.
* @param peerGcpGateway peerGcpGateway or {@code null} for none
*/
public VpnTunnel setPeerGcpGateway(java.lang.String peerGcpGateway) {
this.peerGcpGateway = peerGcpGateway;
return this;
}
/**
* IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for
* Classic VPN tunnels.
* @return value or {@code null} for none
*/
public java.lang.String getPeerIp() {
return peerIp;
}
/**
* IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for
* Classic VPN tunnels.
* @param peerIp peerIp or {@code null} for none
*/
public VpnTunnel setPeerIp(java.lang.String peerIp) {
this.peerIp = peerIp;
return this;
}
/**
* [Output Only] URL of the region where the VPN tunnel 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 VPN tunnel 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 VpnTunnel setRegion(java.lang.String region) {
this.region = region;
return this;
}
/**
* Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* @return value or {@code null} for none
*/
public java.util.List getRemoteTrafficSelector() {
return remoteTrafficSelector;
}
/**
* Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The
* value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be
* disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN
* tunnels.
* @param remoteTrafficSelector remoteTrafficSelector or {@code null} for none
*/
public VpnTunnel setRemoteTrafficSelector(java.util.List remoteTrafficSelector) {
this.remoteTrafficSelector = remoteTrafficSelector;
return this;
}
/**
* URL of the router resource to be used for dynamic routing.
* @return value or {@code null} for none
*/
public java.lang.String getRouter() {
return router;
}
/**
* URL of the router resource to be used for dynamic routing.
* @param router router or {@code null} for none
*/
public VpnTunnel setRouter(java.lang.String router) {
this.router = router;
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 VpnTunnel setSelfLink(java.lang.String selfLink) {
this.selfLink = selfLink;
return this;
}
/**
* Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
* gateway.
* @return value or {@code null} for none
*/
public java.lang.String getSharedSecret() {
return sharedSecret;
}
/**
* Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
* gateway.
* @param sharedSecret sharedSecret or {@code null} for none
*/
public VpnTunnel setSharedSecret(java.lang.String sharedSecret) {
this.sharedSecret = sharedSecret;
return this;
}
/**
* Hash of the shared secret.
* @return value or {@code null} for none
*/
public java.lang.String getSharedSecretHash() {
return sharedSecretHash;
}
/**
* Hash of the shared secret.
* @param sharedSecretHash sharedSecretHash or {@code null} for none
*/
public VpnTunnel setSharedSecretHash(java.lang.String sharedSecretHash) {
this.sharedSecretHash = sharedSecretHash;
return this;
}
/**
* [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING:
* Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive
* all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule,
* and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first
* handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the
* peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR:
* Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. -
* DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation
* has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets
* from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access.
* - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. -
* STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or
* the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP,
* probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an
* HA-VPN tunnel.
* @return value or {@code null} for none
*/
public java.lang.String getStatus() {
return status;
}
/**
* [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING:
* Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive
* all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule,
* and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first
* handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the
* peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR:
* Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. -
* DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation
* has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets
* from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access.
* - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. -
* STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or
* the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP,
* probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an
* HA-VPN tunnel.
* @param status status or {@code null} for none
*/
public VpnTunnel setStatus(java.lang.String status) {
this.status = status;
return this;
}
/**
* URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client
* when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.
* @return value or {@code null} for none
*/
public java.lang.String getTargetVpnGateway() {
return targetVpnGateway;
}
/**
* URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client
* when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.
* @param targetVpnGateway targetVpnGateway or {@code null} for none
*/
public VpnTunnel setTargetVpnGateway(java.lang.String targetVpnGateway) {
this.targetVpnGateway = targetVpnGateway;
return this;
}
/**
* URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when
* the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High
* Availability VPN gateway resource is created.
* @return value or {@code null} for none
*/
public java.lang.String getVpnGateway() {
return vpnGateway;
}
/**
* URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when
* the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High
* Availability VPN gateway resource is created.
* @param vpnGateway vpnGateway or {@code null} for none
*/
public VpnTunnel setVpnGateway(java.lang.String vpnGateway) {
this.vpnGateway = vpnGateway;
return this;
}
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values
* are: `0`, `1`.
* @return value or {@code null} for none
*/
public java.lang.Integer getVpnGatewayInterface() {
return vpnGatewayInterface;
}
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values
* are: `0`, `1`.
* @param vpnGatewayInterface vpnGatewayInterface or {@code null} for none
*/
public VpnTunnel setVpnGatewayInterface(java.lang.Integer vpnGatewayInterface) {
this.vpnGatewayInterface = vpnGatewayInterface;
return this;
}
@Override
public VpnTunnel set(String fieldName, Object value) {
return (VpnTunnel) super.set(fieldName, value);
}
@Override
public VpnTunnel clone() {
return (VpnTunnel) super.clone();
}
}