Class: Google::Apis::ComputeAlpha::VpnTunnel
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::VpnTunnel
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Cloud VPN Tunnel resource.
For more information about VPN, read the the Cloud VPN Overview. (==
resource_for $api_version
.vpnTunnels ==)
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 to apply to this VpnTunnel.
-
#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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ VpnTunnel
Returns a new instance of VpnTunnel.
38355 38356 38357 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38355 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
38181 38182 38183 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38181 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
38187 38188 38189 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38187 def description @description end |
#detailed_status ⇒ String
[Output Only] Detailed status message for the VPN tunnel.
Corresponds to the JSON property detailedStatus
38192 38193 38194 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38192 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
38198 38199 38200 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38198 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
38204 38205 38206 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38204 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
38209 38210 38211 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38209 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.
38221 38222 38223 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38221 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels to apply to this VpnTunnel. These can be later 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
38228 38229 38230 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38228 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
38235 38236 38237 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38235 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
38245 38246 38247 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38245 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
38252 38253 38254 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38252 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
38258 38259 38260 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38258 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
38268 38269 38270 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38268 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
38273 38274 38275 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38273 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
38280 38281 38282 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38280 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
38287 38288 38289 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38287 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
38292 38293 38294 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38292 def router @router end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
38297 38298 38299 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38297 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
38303 38304 38305 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38303 def shared_secret @shared_secret end |
#shared_secret_hash ⇒ String
Hash of the shared secret.
Corresponds to the JSON property sharedSecretHash
38308 38309 38310 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38308 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 blacklisted.
- 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
38335 38336 38337 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38335 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
38341 38342 38343 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38341 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
38348 38349 38350 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38348 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
38353 38354 38355 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38353 def vpn_gateway_interface @vpn_gateway_interface end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
38360 38361 38362 38363 38364 38365 38366 38367 38368 38369 38370 38371 38372 38373 38374 38375 38376 38377 38378 38379 38380 38381 38382 38383 38384 38385 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 38360 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 |