• Home
• com.google.apis
• google-api-services-compute
• beta-rev20220726-2.0.0
• source code
• VpnTunnel.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.model.VpnTunnel.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class VpnTunnel



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.VpnTunnel













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class VpnTunnel
extends GenericJson
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.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


VpnTunnel() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


VpnTunnel
clone() 


byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of
 the labels set used for optimistic locking.



VpnTunnel
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of
 the labels set used for optimistic locking.



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



String
getDescription()
An optional description of this resource.



String
getDetailedStatus()
[Output Only] Detailed status message for the VPN tunnel.



BigInteger
getId()
[Output Only] The unique identifier for the resource.



Integer
getIkeVersion()
IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.



String
getKind()
[Output Only] Type of resource.



String
getLabelFingerprint()
A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of
 the labels set used for optimistic locking.



Map<String,String>
getLabels()
Labels for this resource.



List<String>
getLocalTrafficSelector()
Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway.



String
getName()
Name of the resource.



String
getPeerExternalGateway()
URL of the peer side external VPN gateway to which this VPN tunnel is connected.



Integer
getPeerExternalGatewayInterface()
The interface ID of the external VPN gateway to which this VPN tunnel is connected.



String
getPeerGcpGateway()
URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.



String
getPeerIp()
IP address of the peer VPN gateway.



String
getRegion()
[Output Only] URL of the region where the VPN tunnel resides.



List<String>
getRemoteTrafficSelector()
Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway.



String
getRouter()
URL of the router resource to be used for dynamic routing.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getSharedSecret()
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
 gateway.



String
getSharedSecretHash()
Hash of the shared secret.



