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

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

Overview

VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1. vpnTunnels ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VpnTunnel

Returns a new instance of VpnTunnel



23825
23826
23827
# File 'generated/google/apis/compute_beta/classes.rb', line 23825

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


23709
23710
23711
# File 'generated/google/apis/compute_beta/classes.rb', line 23709

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


23715
23716
23717
# File 'generated/google/apis/compute_beta/classes.rb', line 23715

def description
  @description
end

#detailed_statusString

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

Returns:

  • (String)


23720
23721
23722
# File 'generated/google/apis/compute_beta/classes.rb', line 23720

def detailed_status
  @detailed_status
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


23726
23727
23728
# File 'generated/google/apis/compute_beta/classes.rb', line 23726

def id
  @id
end

#ike_versionFixnum

IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. Corresponds to the JSON property ikeVersion

Returns:

  • (Fixnum)


23732
23733
23734
# File 'generated/google/apis/compute_beta/classes.rb', line 23732

def ike_version
  @ike_version
end

#kindString

[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. Corresponds to the JSON property kind

Returns:

  • (String)


23737
23738
23739
# File 'generated/google/apis/compute_beta/classes.rb', line 23737

def kind
  @kind
end

#label_fingerprintString

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


23748
23749
23750
# File 'generated/google/apis/compute_beta/classes.rb', line 23748

def label_fingerprint
  @label_fingerprint
end

#labelsHash<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

Returns:

  • (Hash<String,String>)


23755
23756
23757
# File 'generated/google/apis/compute_beta/classes.rb', line 23755

def labels
  @labels
end

#local_traffic_selectorArray<String>

Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/

  1. The ranges should be disjoint. Only IPv4 is supported. Corresponds to the JSON property localTrafficSelector

Returns:

  • (Array<String>)


23762
23763
23764
# File 'generated/google/apis/compute_beta/classes.rb', line 23762

def local_traffic_selector
  @local_traffic_selector
end

#nameString

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)


23772
23773
23774
# File 'generated/google/apis/compute_beta/classes.rb', line 23772

def name
  @name
end

#peer_ipString

IP address of the peer VPN gateway. Only IPv4 is supported. Corresponds to the JSON property peerIp

Returns:

  • (String)


23777
23778
23779
# File 'generated/google/apis/compute_beta/classes.rb', line 23777

def peer_ip
  @peer_ip
end

#regionString

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


23784
23785
23786
# File 'generated/google/apis/compute_beta/classes.rb', line 23784

def region
  @region
end

#remote_traffic_selectorArray<String>

Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/

  1. The ranges should be disjoint. Only IPv4 is supported. Corresponds to the JSON property remoteTrafficSelector

Returns:

  • (Array<String>)


23791
23792
23793
# File 'generated/google/apis/compute_beta/classes.rb', line 23791

def remote_traffic_selector
  @remote_traffic_selector
end

#routerString

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

Returns:

  • (String)


23796
23797
23798
# File 'generated/google/apis/compute_beta/classes.rb', line 23796

def router
  @router
end

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

Returns:

  • (String)


23801
23802
23803
# File 'generated/google/apis/compute_beta/classes.rb', line 23801

def self_link
  @self_link
end

#shared_secretString

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)


23807
23808
23809
# File 'generated/google/apis/compute_beta/classes.rb', line 23807

def shared_secret
  @shared_secret
end

#shared_secret_hashString

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

Returns:

  • (String)


23812
23813
23814
# File 'generated/google/apis/compute_beta/classes.rb', line 23812

def shared_secret_hash
  @shared_secret_hash
end

#statusString

[Output Only] The status of the VPN tunnel. Corresponds to the JSON property status

Returns:

  • (String)


23817
23818
23819
# File 'generated/google/apis/compute_beta/classes.rb', line 23817

def status
  @status
end

#target_vpn_gatewayString

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)


23823
23824
23825
# File 'generated/google/apis/compute_beta/classes.rb', line 23823

def target_vpn_gateway
  @target_vpn_gateway
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23830
23831
23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
# File 'generated/google/apis/compute_beta/classes.rb', line 23830

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_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)
end