Class: Google::Apis::ComputeBeta::VpnTunnel

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VpnTunnel

Returns a new instance of VpnTunnel.



41796
41797
41798
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41796

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

Returns:

  • (String) 


41627
41628
41629
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41627

def creation_timestamp
  @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

Returns:

  • (String) 


41633
41634
41635
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41633

def description
  @description
end

#detailed_status ⇒ String

[Output Only] Detailed status message for the VPN tunnel. Corresponds to the JSON property detailedStatus

Returns:

  • (String) 


41638
41639
41640
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41638

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

Returns:

  • (Fixnum) 


41644
41645
41646
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41644

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

Returns:

  • (Fixnum) 


41650
41651
41652
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41650

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

Returns:

  • (String) 


41655
41656
41657
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41655

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.

Returns:

  • (String) 


41667
41668
41669
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41667

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

Returns:

  • (Hash<String,String>) 


41674
41675
41676
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41674

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

Returns:

  • (Array<String>) 


41681
41682
41683
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41681

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

Returns:

  • (String) 


41691
41692
41693
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41691

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

Returns:

  • (String) 


41698
41699
41700
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41698

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

Returns:

  • (Fixnum) 


41704
41705
41706
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41704

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

Returns:

  • (String) 


41714
41715
41716
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41714

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

Returns:

  • (String) 


41719
41720
41721
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41719

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

Returns:

  • (String) 


41726
41727
41728
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41726

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

Returns:

  • (Array<String>) 


41733
41734
41735
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41733

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

Returns:

  • (String) 


41738
41739
41740
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41738

def router
  @router
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


41743
41744
41745
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41743

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

Returns:

  • (String) 


41749
41750
41751
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41749

def shared_secret
  @shared_secret
end

#shared_secret_hash ⇒ String

Hash of the shared secret. Corresponds to the JSON property sharedSecretHash

Returns:

  • (String) 


41754
41755
41756
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41754

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

Returns:

  • (String) 


41776
41777
41778
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41776

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

Returns:

  • (String) 


41782
41783
41784
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41782

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

Returns:

  • (String) 


41789
41790
41791
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41789

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

Returns:

  • (Fixnum) 


41794
41795
41796
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41794

def vpn_gateway_interface
  @vpn_gateway_interface
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



41801
41802
41803
41804
41805
41806
41807
41808
41809
41810
41811
41812
41813
41814
41815
41816
41817
41818
41819
41820
41821
41822
41823
41824
41825
41826
 
# File 'lib/google/apis/compute_beta/classes.rb', line 41801

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