VpnTunnel (Compute Engine API v1 (Rev. 103) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.VpnTunnel

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class VpnTunnel
extends com.google.api.client.json.GenericJson
```
Model definition for VpnTunnel.
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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

VpnTunnel()

Constructors
Constructor and Description
`VpnTunnel()`

Method Summary

Methods
Modifier and Type	Method and Description
`VpnTunnel`	`clone()`
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getDetailedStatus()` [Output Only] Detailed status message for the VPN tunnel.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.Integer`	`getIkeVersion()` IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
`java.lang.String`	`getKind()` [Output Only] Type of resource.
`java.util.List<java.lang.String>`	`getLocalTrafficSelector()` Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
`java.lang.String`	`getName()` Name of the resource.
`java.lang.String`	`getPeerIp()` IP address of the peer VPN gateway.
`java.lang.String`	`getRegion()` [Output Only] URL of the region where the VPN tunnel resides.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`java.lang.String`	`getSharedSecret()` Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`java.lang.String`	`getSharedSecretHash()` Hash of the shared secret.
`java.lang.String`	`getStatus()` [Output Only] The status of the VPN tunnel.
`java.lang.String`	`getTargetVpnGateway()` URL of the VPN gateway with which this VPN tunnel is associated.
`VpnTunnel`	`set(java.lang.String fieldName, java.lang.Object value)`
`VpnTunnel`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`VpnTunnel`	`setDescription(java.lang.String description)` An optional description of this resource.
`VpnTunnel`	`setDetailedStatus(java.lang.String detailedStatus)` [Output Only] Detailed status message for the VPN tunnel.
`VpnTunnel`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`VpnTunnel`	`setIkeVersion(java.lang.Integer ikeVersion)` IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
`VpnTunnel`	`setKind(java.lang.String kind)` [Output Only] Type of resource.
`VpnTunnel`	`setLocalTrafficSelector(java.util.List<java.lang.String> localTrafficSelector)` Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
`VpnTunnel`	`setName(java.lang.String name)` Name of the resource.
`VpnTunnel`	`setPeerIp(java.lang.String peerIp)` IP address of the peer VPN gateway.
`VpnTunnel`	`setRegion(java.lang.String region)` [Output Only] URL of the region where the VPN tunnel resides.
`VpnTunnel`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`VpnTunnel`	`setSharedSecret(java.lang.String sharedSecret)` Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`VpnTunnel`	`setSharedSecretHash(java.lang.String sharedSecretHash)` Hash of the shared secret.
`VpnTunnel`	`setStatus(java.lang.String status)` [Output Only] The status of the VPN tunnel.
`VpnTunnel`	`setTargetVpnGateway(java.lang.String targetVpnGateway)` URL 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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - VpnTunnel
```
public VpnTunnel()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public VpnTunnel setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.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(java.lang.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 java.lang.String getDetailedStatus()
```
    [Output Only] Detailed status message for the VPN tunnel.
    
    Returns:
    value or null for none
  - setDetailedStatus
```
public VpnTunnel setDetailedStatus(java.lang.String detailedStatus)
```
    [Output Only] Detailed status message for the VPN tunnel.
    
    Parameters:
    detailedStatus - detailedStatus or null for none
  - getId
```
public java.math.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(java.math.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 java.lang.Integer getIkeVersion()
```
    IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
    
    Returns:
    value or null for none
  - setIkeVersion
```
public VpnTunnel setIkeVersion(java.lang.Integer ikeVersion)
```
    IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
    
    Parameters:
    ikeVersion - ikeVersion or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    
    Returns:
    value or null for none
  - setKind
```
public VpnTunnel setKind(java.lang.String kind)
```
    [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
    
    Parameters:
    kind - kind or null for none
  - getLocalTrafficSelector
```
public java.util.List<java.lang.String> getLocalTrafficSelector()
```
    Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
    
    Returns:
    value or null for none
  - setLocalTrafficSelector
```
public VpnTunnel setLocalTrafficSelector(java.util.List<java.lang.String> localTrafficSelector)
```
    Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
    
    Parameters:
    localTrafficSelector - localTrafficSelector or null for none
  - getName
```
public java.lang.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(java.lang.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
  - getPeerIp
```
public java.lang.String getPeerIp()
```
    IP address of the peer VPN gateway.
    
    Returns:
    value or null for none
  - setPeerIp
```
public VpnTunnel setPeerIp(java.lang.String peerIp)
```
    IP address of the peer VPN gateway.
    
    Parameters:
    peerIp - peerIp or null for none
  - getRegion
```
public java.lang.String getRegion()
```
    [Output Only] URL of the region where the VPN tunnel resides.
    
    Returns:
    value or null for none
  - setRegion
```
public VpnTunnel setRegion(java.lang.String region)
```
    [Output Only] URL of the region where the VPN tunnel resides.
    
    Parameters:
    region - region or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    value or null for none
  - setSelfLink
```
public VpnTunnel setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    selfLink - selfLink or null for none
  - getSharedSecret
```
public java.lang.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(java.lang.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 java.lang.String getSharedSecretHash()
```
    Hash of the shared secret.
    
    Returns:
    value or null for none
  - setSharedSecretHash
```
public VpnTunnel setSharedSecretHash(java.lang.String sharedSecretHash)
```
    Hash of the shared secret.
    
    Parameters:
    sharedSecretHash - sharedSecretHash or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    [Output Only] The status of the VPN tunnel.
    
    Returns:
    value or null for none
  - setStatus
```
public VpnTunnel setStatus(java.lang.String status)
```
    [Output Only] The status of the VPN tunnel.
    
    Parameters:
    status - status or null for none
  - getTargetVpnGateway
```
public java.lang.String getTargetVpnGateway()
```
    URL of the 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(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.
    
    Parameters:
    targetVpnGateway - targetVpnGateway or null for none
  - set
```
public VpnTunnel set(java.lang.String fieldName,
            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public VpnTunnel clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

Class VpnTunnel

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

VpnTunnel

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDetailedStatus

setDetailedStatus

getId

setId

getIkeVersion

setIkeVersion

getKind

setKind

getLocalTrafficSelector

setLocalTrafficSelector

getName

setName

getPeerIp

setPeerIp

getRegion

setRegion

getSelfLink

setSelfLink

getSharedSecret

setSharedSecret

getSharedSecretHash

setSharedSecretHash

getStatus

setStatus

getTargetVpnGateway

setTargetVpnGateway

set

clone