Class: Google::Apis::ComputeBeta::Route

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

Defined Under Namespace

Classes: Warning

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Route

Returns a new instance of Route.



34267
34268
34269
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34267

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#as_paths ⇒ Array<Google::Apis::ComputeBeta::RouteAsPath>

[Output Only] AS path. Corresponds to the JSON property asPaths

Returns:



34125
34126
34127
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34125

def as_paths
  @as_paths
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


34130
34131
34132
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34130

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


34136
34137
34138
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34136

def description
  @description
end

#dest_range ⇒ String

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Corresponds to the JSON property destRange

Returns:

  • (String) 


34142
34143
34144
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34142

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


34148
34149
34150
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34148

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


34153
34154
34155
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34153

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


34163
34164
34165
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34163

def name
  @name
end

#network ⇒ String

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

Returns:

  • (String) 


34168
34169
34170
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34168

def network
  @network
end

#next_hop_gateway ⇒ String

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) 


34175
34176
34177
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34175

def next_hop_gateway
  @next_hop_gateway
end

#next_hop_hub ⇒ String

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. Corresponds to the JSON property nextHopHub

Returns:

  • (String) 


34181
34182
34183
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34181

def next_hop_hub
  @next_hop_hub
end

#next_hop_ilb ⇒ String

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/ compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Corresponds to the JSON property nextHopIlb

Returns:

  • (String) 


34190
34191
34192
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34190

def next_hop_ilb
  @next_hop_ilb
end

#next_hop_instance ⇒ String

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) 


34197
34198
34199
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34197

def next_hop_instance
  @next_hop_instance
end

#next_hop_interconnect_attachment ⇒ String

[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. Corresponds to the JSON property nextHopInterconnectAttachment

Returns:

  • (String) 


34204
34205
34206
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34204

def next_hop_interconnect_attachment
  @next_hop_interconnect_attachment
end

#next_hop_ip ⇒ String

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

Returns:

  • (String) 


34210
34211
34212
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34210

def next_hop_ip
  @next_hop_ip
end

#next_hop_network ⇒ String

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

Returns:

  • (String) 


34215
34216
34217
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34215

def next_hop_network
  @next_hop_network
end

#next_hop_peering ⇒ String

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

Returns:

  • (String) 


34221
34222
34223
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34221

def next_hop_peering
  @next_hop_peering
end

#next_hop_vpn_tunnel ⇒ String

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

Returns:

  • (String) 


34226
34227
34228
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34226

def next_hop_vpn_tunnel
  @next_hop_vpn_tunnel
end

#priority ⇒ Fixnum

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) 


34235
34236
34237
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34235

def priority
  @priority
end

#route_status ⇒ String

[Output only] The status of the route. Corresponds to the JSON property routeStatus

Returns:

  • (String) 


34240
34241
34242
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34240

def route_status
  @route_status
end

#route_type ⇒ String

[Output Only] The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route Corresponds to the JSON property routeType

Returns:

  • (String) 


34249
34250
34251
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34249

def route_type
  @route_type
end

#self_link ⇒ String

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

Returns:

  • (String) 


34254
34255
34256
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34254

def self_link
  @self_link
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


34259
34260
34261
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34259

def tags
  @tags
end

#warnings ⇒ Array<Google::Apis::ComputeBeta::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

Returns:



34265
34266
34267
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34265

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34272
34273
34274
34275
34276
34277
34278
34279
34280
34281
34282
34283
34284
34285
34286
34287
34288
34289
34290
34291
34292
34293
34294
34295
34296
 
# File 'lib/google/apis/compute_beta/classes.rb', line 34272

def update!(**args)
  @as_paths = args[:as_paths] if args.key?(:as_paths)
  @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_hub = args[:next_hop_hub] if args.key?(:next_hop_hub)
  @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_interconnect_attachment = args[:next_hop_interconnect_attachment] if args.key?(:next_hop_interconnect_attachment)
  @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)
  @route_status = args[:route_status] if args.key?(:route_status)
  @route_type = args[:route_type] if args.key?(:route_type)
  @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