Class VpnTunnel

  • All Implemented Interfaces:
    VpnTunnelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class VpnTunnel
    extends com.google.protobuf.GeneratedMessageV3
    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
    See Also:
    Serialized Form
    • Field Detail

      • CREATION_TIMESTAMP_FIELD_NUMBER

        public static final int CREATION_TIMESTAMP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DETAILED_STATUS_FIELD_NUMBER

        public static final int DETAILED_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IKE_VERSION_FIELD_NUMBER

        public static final int IKE_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LABEL_FINGERPRINT_FIELD_NUMBER

        public static final int LABEL_FINGERPRINT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LOCAL_TRAFFIC_SELECTOR_FIELD_NUMBER

        public static final int LOCAL_TRAFFIC_SELECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PEER_EXTERNAL_GATEWAY_FIELD_NUMBER

        public static final int PEER_EXTERNAL_GATEWAY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PEER_EXTERNAL_GATEWAY_INTERFACE_FIELD_NUMBER

        public static final int PEER_EXTERNAL_GATEWAY_INTERFACE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PEER_GCP_GATEWAY_FIELD_NUMBER

        public static final int PEER_GCP_GATEWAY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REMOTE_TRAFFIC_SELECTOR_FIELD_NUMBER

        public static final int REMOTE_TRAFFIC_SELECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHARED_SECRET_FIELD_NUMBER

        public static final int SHARED_SECRET_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHARED_SECRET_HASH_FIELD_NUMBER

        public static final int SHARED_SECRET_HASH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TARGET_VPN_GATEWAY_FIELD_NUMBER

        public static final int TARGET_VPN_GATEWAY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • VPN_GATEWAY_FIELD_NUMBER

        public static final int VPN_GATEWAY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • VPN_GATEWAY_INTERFACE_FIELD_NUMBER

        public static final int VPN_GATEWAY_INTERFACE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface VpnTunnelOrBuilder
        Returns:
        Whether the creationTimestamp field is set.
      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface VpnTunnelOrBuilder
        Returns:
        The creationTimestamp.
      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for creationTimestamp.
      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        hasDescription in interface VpnTunnelOrBuilder
        Returns:
        Whether the description field is set.
      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescription in interface VpnTunnelOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for description.
      • hasDetailedStatus

        public boolean hasDetailedStatus()
         [Output Only] Detailed status message for the VPN tunnel.
         
        optional string detailed_status = 333501025;
        Specified by:
        hasDetailedStatus in interface VpnTunnelOrBuilder
        Returns:
        Whether the detailedStatus field is set.
      • getDetailedStatus

        public String getDetailedStatus()
         [Output Only] Detailed status message for the VPN tunnel.
         
        optional string detailed_status = 333501025;
        Specified by:
        getDetailedStatus in interface VpnTunnelOrBuilder
        Returns:
        The detailedStatus.
      • getDetailedStatusBytes

        public com.google.protobuf.ByteString getDetailedStatusBytes()
         [Output Only] Detailed status message for the VPN tunnel.
         
        optional string detailed_status = 333501025;
        Specified by:
        getDetailedStatusBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for detailedStatus.
      • hasId

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        hasId in interface VpnTunnelOrBuilder
        Returns:
        Whether the id field is set.
      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        getId in interface VpnTunnelOrBuilder
        Returns:
        The id.
      • 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;
        Specified by:
        hasIkeVersion in interface VpnTunnelOrBuilder
        Returns:
        Whether the ikeVersion field is set.
      • 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;
        Specified by:
        getIkeVersion in interface VpnTunnelOrBuilder
        Returns:
        The ikeVersion.
      • hasKind

        public boolean hasKind()
         [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
         
        optional string kind = 3292052;
        Specified by:
        hasKind in interface VpnTunnelOrBuilder
        Returns:
        Whether the kind field is set.
      • getKind

        public String getKind()
         [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
         
        optional string kind = 3292052;
        Specified by:
        getKind in interface VpnTunnelOrBuilder
        Returns:
        The kind.
      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
         
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for kind.
      • 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;
        Specified by:
        hasLabelFingerprint in interface VpnTunnelOrBuilder
        Returns:
        Whether the labelFingerprint field is set.
      • 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;
        Specified by:
        getLabelFingerprint in interface VpnTunnelOrBuilder
        Returns:
        The labelFingerprint.
      • getLabelFingerprintBytes

        public com.google.protobuf.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;
        Specified by:
        getLabelFingerprintBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for labelFingerprint.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: VpnTunnelOrBuilder
         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;
        Specified by:
        getLabelsCount in interface VpnTunnelOrBuilder
      • containsLabels

        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;
        Specified by:
        containsLabels in interface VpnTunnelOrBuilder
      • 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;
        Specified by:
        getLabelsMap in interface VpnTunnelOrBuilder
      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface VpnTunnelOrBuilder
      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface VpnTunnelOrBuilder
      • getLocalTrafficSelectorList

        public com.google.protobuf.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;
        Specified by:
        getLocalTrafficSelectorList in interface VpnTunnelOrBuilder
        Returns:
        A list containing the localTrafficSelector.
      • 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;
        Specified by:
        getLocalTrafficSelectorCount in interface VpnTunnelOrBuilder
        Returns:
        The count of localTrafficSelector.
      • getLocalTrafficSelector

        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;
        Specified by:
        getLocalTrafficSelector in interface VpnTunnelOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The localTrafficSelector at the given index.
      • getLocalTrafficSelectorBytes

        public com.google.protobuf.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;
        Specified by:
        getLocalTrafficSelectorBytes in interface VpnTunnelOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the localTrafficSelector at the given index.
      • 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]([-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.
         
        optional string name = 3373707;
        Specified by:
        hasName in interface VpnTunnelOrBuilder
        Returns:
        Whether the name field is set.
      • 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.
         
        optional string name = 3373707;
        Specified by:
        getName in interface VpnTunnelOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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]([-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.
         
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for name.
      • 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;
        Specified by:
        hasPeerExternalGateway in interface VpnTunnelOrBuilder
        Returns:
        Whether the peerExternalGateway field is set.
      • 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;
        Specified by:
        getPeerExternalGateway in interface VpnTunnelOrBuilder
        Returns:
        The peerExternalGateway.
      • getPeerExternalGatewayBytes

        public com.google.protobuf.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;
        Specified by:
        getPeerExternalGatewayBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for peerExternalGateway.
      • 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;
        Specified by:
        hasPeerExternalGatewayInterface in interface VpnTunnelOrBuilder
        Returns:
        Whether the peerExternalGatewayInterface field is set.
      • 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;
        Specified by:
        getPeerExternalGatewayInterface in interface VpnTunnelOrBuilder
        Returns:
        The peerExternalGatewayInterface.
      • hasPeerGcpGateway

        public boolean hasPeerGcpGateway()
         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;
        Specified by:
        hasPeerGcpGateway in interface VpnTunnelOrBuilder
        Returns:
        Whether the peerGcpGateway field is set.
      • 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.
         
        optional string peer_gcp_gateway = 281867452;
        Specified by:
        getPeerGcpGateway in interface VpnTunnelOrBuilder
        Returns:
        The peerGcpGateway.
      • getPeerGcpGatewayBytes

        public com.google.protobuf.ByteString getPeerGcpGatewayBytes()
         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;
        Specified by:
        getPeerGcpGatewayBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for peerGcpGateway.
      • hasPeerIp

        public boolean hasPeerIp()
         IP address of the peer VPN gateway. Only IPv4 is supported.
         
        optional string peer_ip = 383249700;
        Specified by:
        hasPeerIp in interface VpnTunnelOrBuilder
        Returns:
        Whether the peerIp field is set.
      • getPeerIp

        public String getPeerIp()
         IP address of the peer VPN gateway. Only IPv4 is supported.
         
        optional string peer_ip = 383249700;
        Specified by:
        getPeerIp in interface VpnTunnelOrBuilder
        Returns:
        The peerIp.
      • getPeerIpBytes

        public com.google.protobuf.ByteString getPeerIpBytes()
         IP address of the peer VPN gateway. Only IPv4 is supported.
         
        optional string peer_ip = 383249700;
        Specified by:
        getPeerIpBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for peerIp.
      • 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;
        Specified by:
        hasRegion in interface VpnTunnelOrBuilder
        Returns:
        Whether the region field is set.
      • 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;
        Specified by:
        getRegion in interface VpnTunnelOrBuilder
        Returns:
        The region.
      • getRegionBytes

        public com.google.protobuf.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;
        Specified by:
        getRegionBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for region.
      • getRemoteTrafficSelectorList

        public com.google.protobuf.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;
        Specified by:
        getRemoteTrafficSelectorList in interface VpnTunnelOrBuilder
        Returns:
        A list containing the remoteTrafficSelector.
      • 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;
        Specified by:
        getRemoteTrafficSelectorCount in interface VpnTunnelOrBuilder
        Returns:
        The count of remoteTrafficSelector.
      • getRemoteTrafficSelector

        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;
        Specified by:
        getRemoteTrafficSelector in interface VpnTunnelOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The remoteTrafficSelector at the given index.
      • getRemoteTrafficSelectorBytes

        public com.google.protobuf.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;
        Specified by:
        getRemoteTrafficSelectorBytes in interface VpnTunnelOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the remoteTrafficSelector at the given index.
      • hasRouter

        public boolean hasRouter()
         URL of the router resource to be used for dynamic routing.
         
        optional string router = 148608841;
        Specified by:
        hasRouter in interface VpnTunnelOrBuilder
        Returns:
        Whether the router field is set.
      • getRouter

        public String getRouter()
         URL of the router resource to be used for dynamic routing.
         
        optional string router = 148608841;
        Specified by:
        getRouter in interface VpnTunnelOrBuilder
        Returns:
        The router.
      • getRouterBytes

        public com.google.protobuf.ByteString getRouterBytes()
         URL of the router resource to be used for dynamic routing.
         
        optional string router = 148608841;
        Specified by:
        getRouterBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for router.
      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface VpnTunnelOrBuilder
        Returns:
        Whether the selfLink field is set.
      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface VpnTunnelOrBuilder
        Returns:
        The selfLink.
      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for selfLink.
      • 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;
        Specified by:
        hasSharedSecret in interface VpnTunnelOrBuilder
        Returns:
        Whether the sharedSecret field is set.
      • 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;
        Specified by:
        getSharedSecret in interface VpnTunnelOrBuilder
        Returns:
        The sharedSecret.
      • getSharedSecretBytes

        public com.google.protobuf.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;
        Specified by:
        getSharedSecretBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for sharedSecret.
      • hasSharedSecretHash

        public boolean hasSharedSecretHash()
         Hash of the shared secret.
         
        optional string shared_secret_hash = 398881891;
        Specified by:
        hasSharedSecretHash in interface VpnTunnelOrBuilder
        Returns:
        Whether the sharedSecretHash field is set.
      • getSharedSecretHash

        public String getSharedSecretHash()
         Hash of the shared secret.
         
        optional string shared_secret_hash = 398881891;
        Specified by:
        getSharedSecretHash in interface VpnTunnelOrBuilder
        Returns:
        The sharedSecretHash.
      • getSharedSecretHashBytes

        public com.google.protobuf.ByteString getSharedSecretHashBytes()
         Hash of the shared secret.
         
        optional string shared_secret_hash = 398881891;
        Specified by:
        getSharedSecretHashBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for sharedSecretHash.
      • 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;
        Specified by:
        hasStatus in interface VpnTunnelOrBuilder
        Returns:
        Whether the status field is set.
      • 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;
        Specified by:
        getStatus in interface VpnTunnelOrBuilder
        Returns:
        The status.
      • getStatusBytes

        public com.google.protobuf.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;
        Specified by:
        getStatusBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for status.
      • 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;
        Specified by:
        hasTargetVpnGateway in interface VpnTunnelOrBuilder
        Returns:
        Whether the targetVpnGateway field is set.
      • 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;
        Specified by:
        getTargetVpnGateway in interface VpnTunnelOrBuilder
        Returns:
        The targetVpnGateway.
      • getTargetVpnGatewayBytes

        public com.google.protobuf.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;
        Specified by:
        getTargetVpnGatewayBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for targetVpnGateway.
      • 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;
        Specified by:
        hasVpnGateway in interface VpnTunnelOrBuilder
        Returns:
        Whether the vpnGateway field is set.
      • 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;
        Specified by:
        getVpnGateway in interface VpnTunnelOrBuilder
        Returns:
        The vpnGateway.
      • getVpnGatewayBytes

        public com.google.protobuf.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;
        Specified by:
        getVpnGatewayBytes in interface VpnTunnelOrBuilder
        Returns:
        The bytes for vpnGateway.
      • 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;
        Specified by:
        hasVpnGatewayInterface in interface VpnTunnelOrBuilder
        Returns:
        Whether the vpnGatewayInterface field is set.
      • 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;
        Specified by:
        getVpnGatewayInterface in interface VpnTunnelOrBuilder
        Returns:
        The vpnGatewayInterface.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static VpnTunnel parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static VpnTunnel parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException
      • newBuilderForType

        public VpnTunnel.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public VpnTunnel.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected VpnTunnel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static VpnTunnel getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<VpnTunnel> parser()
      • getParserForType

        public com.google.protobuf.Parser<VpnTunnel> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public VpnTunnel getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder