Class: Google::Apis::ComputeV1::VpnTunnel

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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



17887
17888
17889
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17887

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) 


17791
17792
17793
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17791

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) 


17797
17798
17799
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17797

def description
  @description
end

#detailed_status ⇒ String

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

Returns:

  • (String) 


17802
17803
17804
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17802

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) 


17808
17809
17810
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17808

def id
  @id
end

#ike_version ⇒ Fixnum

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) 


17814
17815
17816
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17814

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) 


17819
17820
17821
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17819

def kind
  @kind
end

#local_traffic_selector ⇒ Array<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>) 


17826
17827
17828
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17826

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


17836
17837
17838
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17836

def name
  @name
end

#peer_ip ⇒ String

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

Returns:

  • (String) 


17841
17842
17843
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17841

def peer_ip
  @peer_ip
end

#region ⇒ String

[Output Only] URL of the region where the VPN tunnel resides. Corresponds to the JSON property region

Returns:

  • (String) 


17846
17847
17848
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17846

def region
  @region
end

#remote_traffic_selector ⇒ Array<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>) 


17853
17854
17855
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17853

def remote_traffic_selector
  @remote_traffic_selector
end

#router ⇒ String

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

Returns:

  • (String) 


17858
17859
17860
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17858

def router
  @router
end

#self_link ⇒ String

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

Returns:

  • (String) 


17863
17864
17865
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17863

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) 


17869
17870
17871
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17869

def shared_secret
  @shared_secret
end

#shared_secret_hash ⇒ String

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

Returns:

  • (String) 


17874
17875
17876
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17874

def shared_secret_hash
  @shared_secret_hash
end

#status ⇒ String

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

Returns:

  • (String) 


17879
17880
17881
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17879

def status
  @status
end

#target_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. Corresponds to the JSON property targetVpnGateway

Returns:

  • (String) 


17885
17886
17887
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17885

def target_vpn_gateway
  @target_vpn_gateway
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
 
# File 'generated/google/apis/compute_v1/classes.rb', line 17892

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