Class: Google::Apis::ComputeAlpha::VpnTunnel
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::VpnTunnel
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#detailed_status ⇒ String
[Output Only] Detailed status message for the VPN tunnel.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ike_version ⇒ Fixnum
IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway.
-
#kind ⇒ String
[Output Only] Type of resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels for this resource.
-
#local_traffic_selector ⇒ Array<String>
Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway.
-
#name ⇒ String
Name of the resource.
-
#peer_external_gateway ⇒ String
URL of the peer side external VPN gateway to which this VPN tunnel is connected.
-
#peer_external_gateway_interface ⇒ Fixnum
The interface ID of the external VPN gateway to which this VPN tunnel is connected.
-
#peer_gcp_gateway ⇒ String
URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
-
#peer_ip ⇒ String
IP address of the peer VPN gateway.
-
#region ⇒ String
[Output Only] URL of the region where the VPN tunnel resides.
-
#remote_traffic_selector ⇒ Array<String>
Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway.
-
#router ⇒ String
URL of the router resource to be used for dynamic routing.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#shared_secret ⇒ String
Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
-
#shared_secret_hash ⇒ String
Hash of the shared secret.
-
#status ⇒ 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.
-
#target_vpn_gateway ⇒ String
URL of the Target VPN gateway with which this VPN tunnel is associated.
-
#vpn_gateway ⇒ String
URL of the VPN gateway with which this VPN tunnel is associated.
-
#vpn_gateway_interface ⇒ Fixnum
The interface ID of the VPN gateway with which this VPN tunnel is associated.
Instance Method Summary collapse
-
#initialize(**args) ⇒ VpnTunnel
constructor
A new instance of VpnTunnel.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ VpnTunnel
Returns a new instance of VpnTunnel.
47748 47749 47750 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47748 def initialize(**args) update!(**args) end |
Instance Attribute Details
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
47579 47580 47581 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47579 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
47585 47586 47587 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47585 def description @description end |
#detailed_status ⇒ String
[Output Only] Detailed status message for the VPN tunnel.
Corresponds to the JSON property detailedStatus
47590 47591 47592 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47590 def detailed_status @detailed_status end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
47596 47597 47598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47596 def id @id end |
#ike_version ⇒ Fixnum
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.
Corresponds to the JSON property ikeVersion
47602 47603 47604 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47602 def ike_version @ike_version end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Corresponds to the JSON property kind
47607 47608 47609 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47607 def kind @kind end |
#label_fingerprint ⇒ 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.
Corresponds to the JSON property labelFingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
47619 47620 47621 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47619 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<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.
Corresponds to the JSON property labels
47626 47627 47628 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47626 def labels @labels end |
#local_traffic_selector ⇒ 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.
Corresponds to the JSON property localTrafficSelector
47633 47634 47635 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47633 def local_traffic_selector @local_traffic_selector end |
#name ⇒ 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.
Corresponds to the JSON property name
47643 47644 47645 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47643 def name @name end |
#peer_external_gateway ⇒ 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.
Corresponds to the JSON property peerExternalGateway
47650 47651 47652 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47650 def peer_external_gateway @peer_external_gateway end |
#peer_external_gateway_interface ⇒ Fixnum
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.
Corresponds to the JSON property peerExternalGatewayInterface
47656 47657 47658 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47656 def peer_external_gateway_interface @peer_external_gateway_interface end |
#peer_gcp_gateway ⇒ String
URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
Provided by the client when the VPN tunnel is created. This field can be used
when creating highly available VPN from VPC network to VPC network, the field
is exclusive with the field peerExternalGateway. If provided, the VPN tunnel
will automatically use the same vpnGatewayInterface ID in the peer GCP VPN
gateway.
Corresponds to the JSON property peerGcpGateway
47666 47667 47668 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47666 def peer_gcp_gateway @peer_gcp_gateway end |
#peer_ip ⇒ String
IP address of the peer VPN gateway. Only IPv4 is supported.
Corresponds to the JSON property peerIp
47671 47672 47673 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47671 def peer_ip @peer_ip end |
#region ⇒ 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.
Corresponds to the JSON property region
47678 47679 47680 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47678 def region @region end |
#remote_traffic_selector ⇒ 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.
Corresponds to the JSON property remoteTrafficSelector
47685 47686 47687 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47685 def remote_traffic_selector @remote_traffic_selector end |
#router ⇒ String
URL of the router resource to be used for dynamic routing.
Corresponds to the JSON property router
47690 47691 47692 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47690 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
47695 47696 47697 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47695 def self_link @self_link end |
#shared_secret ⇒ String
Shared secret used to set the secure session between the Cloud VPN gateway and
the peer VPN gateway.
Corresponds to the JSON property sharedSecret
47701 47702 47703 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47701 def shared_secret @shared_secret end |
#shared_secret_hash ⇒ String
Hash of the shared secret.
Corresponds to the JSON property sharedSecretHash
47706 47707 47708 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47706 def shared_secret_hash @shared_secret_hash end |
#status ⇒ 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.
Corresponds to the JSON property
status
47728 47729 47730 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47728 def status @status end |
#target_vpn_gateway ⇒ String
URL of the Target VPN gateway with which this VPN tunnel is associated.
Provided by the client when the VPN tunnel is created.
Corresponds to the JSON property targetVpnGateway
47734 47735 47736 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47734 def target_vpn_gateway @target_vpn_gateway end |
#vpn_gateway ⇒ 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.
Corresponds to the JSON property vpnGateway
47741 47742 47743 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47741 def vpn_gateway @vpn_gateway end |
#vpn_gateway_interface ⇒ Fixnum
The interface ID of the VPN gateway with which this VPN tunnel is associated.
Corresponds to the JSON property vpnGatewayInterface
47746 47747 47748 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47746 def vpn_gateway_interface @vpn_gateway_interface end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
47753 47754 47755 47756 47757 47758 47759 47760 47761 47762 47763 47764 47765 47766 47767 47768 47769 47770 47771 47772 47773 47774 47775 47776 47777 47778 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47753 def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @detailed_status = args[:detailed_status] if args.key?(:detailed_status) @id = args[:id] if args.key?(:id) @ike_version = args[:ike_version] if args.key?(:ike_version) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @local_traffic_selector = args[:local_traffic_selector] if args.key?(:local_traffic_selector) @name = args[:name] if args.key?(:name) @peer_external_gateway = args[:peer_external_gateway] if args.key?(:peer_external_gateway) @peer_external_gateway_interface = args[:peer_external_gateway_interface] if args.key?(:peer_external_gateway_interface) @peer_gcp_gateway = args[:peer_gcp_gateway] if args.key?(:peer_gcp_gateway) @peer_ip = args[:peer_ip] if args.key?(:peer_ip) @region = args[:region] if args.key?(:region) @remote_traffic_selector = args[:remote_traffic_selector] if args.key?(:remote_traffic_selector) @router = args[:router] if args.key?(:router) @self_link = args[:self_link] if args.key?(:self_link) @shared_secret = args[:shared_secret] if args.key?(:shared_secret) @shared_secret_hash = args[:shared_secret_hash] if args.key?(:shared_secret_hash) @status = args[:status] if args.key?(:status) @target_vpn_gateway = args[:target_vpn_gateway] if args.key?(:target_vpn_gateway) @vpn_gateway = args[:vpn_gateway] if args.key?(:vpn_gateway) @vpn_gateway_interface = args[:vpn_gateway_interface] if args.key?(:vpn_gateway_interface) end |