Class VpnTunnel.Builder (1.55.0) 

public static final class VpnTunnel.Builder extends GeneratedMessageV3.Builder<VpnTunnel.Builder> implements VpnTunnelOrBuilder

Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.

Protobuf type google.cloud.compute.v1.VpnTunnel

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VpnTunnel.Builder

Implements

VpnTunnelOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLocalTrafficSelector(Iterable<String> values)

public VpnTunnel.Builder addAllLocalTrafficSelector(Iterable<String> values)

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.

repeated string local_traffic_selector = 317314613;

Parameter
Name Description
values Iterable<String>

The localTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addAllRemoteTrafficSelector(Iterable<String> values)

public VpnTunnel.Builder addAllRemoteTrafficSelector(Iterable<String> values)

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.

repeated string remote_traffic_selector = 358887098;

Parameter
Name Description
values Iterable<String>

The remoteTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addLocalTrafficSelector(String value)

public VpnTunnel.Builder addLocalTrafficSelector(String value)

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.

repeated string local_traffic_selector = 317314613;

Parameter
Name Description
value String

The localTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addLocalTrafficSelectorBytes(ByteString value)

public VpnTunnel.Builder addLocalTrafficSelectorBytes(ByteString value)

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.

repeated string local_traffic_selector = 317314613;

Parameter
Name Description
value ByteString

The bytes of the localTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addRemoteTrafficSelector(String value)

public VpnTunnel.Builder addRemoteTrafficSelector(String value)

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.

repeated string remote_traffic_selector = 358887098;

Parameter
Name Description
value String

The remoteTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addRemoteTrafficSelectorBytes(ByteString value)

public VpnTunnel.Builder addRemoteTrafficSelectorBytes(ByteString value)

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.

repeated string remote_traffic_selector = 358887098;

Parameter
Name Description
value ByteString

The bytes of the remoteTrafficSelector to add.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VpnTunnel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VpnTunnel.Builder
Overrides

build()

public VpnTunnel build()
Returns
Type Description
VpnTunnel

buildPartial()

public VpnTunnel buildPartial()
Returns
Type Description
VpnTunnel

clear()

public VpnTunnel.Builder clear()
Returns
Type Description
VpnTunnel.Builder
Overrides

clearCreationTimestamp()

public VpnTunnel.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearDescription()

public VpnTunnel.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearDetailedStatus()

public VpnTunnel.Builder clearDetailedStatus()

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VpnTunnel.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VpnTunnel.Builder
Overrides

clearId()

public VpnTunnel.Builder clearId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearIkeVersion()

public VpnTunnel.Builder clearIkeVersion()

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.

optional int32 ike_version = 218376220;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearKind()

public VpnTunnel.Builder clearKind()

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearLabelFingerprint()

public VpnTunnel.Builder clearLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearLabels()

public VpnTunnel.Builder clearLabels()
Returns
Type Description
VpnTunnel.Builder

clearLocalTrafficSelector()

public VpnTunnel.Builder clearLocalTrafficSelector()

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.

repeated string local_traffic_selector = 317314613;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearName()

public VpnTunnel.Builder clearName()

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? 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.

optional string name = 3373707;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VpnTunnel.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VpnTunnel.Builder
Overrides

clearPeerExternalGateway()

public VpnTunnel.Builder clearPeerExternalGateway()

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.

optional string peer_external_gateway = 384956173;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearPeerExternalGatewayInterface()

public VpnTunnel.Builder clearPeerExternalGatewayInterface()

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.

optional int32 peer_external_gateway_interface = 452768391;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearPeerGcpGateway()

public VpnTunnel.Builder clearPeerGcpGateway()

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.

optional string peer_gcp_gateway = 281867452;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearPeerIp()

public VpnTunnel.Builder clearPeerIp()

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearRegion()

public VpnTunnel.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearRemoteTrafficSelector()

public VpnTunnel.Builder clearRemoteTrafficSelector()

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.