String
getStatus()
[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING:
 Resource is being allocated for the VPN tunnel.



String
getTargetVpnGateway()
URL of the Target VPN gateway with which this VPN tunnel is associated.



String
getVpnGateway()
URL of the VPN gateway with which this VPN tunnel is associated.



Integer
getVpnGatewayInterface()
The interface ID of the VPN gateway with which this VPN tunnel is associated.



VpnTunnel
set(String fieldName,
   Object value) 


VpnTunnel
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



VpnTunnel
setDescription(String description)
An optional description of this resource.



VpnTunnel
setDetailedStatus(String detailedStatus)
[Output Only] Detailed status message for the VPN tunnel.



VpnTunnel
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



VpnTunnel
setIkeVersion(Integer ikeVersion)
IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.



VpnTunnel
setKind(String kind)
[Output Only] Type of resource.



VpnTunnel
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of
 the labels set used for optimistic locking.



VpnTunnel
setLabels(Map<String,String> labels)
Labels for this resource.



VpnTunnel
setLocalTrafficSelector(List<String> localTrafficSelector)
Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway.



VpnTunnel
setName(String name)
Name of the resource.



VpnTunnel
setPeerExternalGateway(String peerExternalGateway)
URL of the peer side external VPN gateway to which this VPN tunnel is connected.



VpnTunnel
setPeerExternalGatewayInterface(Integer peerExternalGatewayInterface)
The interface ID of the external VPN gateway to which this VPN tunnel is connected.



VpnTunnel
setPeerGcpGateway(String peerGcpGateway)
URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.



VpnTunnel
setPeerIp(String peerIp)
IP address of the peer VPN gateway.



VpnTunnel
setRegion(String region)
[Output Only] URL of the region where the VPN tunnel resides.



VpnTunnel
setRemoteTrafficSelector(List<String> remoteTrafficSelector)
Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway.



VpnTunnel
setRouter(String router)
URL of the router resource to be used for dynamic routing.



VpnTunnel
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



VpnTunnel
setSharedSecret(String sharedSecret)
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
 gateway.



VpnTunnel
setSharedSecretHash(String sharedSecretHash)
Hash of the shared secret.



VpnTunnel
setStatus(String 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.



VpnTunnel
setTargetVpnGateway(String targetVpnGateway)
URL of the Target VPN gateway with which this VPN tunnel is associated.



VpnTunnel
setVpnGateway(String vpnGateway)
URL of the VPN gateway with which this VPN tunnel is associated.



VpnTunnel
setVpnGatewayInterface(Integer vpnGatewayInterface)
The interface ID of the VPN gateway with which this VPN tunnel is associated.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





VpnTunnel
public VpnTunnel()









Method Detail





getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public VpnTunnel setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public VpnTunnel setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getDetailedStatus
public String getDetailedStatus()
[Output Only] Detailed status message for the VPN tunnel.

Returns:
value or null for none








setDetailedStatus
public VpnTunnel setDetailedStatus(String detailedStatus)
[Output Only] Detailed status message for the VPN tunnel.

Parameters:
detailedStatus - detailedStatus or null for none








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:
value or null for none








setId
public VpnTunnel setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:
id - id or null for none








getIkeVersion
public Integer getIkeVersion()
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.

Returns:
value or null for none








setIkeVersion
public VpnTunnel setIkeVersion(Integer 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.

Parameters:
ikeVersion - ikeVersion or null for none








getKind
public String getKind()
[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

Returns:
value or null for none








setKind
public VpnTunnel setKind(String kind)
[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

Parameters:
kind - kind or null for none








getLabelFingerprint
public String getLabelFingerprint()
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.

Returns:
value or null for none
See Also:
decodeLabelFingerprint()








decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
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.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getLabelFingerprint()








setLabelFingerprint
public VpnTunnel setLabelFingerprint(String 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.

Parameters:
labelFingerprint - labelFingerprint or null for none
See Also:
#encodeLabelFingerprint()








encodeLabelFingerprint
public VpnTunnel encodeLabelFingerprint(byte[] 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.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getLabels
public Map<String,String> getLabels()
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.

Returns:
value or null for none








setLabels
public VpnTunnel setLabels(Map<String,String> 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.

Parameters:
labels - labels or null for none








getLocalTrafficSelector
public List<String> getLocalTrafficSelector()
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.

Returns:
value or null for none








setLocalTrafficSelector
public VpnTunnel setLocalTrafficSelector(List<String> 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.

Parameters:
localTrafficSelector - localTrafficSelector or null for none








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]([-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.

Returns:
value or null for none








setName
public VpnTunnel setName(String 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.

Parameters:
name - name or null for none








getPeerExternalGateway
public String getPeerExternalGateway()
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.

Returns:
value or null for none








setPeerExternalGateway
public VpnTunnel setPeerExternalGateway(String 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.

Parameters:
peerExternalGateway - peerExternalGateway or null for none








getPeerExternalGatewayInterface
public Integer getPeerExternalGatewayInterface()
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.

Returns:
value or null for none








setPeerExternalGatewayInterface
public VpnTunnel setPeerExternalGatewayInterface(Integer 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.

Parameters:
peerExternalGatewayInterface - peerExternalGatewayInterface or null for none








getPeerGcpGateway
public String getPeerGcpGateway()
URL of the peer side HA GCP 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
 GCP VPN gateway.

Returns:
value or null for none








setPeerGcpGateway
public VpnTunnel setPeerGcpGateway(String peerGcpGateway)
URL of the peer side HA GCP 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
 GCP VPN gateway.

Parameters:
peerGcpGateway - peerGcpGateway or null for none








getPeerIp
public String getPeerIp()
IP address of the peer VPN gateway. Only IPv4 is supported.

Returns:
value or null for none








setPeerIp
public VpnTunnel setPeerIp(String peerIp)
IP address of the peer VPN gateway. Only IPv4 is supported.

Parameters:
peerIp - peerIp or null for none








getRegion
public String getRegion()
[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.

Returns:
value or null for none








setRegion
public VpnTunnel setRegion(String 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.

Parameters:
region - region or null for none








getRemoteTrafficSelector
public List<String> getRemoteTrafficSelector()
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.

Returns:
value or null for none








setRemoteTrafficSelector
public VpnTunnel setRemoteTrafficSelector(List<String> 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.

Parameters:
remoteTrafficSelector - remoteTrafficSelector or null for none








getRouter
public String getRouter()
URL of the router resource to be used for dynamic routing.

Returns:
value or null for none








setRouter
public VpnTunnel setRouter(String router)
URL of the router resource to be used for dynamic routing.

Parameters:
router - router or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public VpnTunnel setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getSharedSecret
public String getSharedSecret()
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
 gateway.

Returns:
value or null for none








setSharedSecret
public VpnTunnel setSharedSecret(String sharedSecret)
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN
 gateway.

Parameters:
sharedSecret - sharedSecret or null for none








getSharedSecretHash
public String getSharedSecretHash()
Hash of the shared secret.

Returns:
value or null for none








setSharedSecretHash
public VpnTunnel setSharedSecretHash(String sharedSecretHash)
Hash of the shared secret.

Parameters:
sharedSecretHash - sharedSecretHash or null for none








getStatus
public String getStatus()
[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.

Returns:
value or null for none








setStatus
public VpnTunnel setStatus(String 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.

Parameters:
status - status or null for none








getTargetVpnGateway
public String getTargetVpnGateway()
URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client
 when the VPN tunnel is created.

Returns:
value or null for none








setTargetVpnGateway
public VpnTunnel setTargetVpnGateway(String targetVpnGateway)
URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client
 when the VPN tunnel is created.

Parameters:
targetVpnGateway - targetVpnGateway or null for none








getVpnGateway
public String getVpnGateway()
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.

Returns:
value or null for none








setVpnGateway
public VpnTunnel setVpnGateway(String 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.

Parameters:
vpnGateway - vpnGateway or null for none








getVpnGatewayInterface
public Integer getVpnGatewayInterface()
The interface ID of the VPN gateway with which this VPN tunnel is associated.

Returns:
value or null for none








setVpnGatewayInterface
public VpnTunnel setVpnGatewayInterface(Integer vpnGatewayInterface)
The interface ID of the VPN gateway with which this VPN tunnel is associated.

Parameters:
vpnGatewayInterface - vpnGatewayInterface or null for none








set
public VpnTunnel set(String fieldName,
                     Object value)

Overrides:
set in class GenericJson








clone
public VpnTunnel clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.