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.
46016 46017 46018 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 46016 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
45847 45848 45849 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45847 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
45853 45854 45855 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45853 def description @description end |
#detailed_status ⇒ String
[Output Only] Detailed status message for the VPN tunnel.
Corresponds to the JSON property detailedStatus
45858 45859 45860 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45858 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
45864 45865 45866 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45864 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
45870 45871 45872 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45870 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
45875 45876 45877 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45875 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.
45887 45888 45889 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45887 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
45894 45895 45896 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45894 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
45901 45902 45903 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45901 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
45911 45912 45913 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45911 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
45918 45919 45920 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45918 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
45924 45925 45926 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45924 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
45934 45935 45936 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45934 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
45939 45940 45941 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45939 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
45946 45947 45948 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45946 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
45953 45954 45955 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45953 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
45958 45959 45960 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45958 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
45963 45964 45965 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45963 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
45969 45970 45971 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45969 def shared_secret @shared_secret end |
#shared_secret_hash ⇒ String
Hash of the shared secret.
Corresponds to the JSON property sharedSecretHash
45974 45975 45976 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45974 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
45996 45997 45998 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 45996 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
46002 46003 46004 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 46002 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
46009 46010 46011 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 46009 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
46014 46015 46016 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 46014 def vpn_gateway_interface @vpn_gateway_interface end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
46021 46022 46023 46024 46025 46026 46027 46028 46029 46030 46031 46032 46033 46034 46035 46036 46037 46038 46039 46040 46041 46042 46043 46044 46045 46046 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 46021 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 |