Class: Google::Cloud::Compute::V1::VpnTunnel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

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

Defined Under Namespace

Modules: Status Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#cipher_suite ⇒ ::Google::Cloud::Compute::V1::VpnTunnelCipherSuite

Returns User specified list of ciphers to use for the phase 1 and phase 2 of the IKE protocol.

Returns:



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#creation_timestamp ⇒ ::String

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

  • (::String) —

    [Output Only] Creation timestamp in RFC3339 text format.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#description ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#detailed_status ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#id ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#ike_version ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#kind ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#label_fingerprint ⇒ ::String

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

Returns:

  • (::String) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#local_traffic_selector ⇒ ::Array<::String>

Returns 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 for Classic VPN tunnels. This field is output only for HA VPN tunnels.

Returns:

  • (::Array<::String>) —

    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 for Classic VPN tunnels. This field is output only for HA VPN tunnels.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#peer_external_gateway ⇒ ::String

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

Returns:

  • (::String) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#peer_external_gateway_interface ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#peer_gcp_gateway ⇒ ::String

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

Returns:

  • (::String) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#peer_ip ⇒ ::String

Returns IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.

Returns:

  • (::String) —

    IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#region ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#remote_traffic_selector ⇒ ::Array<::String>

Returns 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 for Classic VPN tunnels. This field is output only for HA VPN tunnels.

Returns:

  • (::Array<::String>) —

    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 for Classic VPN tunnels. This field is output only for HA VPN tunnels.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#router ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#self_link ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#shared_secret ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#shared_secret_hash ⇒ ::String

Returns Hash of the shared secret.

Returns:

  • (::String) —

    Hash of the shared secret.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#status ⇒ ::String

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

Returns:

  • (::String) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#target_vpn_gateway ⇒ ::String

Returns URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.

Returns:

  • (::String) —

    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#vpn_gateway ⇒ ::String

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

Returns:

  • (::String) —

    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.



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end

#vpn_gateway_interface ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
40869
40870
40871
40872
40873
40874
40875
40876
40877
40878
40879
40880
40881
40882
40883
40884
40885
40886
40887
40888
40889
40890
40891
40892
40893
40894
40895
40896
40897
40898
40899
40900
40901
40902
40903
40904
40905
40906
40907
40908
40909
40910
40911
40912
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 40855

class VpnTunnel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [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.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Cloud VPN is in the process of allocating all required resources (specifically, a borg task).
    ALLOCATING_RESOURCES = 320_922_816

    # Auth error (e.g. bad shared secret).
    AUTHORIZATION_ERROR = 23_580_290

    # Resources is being deallocated for the VPN tunnel.
    DEPROVISIONING = 428_935_662

    # Secure session is successfully established with peer VPN.
    ESTABLISHED = 88_852_344

    # Tunnel creation has failed and the tunnel is not ready to be used.
    FAILED = 455_706_685

    # Successful first handshake with peer VPN.
    FIRST_HANDSHAKE = 191_393_000

    # Handshake failed.
    NEGOTIATION_FAILURE = 360_325_868

    # Deprecated, replaced by NO_INCOMING_PACKETS
    NETWORK_ERROR = 193_912_951

    # No incoming packets from peer
    NO_INCOMING_PACKETS = 119_983_216

    # Resource is being allocated for the VPN tunnel.
    PROVISIONING = 290_896_621

    # Tunnel configuration was rejected, can be result of being denylisted.
    REJECTED = 174_130_302

    # Tunnel is stopped due to its Forwarding Rules being deleted.
    STOPPED = 444_276_141

    # Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel.
    WAITING_FOR_FULL_CONFIG = 41_640_522
  end
end