Interface VpnTunnelOrBuilder (1.23.0)

public interface VpnTunnelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`String`	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`ByteString`	The bytes for creationTimestamp.

getDescription()

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

getDetailedStatus()

public abstract String getDetailedStatus()

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

optional string detailed_status = 333501025;

Returns
Type	Description
`String`	The detailedStatus.

getDetailedStatusBytes()

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

getLocalTrafficSelector(int index)

public abstract 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 abstract ByteString getLocalTrafficSelectorBytes(int index)

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 abstract int getLocalTrafficSelectorCount()

repeated string local_traffic_selector = 317314613;

Returns
Type	Description
`int`	The count of localTrafficSelector.

getLocalTrafficSelectorList()

public abstract List<String> getLocalTrafficSelectorList()

repeated string local_traffic_selector = 317314613;

Returns
Type	Description
`List<String>`	A list containing the localTrafficSelector.

getName()

public abstract 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 abstract ByteString getNameBytes()

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getPeerExternalGateway()

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

optional string peer_gcp_gateway = 281867452;

Returns
Type	Description
`String`	The peerGcpGateway.

getPeerGcpGatewayBytes()

public abstract ByteString getPeerGcpGatewayBytes()

optional string peer_gcp_gateway = 281867452;

Returns
Type	Description
`ByteString`	The bytes for peerGcpGateway.

getPeerIp()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getRemoteTrafficSelectorBytes(int index)

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 abstract int getRemoteTrafficSelectorCount()

repeated string remote_traffic_selector = 358887098;

Returns
Type	Description
`int`	The count of remoteTrafficSelector.

getRemoteTrafficSelectorList()

public abstract List<String> getRemoteTrafficSelectorList()

repeated string remote_traffic_selector = 358887098;

Returns
Type	Description
`List<String>`	A list containing the remoteTrafficSelector.

getRouter()

public abstract 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 abstract 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 abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
`String`	The selfLink.

getSelfLinkBytes()

public abstract 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 abstract 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 abstract 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 abstract String getSharedSecretHash()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type	Description
`String`	The sharedSecretHash.

getSharedSecretHashBytes()

public abstract ByteString getSharedSecretHashBytes()

Hash of the shared secret.

optional string shared_secret_hash = 398881891;

Returns
Type	Description
`ByteString`	The bytes for sharedSecretHash.

getStatus()

public abstract 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 abstract ByteString getStatusBytes()

optional string status = 181260274;

Returns
Type	Description
`ByteString`	The bytes for status.

getTargetVpnGateway()

public abstract 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 abstract 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 abstract 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 abstract ByteString getVpnGatewayBytes()

optional string vpn_gateway = 406684153;

Returns
Type	Description
`ByteString`	The bytes for vpnGateway.

getVpnGatewayInterface()

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

hasName()

public abstract boolean hasName()

optional string name = 3373707;

Returns
Type	Description
`boolean`	Whether the name field is set.

hasPeerExternalGateway()

public abstract 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 abstract boolean hasPeerExternalGatewayInterface()

optional int32 peer_external_gateway_interface = 452768391;

Returns
Type	Description
`boolean`	Whether the peerExternalGatewayInterface field is set.

hasPeerGcpGateway()

public abstract boolean hasPeerGcpGateway()

optional string peer_gcp_gateway = 281867452;

Returns
Type	Description
`boolean`	Whether the peerGcpGateway field is set.

hasPeerIp()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasStatus()

optional string status = 181260274;

Returns
Type	Description
`boolean`	Whether the status field is set.

hasTargetVpnGateway()

public abstract 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 abstract boolean hasVpnGateway()

optional string vpn_gateway = 406684153;

Returns
Type	Description
`boolean`	Whether the vpnGateway field is set.

hasVpnGatewayInterface()

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