repeated string remote_traffic_selector = 358887098;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearRouter()

public VpnTunnel.Builder clearRouter()

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearSelfLink()

public VpnTunnel.Builder clearSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearSharedSecret()

public VpnTunnel.Builder clearSharedSecret()

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearSharedSecretHash()

public VpnTunnel.Builder clearSharedSecretHash()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearStatus()

public VpnTunnel.Builder clearStatus()

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearTargetVpnGateway()

public VpnTunnel.Builder clearTargetVpnGateway()

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

optional string target_vpn_gateway = 532512843;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearVpnGateway()

public VpnTunnel.Builder clearVpnGateway()

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.

optional string vpn_gateway = 406684153;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clearVpnGatewayInterface()

public VpnTunnel.Builder clearVpnGatewayInterface()

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

optional int32 vpn_gateway_interface = 95979123;

Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

clone()

public VpnTunnel.Builder clone()
Returns
Type Description
VpnTunnel.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public VpnTunnel getDefaultInstanceForType()
Returns
Type Description
VpnTunnel

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetailedStatus()

public String getDetailedStatus()

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Returns
Type Description
String

The detailedStatus.

getDetailedStatusBytes()

public ByteString getDetailedStatusBytes()

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Returns
Type Description
ByteString

The bytes for detailedStatus.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getIkeVersion()

public int 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.

optional int32 ike_version = 218376220;

Returns
Type Description
int

The ikeVersion.

getKind()

public String getKind()

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLocalTrafficSelector(int index)

public String getLocalTrafficSelector(int index)

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.

repeated string local_traffic_selector = 317314613;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The localTrafficSelector at the given index.

getLocalTrafficSelectorBytes(int index)

public ByteString getLocalTrafficSelectorBytes(int index)

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.

repeated string local_traffic_selector = 317314613;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the localTrafficSelector at the given index.

getLocalTrafficSelectorCount()

public int getLocalTrafficSelectorCount()

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.

repeated string local_traffic_selector = 317314613;

Returns
Type Description
int

The count of localTrafficSelector.

getLocalTrafficSelectorList()

public ProtocolStringList 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.

repeated string local_traffic_selector = 317314613;

Returns
Type Description
ProtocolStringList

A list containing the localTrafficSelector.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

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.

optional string peer_external_gateway = 384956173;

Returns
Type Description
String

The peerExternalGateway.

getPeerExternalGatewayBytes()

public ByteString getPeerExternalGatewayBytes()

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.

optional string peer_external_gateway = 384956173;

Returns
Type Description
ByteString

The bytes for peerExternalGateway.

getPeerExternalGatewayInterface()

public int 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. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.

optional int32 peer_external_gateway_interface = 452768391;

Returns
Type Description
int

The peerExternalGatewayInterface.

getPeerGcpGateway()

public String getPeerGcpGateway()

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.

optional string peer_gcp_gateway = 281867452;

Returns
Type Description
String

The peerGcpGateway.

getPeerGcpGatewayBytes()

public ByteString getPeerGcpGatewayBytes()

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.

optional string peer_gcp_gateway = 281867452;

Returns
Type Description
ByteString

The bytes for peerGcpGateway.

getPeerIp()

public String getPeerIp()

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Returns
Type Description
String

The peerIp.

getPeerIpBytes()

public ByteString getPeerIpBytes()

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Returns
Type Description
ByteString

The bytes for peerIp.

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.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getRemoteTrafficSelector(int index)

public String getRemoteTrafficSelector(int index)

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.

repeated string remote_traffic_selector = 358887098;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The remoteTrafficSelector at the given index.

getRemoteTrafficSelectorBytes(int index)

public ByteString getRemoteTrafficSelectorBytes(int index)

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.

repeated string remote_traffic_selector = 358887098;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the remoteTrafficSelector at the given index.

getRemoteTrafficSelectorCount()

public int getRemoteTrafficSelectorCount()

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.

repeated string remote_traffic_selector = 358887098;

Returns
Type Description
int

The count of remoteTrafficSelector.

getRemoteTrafficSelectorList()

public ProtocolStringList 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.

repeated string remote_traffic_selector = 358887098;

Returns
Type Description
ProtocolStringList

A list containing the remoteTrafficSelector.

getRouter()

public String getRouter()

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Returns
Type Description
String

The router.

getRouterBytes()

public ByteString getRouterBytes()

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Returns
Type Description
ByteString

The bytes for router.

getSelfLink()

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSharedSecret()

public String getSharedSecret()

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Returns
Type Description
String

The sharedSecret.

getSharedSecretBytes()

public ByteString getSharedSecretBytes()

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Returns
Type Description
ByteString

The bytes for sharedSecret.

getSharedSecretHash()

public String getSharedSecretHash()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type Description
String

The sharedSecretHash.

getSharedSecretHashBytes()

public ByteString getSharedSecretHashBytes()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type Description
ByteString

The bytes for sharedSecretHash.

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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

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.

optional string target_vpn_gateway = 532512843;

Returns
Type Description
String

The targetVpnGateway.

getTargetVpnGatewayBytes()

public ByteString getTargetVpnGatewayBytes()

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

optional string target_vpn_gateway = 532512843;

Returns
Type Description
ByteString

The bytes for targetVpnGateway.

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.

optional string vpn_gateway = 406684153;

Returns
Type Description
String

The vpnGateway.

getVpnGatewayBytes()

public ByteString getVpnGatewayBytes()

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.

optional string vpn_gateway = 406684153;

Returns
Type Description
ByteString

The bytes for vpnGateway.

getVpnGatewayInterface()

public int getVpnGatewayInterface()

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

optional int32 vpn_gateway_interface = 95979123;

Returns
Type Description
int

The vpnGatewayInterface.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDetailedStatus()

public boolean hasDetailedStatus()

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Returns
Type Description
boolean

Whether the detailedStatus field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasIkeVersion()

public boolean hasIkeVersion()

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.

optional int32 ike_version = 218376220;

Returns
Type Description
boolean

Whether the ikeVersion field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasName()

public boolean hasName()

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? 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.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasPeerExternalGateway()

public boolean hasPeerExternalGateway()

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.

optional string peer_external_gateway = 384956173;

Returns
Type Description
boolean

Whether the peerExternalGateway field is set.

hasPeerExternalGatewayInterface()

public boolean hasPeerExternalGatewayInterface()

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.

optional int32 peer_external_gateway_interface = 452768391;

Returns
Type Description
boolean

Whether the peerExternalGatewayInterface field is set.

hasPeerGcpGateway()

public boolean hasPeerGcpGateway()

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.

optional string peer_gcp_gateway = 281867452;

Returns
Type Description
boolean

Whether the peerGcpGateway field is set.

hasPeerIp()

public boolean hasPeerIp()

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Returns
Type Description
boolean

Whether the peerIp field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasRouter()

public boolean hasRouter()

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Returns
Type Description
boolean

Whether the router field is set.

hasSelfLink()

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSharedSecret()

public boolean hasSharedSecret()

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Returns
Type Description
boolean

Whether the sharedSecret field is set.

hasSharedSecretHash()

public boolean hasSharedSecretHash()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type Description
boolean

Whether the sharedSecretHash field is set.

hasStatus()

public boolean hasStatus()

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasTargetVpnGateway()

public boolean hasTargetVpnGateway()

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

optional string target_vpn_gateway = 532512843;

Returns
Type Description
boolean

Whether the targetVpnGateway field is set.

hasVpnGateway()

public boolean hasVpnGateway()

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.

optional string vpn_gateway = 406684153;

Returns
Type Description
boolean

Whether the vpnGateway field is set.

hasVpnGatewayInterface()

