Class: Google::Apis::ComputeV1::Route

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

Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (= = resource_for v1.routes ==)

Defined Under Namespace

Classes: Warning

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

Returns a new instance of Route



21332
21333
21334
# File 'generated/google/apis/compute_v1/classes.rb', line 21332

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)


21221
21222
21223
# File 'generated/google/apis/compute_v1/classes.rb', line 21221

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


21227
21228
21229
# File 'generated/google/apis/compute_v1/classes.rb', line 21227

def description
  @description
end

#dest_rangeString

The destination range of outgoing packets that this route applies to. Only IPv4 is supported. Corresponds to the JSON property destRange

Returns:

  • (String)


21233
21234
21235
# File 'generated/google/apis/compute_v1/classes.rb', line 21233

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


21239
21240
21241
# File 'generated/google/apis/compute_v1/classes.rb', line 21239

def id
  @id
end

#kindString

[Output Only] Type of this resource. Always compute#routes for Route resources. Corresponds to the JSON property kind

Returns:

  • (String)


21244
21245
21246
# File 'generated/google/apis/compute_v1/classes.rb', line 21244

def kind
  @kind
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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. Corresponds to the JSON property name

Returns:

  • (String)


21254
21255
21256
# File 'generated/google/apis/compute_v1/classes.rb', line 21254

def name
  @name
end

#networkString

Fully-qualified URL of the network that this route applies to. Corresponds to the JSON property network

Returns:

  • (String)


21259
21260
21261
# File 'generated/google/apis/compute_v1/classes.rb', line 21259

def network
  @network
end

#next_hop_gatewayString

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/ global/gateways/default-internet-gateway Corresponds to the JSON property nextHopGateway

Returns:

  • (String)


21266
21267
21268
# File 'generated/google/apis/compute_v1/classes.rb', line 21266

def next_hop_gateway
  @next_hop_gateway
end

#next_hop_ilbString

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:

Returns:

  • (String)


21276
21277
21278
# File 'generated/google/apis/compute_v1/classes.rb', line 21276

def next_hop_ilb
  @next_hop_ilb
end

#next_hop_instanceString

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ Corresponds to the JSON property nextHopInstance

Returns:

  • (String)


21283
21284
21285
# File 'generated/google/apis/compute_v1/classes.rb', line 21283

def next_hop_instance
  @next_hop_instance
end

#next_hop_ipString

The network IP address of an instance that should handle matching packets. Only IPv4 is supported. Corresponds to the JSON property nextHopIp

Returns:

  • (String)


21289
21290
21291
# File 'generated/google/apis/compute_v1/classes.rb', line 21289

def next_hop_ip
  @next_hop_ip
end

#next_hop_networkString

The URL of the local network if it should handle matching packets. Corresponds to the JSON property nextHopNetwork

Returns:

  • (String)


21294
21295
21296
# File 'generated/google/apis/compute_v1/classes.rb', line 21294

def next_hop_network
  @next_hop_network
end

#next_hop_peeringString

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. Corresponds to the JSON property nextHopPeering

Returns:

  • (String)


21300
21301
21302
# File 'generated/google/apis/compute_v1/classes.rb', line 21300

def next_hop_peering
  @next_hop_peering
end

#next_hop_vpn_tunnelString

The URL to a VpnTunnel that should handle matching packets. Corresponds to the JSON property nextHopVpnTunnel

Returns:

  • (String)


21305
21306
21307
# File 'generated/google/apis/compute_v1/classes.rb', line 21305

def next_hop_vpn_tunnel
  @next_hop_vpn_tunnel
end

#priorityFixnum

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive. Corresponds to the JSON property priority

Returns:

  • (Fixnum)


21314
21315
21316
# File 'generated/google/apis/compute_v1/classes.rb', line 21314

def priority
  @priority
end

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

Returns:

  • (String)


21319
21320
21321
# File 'generated/google/apis/compute_v1/classes.rb', line 21319

def self_link
  @self_link
end

#tagsArray<String>

A list of instance tags to which this route applies. Corresponds to the JSON property tags

Returns:

  • (Array<String>)


21324
21325
21326
# File 'generated/google/apis/compute_v1/classes.rb', line 21324

def tags
  @tags
end

#warningsArray<Google::Apis::ComputeV1::Route::Warning>

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. Corresponds to the JSON property warnings



21330
21331
21332
# File 'generated/google/apis/compute_v1/classes.rb', line 21330

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
# File 'generated/google/apis/compute_v1/classes.rb', line 21337

def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @dest_range = args[:dest_range] if args.key?(:dest_range)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway)
  @next_hop_ilb = args[:next_hop_ilb] if args.key?(:next_hop_ilb)
  @next_hop_instance = args[:next_hop_instance] if args.key?(:next_hop_instance)
  @next_hop_ip = args[:next_hop_ip] if args.key?(:next_hop_ip)
  @next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network)
  @next_hop_peering = args[:next_hop_peering] if args.key?(:next_hop_peering)
  @next_hop_vpn_tunnel = args[:next_hop_vpn_tunnel] if args.key?(:next_hop_vpn_tunnel)
  @priority = args[:priority] if args.key?(:priority)
  @self_link = args[:self_link] if args.key?(:self_link)
  @tags = args[:tags] if args.key?(:tags)
  @warnings = args[:warnings] if args.key?(:warnings)
end