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



23486
23487
23488
# File 'generated/google/apis/compute_v1/classes.rb', line 23486

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)


23377
23378
23379
# File 'generated/google/apis/compute_v1/classes.rb', line 23377

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)


23383
23384
23385
# File 'generated/google/apis/compute_v1/classes.rb', line 23383

def description
  @description
end

#detailed_statusString

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

Returns:

  • (String)


23388
23389
23390
# File 'generated/google/apis/compute_v1/classes.rb', line 23388

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)


23394
23395
23396
# File 'generated/google/apis/compute_v1/classes.rb', line 23394

def id
  @id
end

#ike_versionFixnum

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)


23400
23401
23402
# File 'generated/google/apis/compute_v1/classes.rb', line 23400

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)


23405
23406
23407
# File 'generated/google/apis/compute_v1/classes.rb', line 23405

def kind
  @kind
end

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


23412
23413
23414
# File 'generated/google/apis/compute_v1/classes.rb', line 23412

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)


23422
23423
23424
# File 'generated/google/apis/compute_v1/classes.rb', line 23422

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)


23427
23428
23429
# File 'generated/google/apis/compute_v1/classes.rb', line 23427

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)


23434
23435
23436
# File 'generated/google/apis/compute_v1/classes.rb', line 23434

def region
  @region
end

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


23441
23442
23443
# File 'generated/google/apis/compute_v1/classes.rb', line 23441

def remote_traffic_selector
  @remote_traffic_selector
end

#routerString

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

Returns:

  • (String)


23446
23447
23448
# File 'generated/google/apis/compute_v1/classes.rb', line 23446

def router
  @router
end

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

Returns:

  • (String)


23451
23452
23453
# File 'generated/google/apis/compute_v1/classes.rb', line 23451

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)


23457
23458
23459
# File 'generated/google/apis/compute_v1/classes.rb', line 23457

def shared_secret
  @shared_secret
end

#shared_secret_hashString

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

Returns:

  • (String)


23462
23463
23464
# File 'generated/google/apis/compute_v1/classes.rb', line 23462

def shared_secret_hash
  @shared_secret_hash
end

#statusString

[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. Corresponds to the JSON property status

Returns:

  • (String)


23478
23479
23480
# File 'generated/google/apis/compute_v1/classes.rb', line 23478

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)


23484
23485
23486
# File 'generated/google/apis/compute_v1/classes.rb', line 23484

def target_vpn_gateway
  @target_vpn_gateway
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
# File 'generated/google/apis/compute_v1/classes.rb', line 23491

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