public boolean hasVpnGatewayInterface()

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

optional int32 vpn_gateway_interface = 95979123;

Returns
Type Description
boolean

Whether the vpnGatewayInterface field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VpnTunnel other)

public VpnTunnel.Builder mergeFrom(VpnTunnel other)
Parameter
Name Description
other VpnTunnel
Returns
Type Description
VpnTunnel.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VpnTunnel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VpnTunnel.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VpnTunnel.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VpnTunnel.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VpnTunnel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VpnTunnel.Builder
Overrides

putAllLabels(Map<String,String> values)

public VpnTunnel.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
VpnTunnel.Builder

putLabels(String key, String value)

public VpnTunnel.Builder putLabels(String key, String value)

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.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
value String
Returns
Type Description
VpnTunnel.Builder

removeLabels(String key)

public VpnTunnel.Builder removeLabels(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
VpnTunnel.Builder

setCreationTimestamp(String value)

public VpnTunnel.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public VpnTunnel.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setDescription(String value)

public VpnTunnel.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public VpnTunnel.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setDetailedStatus(String value)

public VpnTunnel.Builder setDetailedStatus(String value)

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Parameter
Name Description
value String

The detailedStatus to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setDetailedStatusBytes(ByteString value)

public VpnTunnel.Builder setDetailedStatusBytes(ByteString value)

[Output Only] Detailed status message for the VPN tunnel.

optional string detailed_status = 333501025;

Parameter
Name Description
value ByteString

The bytes for detailedStatus to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VpnTunnel.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VpnTunnel.Builder
Overrides

setId(long value)

public VpnTunnel.Builder setId(long value)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setIkeVersion(int value)

public VpnTunnel.Builder setIkeVersion(int value)

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.

optional int32 ike_version = 218376220;

Parameter
Name Description
value int

The ikeVersion to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setKind(String value)

public VpnTunnel.Builder setKind(String value)

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setKindBytes(ByteString value)

public VpnTunnel.Builder setKindBytes(ByteString value)

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setLabelFingerprint(String value)

public VpnTunnel.Builder setLabelFingerprint(String value)

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.

optional string label_fingerprint = 178124825;

Parameter
Name Description
value String

The labelFingerprint to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public VpnTunnel.Builder setLabelFingerprintBytes(ByteString value)

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.

optional string label_fingerprint = 178124825;

Parameter
Name Description
value ByteString

The bytes for labelFingerprint to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setLocalTrafficSelector(int index, String value)

public VpnTunnel.Builder setLocalTrafficSelector(int index, String value)

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.

repeated string local_traffic_selector = 317314613;

Parameters
Name Description
index int

The index to set the value at.
value String

The localTrafficSelector to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setName(String value)

public VpnTunnel.Builder setName(String value)

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? 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.

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setNameBytes(ByteString value)

public VpnTunnel.Builder setNameBytes(ByteString value)

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? 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.

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerExternalGateway(String value)

public VpnTunnel.Builder setPeerExternalGateway(String value)

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.

optional string peer_external_gateway = 384956173;

Parameter
Name Description
value String

The peerExternalGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerExternalGatewayBytes(ByteString value)

public VpnTunnel.Builder setPeerExternalGatewayBytes(ByteString value)

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.

optional string peer_external_gateway = 384956173;

Parameter
Name Description
value ByteString

The bytes for peerExternalGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerExternalGatewayInterface(int value)

public VpnTunnel.Builder setPeerExternalGatewayInterface(int value)

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.

optional int32 peer_external_gateway_interface = 452768391;

Parameter
Name Description
value int

The peerExternalGatewayInterface to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerGcpGateway(String value)

public VpnTunnel.Builder setPeerGcpGateway(String value)

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.

optional string peer_gcp_gateway = 281867452;

Parameter
Name Description
value String

The peerGcpGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerGcpGatewayBytes(ByteString value)

public VpnTunnel.Builder setPeerGcpGatewayBytes(ByteString value)

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.

optional string peer_gcp_gateway = 281867452;

Parameter
Name Description
value ByteString

The bytes for peerGcpGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerIp(String value)

public VpnTunnel.Builder setPeerIp(String value)

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Parameter
Name Description
value String

The peerIp to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setPeerIpBytes(ByteString value)

public VpnTunnel.Builder setPeerIpBytes(ByteString value)

IP address of the peer VPN gateway. Only IPv4 is supported.

optional string peer_ip = 383249700;

Parameter
Name Description
value ByteString

The bytes for peerIp to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setRegion(String value)

public VpnTunnel.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public VpnTunnel.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setRemoteTrafficSelector(int index, String value)

public VpnTunnel.Builder setRemoteTrafficSelector(int index, String value)

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.

repeated string remote_traffic_selector = 358887098;

Parameters
Name Description
index int

The index to set the value at.
value String

The remoteTrafficSelector to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public VpnTunnel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VpnTunnel.Builder
Overrides

setRouter(String value)

public VpnTunnel.Builder setRouter(String value)

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Parameter
Name Description
value String

The router to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setRouterBytes(ByteString value)

public VpnTunnel.Builder setRouterBytes(ByteString value)

URL of the router resource to be used for dynamic routing.

optional string router = 148608841;

Parameter
Name Description
value ByteString

The bytes for router to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSelfLink(String value)

public VpnTunnel.Builder setSelfLink(String value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public VpnTunnel.Builder setSelfLinkBytes(ByteString value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSharedSecret(String value)

public VpnTunnel.Builder setSharedSecret(String value)

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Parameter
Name Description
value String

The sharedSecret to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSharedSecretBytes(ByteString value)

public VpnTunnel.Builder setSharedSecretBytes(ByteString value)

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

optional string shared_secret = 381932490;

Parameter
Name Description
value ByteString

The bytes for sharedSecret to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSharedSecretHash(String value)

public VpnTunnel.Builder setSharedSecretHash(String value)

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Parameter
Name Description
value String

The sharedSecretHash to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setSharedSecretHashBytes(ByteString value)

public VpnTunnel.Builder setSharedSecretHashBytes(ByteString value)

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Parameter
Name Description
value ByteString

The bytes for sharedSecretHash to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setStatus(String value)

public VpnTunnel.Builder setStatus(String value)

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
Name Description
value String

The status to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setStatusBytes(ByteString value)

public VpnTunnel.Builder setStatusBytes(ByteString value)

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Parameter
Name Description
value ByteString

The bytes for status to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setTargetVpnGateway(String value)

public VpnTunnel.Builder setTargetVpnGateway(String value)

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

optional string target_vpn_gateway = 532512843;

Parameter
Name Description
value String

The targetVpnGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setTargetVpnGatewayBytes(ByteString value)

public VpnTunnel.Builder setTargetVpnGatewayBytes(ByteString value)

URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.

optional string target_vpn_gateway = 532512843;

Parameter
Name Description
value ByteString

The bytes for targetVpnGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VpnTunnel.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VpnTunnel.Builder
Overrides

setVpnGateway(String value)

public VpnTunnel.Builder setVpnGateway(String value)

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.

optional string vpn_gateway = 406684153;

Parameter
Name Description
value String

The vpnGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setVpnGatewayBytes(ByteString value)

public VpnTunnel.Builder setVpnGatewayBytes(ByteString value)

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.

optional string vpn_gateway = 406684153;

Parameter
Name Description
value ByteString

The bytes for vpnGateway to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.

setVpnGatewayInterface(int value)

public VpnTunnel.Builder setVpnGatewayInterface(int value)

The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

optional int32 vpn_gateway_interface = 95979123;

Parameter
Name Description
value int

The vpnGatewayInterface to set.
Returns
Type Description
VpnTunnel.Builder

This builder for chaining.