VpnTunnel.Builder (Google Cloud 0.119.0-alpha API)

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

Enclosing class:: VpnTunnel

public static class VpnTunnel.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VpnTunnel.Builder`	`addAllLocalTrafficSelector(List<String> localTrafficSelector)` Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway.
`VpnTunnel.Builder`	`addAllRemoteTrafficSelector(List<String> remoteTrafficSelector)` Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway.
`VpnTunnel.Builder`	`addLocalTrafficSelector(String localTrafficSelector)` Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway.
`VpnTunnel.Builder`	`addRemoteTrafficSelector(String remoteTrafficSelector)` Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway.
`VpnTunnel`	`build()`
`VpnTunnel.Builder`	`clone()`
`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.
`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.
`VpnTunnel.Builder`	`mergeFrom(VpnTunnel other)`
`VpnTunnel.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`VpnTunnel.Builder`	`setDescription(String description)` An optional description of this resource.
`VpnTunnel.Builder`	`setDetailedStatus(String detailedStatus)` [Output Only] Detailed status message for the VPN tunnel.
`VpnTunnel.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`VpnTunnel.Builder`	`setIkeVersion(Integer ikeVersion)` IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.
`VpnTunnel.Builder`	`setKind(String kind)` [Output Only] Type of resource.
`VpnTunnel.Builder`	`setName(String name)` Name of the resource.
`VpnTunnel.Builder`	`setPeerExternalGateway(String peerExternalGateway)` URL of the peer side external VPN gateway to which this VPN tunnel is connected.
`VpnTunnel.Builder`	`setPeerExternalGatewayInterface(Integer peerExternalGatewayInterface)` The interface ID of the external VPN gateway to which this VPN tunnel is connected.
`VpnTunnel.Builder`	`setPeerGcpGateway(String peerGcpGateway)` URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
`VpnTunnel.Builder`	`setPeerIp(String peerIp)` IP address of the peer VPN gateway.
`VpnTunnel.Builder`	`setRegion(String region)` [Output Only] URL of the region where the VPN tunnel resides.
`VpnTunnel.Builder`	`setRouter(String router)` URL of the router resource to be used for dynamic routing.
`VpnTunnel.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`VpnTunnel.Builder`	`setSharedSecret(String sharedSecret)` Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
`VpnTunnel.Builder`	`setSharedSecretHash(String sharedSecretHash)` Hash of the shared secret.
`VpnTunnel.Builder`	`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.Builder`	`setTargetVpnGateway(String targetVpnGateway)` URL of the Target VPN gateway with which this VPN tunnel is associated.
`VpnTunnel.Builder`	`setVpnGateway(String vpnGateway)` URL of the VPN gateway with which this VPN tunnel is associated.
`VpnTunnel.Builder`	`setVpnGatewayInterface(Integer vpnGatewayInterface)` The interface ID of the VPN gateway with which this VPN tunnel is associated.

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

- Method Detail
  - mergeFrom
```
public VpnTunnel.Builder mergeFrom(VpnTunnel other)
```
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public VpnTunnel.Builder setCreationTimestamp(String creationTimestamp)
```
    [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.
  - setDescription
```
public VpnTunnel.Builder setDescription(String description)
```
    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.
  - setDetailedStatus
```
public VpnTunnel.Builder setDetailedStatus(String detailedStatus)
```
    [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.
  - setId
```
public VpnTunnel.Builder setId(String id)
```
    [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.
  - setIkeVersion
```
public VpnTunnel.Builder 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.
  - getKind
```
public String getKind()
```
    [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
  - setKind
```
public VpnTunnel.Builder setKind(String kind)
```
    [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.
  - addAllLocalTrafficSelector
```
public VpnTunnel.Builder addAllLocalTrafficSelector(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.
  - addLocalTrafficSelector
```
public VpnTunnel.Builder addLocalTrafficSelector(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.
  - 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.
  - setName
```
public VpnTunnel.Builder 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.
  - 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.
  - setPeerExternalGateway
```
public VpnTunnel.Builder 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.
  - 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.
  - setPeerExternalGatewayInterface
```
public VpnTunnel.Builder 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.
  - 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.
  - setPeerGcpGateway
```
public VpnTunnel.Builder 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.
  - getPeerIp
```
public String getPeerIp()
```
    IP address of the peer VPN gateway. Only IPv4 is supported.
  - setPeerIp
```
public VpnTunnel.Builder setPeerIp(String peerIp)
```
    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.
  - setRegion
```
public VpnTunnel.Builder 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.
  - 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.
  - addAllRemoteTrafficSelector
```
public VpnTunnel.Builder addAllRemoteTrafficSelector(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.
  - addRemoteTrafficSelector
```
public VpnTunnel.Builder addRemoteTrafficSelector(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.
  - getRouter
```
public String getRouter()
```
    URL of the router resource to be used for dynamic routing.
  - setRouter
```
public VpnTunnel.Builder setRouter(String router)
```
    URL of the router resource to be used for dynamic routing.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public VpnTunnel.Builder setSelfLink(String selfLink)
```
    [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.
  - setSharedSecret
```
public VpnTunnel.Builder setSharedSecret(String sharedSecret)
```
    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.
  - setSharedSecretHash
```
public VpnTunnel.Builder setSharedSecretHash(String sharedSecretHash)
```
    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.
  - setStatus
```
public VpnTunnel.Builder 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.
  - 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.
  - setTargetVpnGateway
```
public VpnTunnel.Builder 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.
  - 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.
  - setVpnGateway
```
public VpnTunnel.Builder 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.
  - getVpnGatewayInterface
```
public Integer getVpnGatewayInterface()
```
    The interface ID of the VPN gateway with which this VPN tunnel is associated.
  - setVpnGatewayInterface
```
public VpnTunnel.Builder setVpnGatewayInterface(Integer vpnGatewayInterface)
```
    The interface ID of the VPN gateway with which this VPN tunnel is associated.
  - build
```
public VpnTunnel build()
```
  - clone
```
public VpnTunnel.Builder clone()
```
    Overrides:
    
    clone in class Object

Class VpnTunnel.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDetailedStatus

setDetailedStatus

getId

setId

getIkeVersion

setIkeVersion

getKind

setKind

getLocalTrafficSelectorList

addAllLocalTrafficSelector

addLocalTrafficSelector

getName

setName

getPeerExternalGateway

setPeerExternalGateway

getPeerExternalGatewayInterface

setPeerExternalGatewayInterface

getPeerGcpGateway

setPeerGcpGateway

getPeerIp

setPeerIp

getRegion

setRegion

getRemoteTrafficSelectorList

addAllRemoteTrafficSelector

addRemoteTrafficSelector

getRouter

setRouter

getSelfLink

setSelfLink

getSharedSecret

setSharedSecret

getSharedSecretHash

setSharedSecretHash

getStatus

setStatus

getTargetVpnGateway

setTargetVpnGateway

getVpnGateway

setVpnGateway

getVpnGatewayInterface

setVpnGatewayInterface

build

clone