Class: Google::Apis::ComputeAlpha::VpnTunnel

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



28159
28160
28161
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28159

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) 


28031
28032
28033
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28031

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) 


28037
28038
28039
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28037

def description
  @description
end

#detailed_status ⇒ String

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

Returns:

  • (String) 


28042
28043
28044
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28042

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) 


28048
28049
28050
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28048

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) 


28054
28055
28056
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28054

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) 


28059
28060
28061
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28059

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


28070
28071
28072
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28070

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<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>) 


28077
28078
28079
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28077

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


28084
28085
28086
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28084

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) 


28094
28095
28096
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28094

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) 


28099
28100
28101
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28099

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) 


28106
28107
28108
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28106

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


28113
28114
28115
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28113

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) 


28118
28119
28120
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28118

def router
  @router
end

#self_link ⇒ String

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

Returns:

  • (String) 


28123
28124
28125
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28123

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) 


28129
28130
28131
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28129

def shared_secret
  @shared_secret
end

#shared_secret_hash ⇒ String

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

Returns:

  • (String) 


28134
28135
28136
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28134

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) 


28139
28140
28141
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28139

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) 


28145
28146
28147
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28145

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) 


28152
28153
28154
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28152

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) 


28157
28158
28159
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28157

def vpn_gateway_interface
  @vpn_gateway_interface
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28164
28165
28166
28167
28168
28169
28170
28171
28172
28173
28174
28175
28176
28177
28178
28179
28180
28181
28182
28183
28184
28185
28186
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 28164

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)
  @vpn_gateway = args[:vpn_gateway] if args.key?(:vpn_gateway)
  @vpn_gateway_interface = args[:vpn_gateway_interface] if args.key?(:vpn_gateway_interface)
end