VpnTunnel (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.VpnTunnel

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class VpnTunnel
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VpnTunnel.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`VpnTunnel.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`static VpnTunnel`	`getDefaultInstance()`
`String`	`getDescription()` An optional description of this resource.
`String`	`getDetailedStatus()` [Output Only] Detailed status message for the VPN tunnel.
`List<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`String`	`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.
`List<String>`	`getLocalTrafficSelectorList()` 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>`	`getRemoteTrafficSelectorList()` 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.
`int`	`hashCode()`
`static VpnTunnel.Builder`	`newBuilder()`
`static VpnTunnel.Builder`	`newBuilder(VpnTunnel prototype)`
`VpnTunnel.Builder`	`toBuilder()`
`String`	`toString()`

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

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - getDetailedStatus
```
public String getDetailedStatus()
```
    [Output Only] Detailed status message for the VPN tunnel.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - 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.
  - getKind
```
public String getKind()
```
    [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
  - getLocalTrafficSelectorList
```
public List<String> getLocalTrafficSelectorList()
```
    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.
  - 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.
  - 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.
  - 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.
  - 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.
  - getPeerIp
```
public String getPeerIp()
```
    IP address of the peer VPN gateway. Only IPv4 is supported.
  - 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.
  - getRemoteTrafficSelectorList
```
public List<String> getRemoteTrafficSelectorList()
```
    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.
  - getRouter
```
public String getRouter()
```
    URL of the router resource to be used for dynamic routing.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - getSharedSecret
```
public String getSharedSecret()
```
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
  - getSharedSecretHash
```
public String getSharedSecretHash()
```
    Hash of the shared secret.
  - 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.
  - 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.
  - 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.
  - getVpnGatewayInterface
```
public Integer getVpnGatewayInterface()
```
    The interface ID of the VPN gateway with which this VPN tunnel is associated.
  - newBuilder
```
public static VpnTunnel.Builder newBuilder()
```
  - newBuilder
```
public static VpnTunnel.Builder newBuilder(VpnTunnel prototype)
```
  - toBuilder
```
public VpnTunnel.Builder toBuilder()
```
  - getDefaultInstance
```
public static VpnTunnel getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class VpnTunnel

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getCreationTimestamp

getDescription

getDetailedStatus

getId

getIkeVersion

getKind

getLocalTrafficSelectorList

getName

getPeerExternalGateway

getPeerExternalGatewayInterface

getPeerGcpGateway

getPeerIp

getRegion

getRemoteTrafficSelectorList

getRouter

getSelfLink

getSharedSecret

getSharedSecretHash

getStatus

getTargetVpnGateway

getVpnGateway

getVpnGatewayInterface

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode