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



19380
19381
19382
# File 'generated/google/apis/compute_v1/classes.rb', line 19380

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)


19282
19283
19284
# File 'generated/google/apis/compute_v1/classes.rb', line 19282

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)


19288
19289
19290
# File 'generated/google/apis/compute_v1/classes.rb', line 19288

def description
  @description
end

#detailed_statusString

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

Returns:

  • (String)


19293
19294
19295
# File 'generated/google/apis/compute_v1/classes.rb', line 19293

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)


19299
19300
19301
# File 'generated/google/apis/compute_v1/classes.rb', line 19299

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)


19305
19306
19307
# File 'generated/google/apis/compute_v1/classes.rb', line 19305

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)


19310
19311
19312
# File 'generated/google/apis/compute_v1/classes.rb', line 19310

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


19317
19318
19319
# File 'generated/google/apis/compute_v1/classes.rb', line 19317

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)


19327
19328
19329
# File 'generated/google/apis/compute_v1/classes.rb', line 19327

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)


19332
19333
19334
# File 'generated/google/apis/compute_v1/classes.rb', line 19332

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)


19339
19340
19341
# File 'generated/google/apis/compute_v1/classes.rb', line 19339

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


19346
19347
19348
# File 'generated/google/apis/compute_v1/classes.rb', line 19346

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)


19351
19352
19353
# File 'generated/google/apis/compute_v1/classes.rb', line 19351

def router
  @router
end

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

Returns:

  • (String)


19356
19357
19358
# File 'generated/google/apis/compute_v1/classes.rb', line 19356

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)


19362
19363
19364
# File 'generated/google/apis/compute_v1/classes.rb', line 19362

def shared_secret
  @shared_secret
end

#shared_secret_hashString

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

Returns:

  • (String)


19367
19368
19369
# File 'generated/google/apis/compute_v1/classes.rb', line 19367

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)


19372
19373
19374
# File 'generated/google/apis/compute_v1/classes.rb', line 19372

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)


19378
19379
19380
# File 'generated/google/apis/compute_v1/classes.rb', line 19378

def target_vpn_gateway
  @target_vpn_gateway
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
# File 'generated/google/apis/compute_v1/classes.rb', line 19385

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