Class: Google::Apis::ComputeAlpha::Route
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Route
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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
-
#allow_conflicting_subnetworks ⇒ Boolean
(also: #allow_conflicting_subnetworks?)
Whether this route can conflict with existing subnetworks.
-
#as_paths ⇒ Array<Google::Apis::ComputeAlpha::RouteAsPath>
[Output Only] AS path.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#dest_range ⇒ String
The destination range of outgoing packets that this route applies to.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ilb_route_behavior_on_unhealthy ⇒ String
ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.
-
#kind ⇒ String
[Output Only] Type of this resource.
-
#name ⇒ String
Name of the resource.
-
#network ⇒ String
Fully-qualified URL of the network that this route applies to.
-
#next_hop_gateway ⇒ String
The URL to a gateway that should handle matching packets.
-
#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.
-
#next_hop_instance ⇒ String
The URL to an instance that should handle matching packets.
-
#next_hop_interconnect_attachment ⇒ String
[Output Only] The URL to an InterconnectAttachment which is the next hop for the route.
-
#next_hop_ip ⇒ String
The network IP address of an instance that should handle matching packets.
-
#next_hop_network ⇒ String
The URL of the local network if it should handle matching packets.
-
#next_hop_peering ⇒ String
[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
-
#next_hop_vpn_tunnel ⇒ String
The URL to a VpnTunnel that should handle matching packets.
-
#priority ⇒ Fixnum
The priority of this route.
-
#route_status ⇒ String
[Output only] The status of the route.
-
#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
. -
#self_link ⇒ String
[Output Only] Server-defined fully-qualified URL for this resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#tags ⇒ Array<String>
A list of instance tags to which this route applies.
-
#warnings ⇒ Array<Google::Apis::ComputeAlpha::Route::Warning>
[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Route
constructor
A new instance of Route.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Route
Returns a new instance of Route.
36384 36385 36386 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36384 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allow_conflicting_subnetworks ⇒ Boolean Also known as: allow_conflicting_subnetworks?
Whether this route can conflict with existing subnetworks. Setting this to
true allows this route to conflict with subnetworks that have already been
configured on the corresponding network.
Corresponds to the JSON property allowConflictingSubnetworks
36231 36232 36233 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36231 def allow_conflicting_subnetworks @allow_conflicting_subnetworks end |
#as_paths ⇒ Array<Google::Apis::ComputeAlpha::RouteAsPath>
[Output Only] AS path.
Corresponds to the JSON property asPaths
36237 36238 36239 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36237 def as_paths @as_paths end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
36242 36243 36244 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36242 def @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
36248 36249 36250 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36248 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
36254 36255 36256 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36254 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
36260 36261 36262 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36260 def id @id end |
#ilb_route_behavior_on_unhealthy ⇒ String
ILB route behavior when ILB is deemed unhealthy based on user specified
threshold on the Backend Service of the internal load balancing.
Corresponds to the JSON property ilbRouteBehaviorOnUnhealthy
36266 36267 36268 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36266 def ilb_route_behavior_on_unhealthy @ilb_route_behavior_on_unhealthy end |
#kind ⇒ String
[Output Only] Type of this resource. Always compute#routes for Route resources.
Corresponds to the JSON property kind
36271 36272 36273 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36271 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
36281 36282 36283 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36281 def name @name end |
#network ⇒ String
Fully-qualified URL of the network that this route applies to.
Corresponds to the JSON property network
36286 36287 36288 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36286 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
36293 36294 36295 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36293 def next_hop_gateway @next_hop_gateway 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
36302 36303 36304 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36302 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
36309 36310 36311 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36309 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
36316 36317 36318 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36316 def @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
36322 36323 36324 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36322 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
36327 36328 36329 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36327 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
36333 36334 36335 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36333 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
36338 36339 36340 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36338 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
36347 36348 36349 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36347 def priority @priority end |
#route_status ⇒ String
[Output only] The status of the route.
Corresponds to the JSON property routeStatus
36352 36353 36354 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36352 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
36361 36362 36363 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36361 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
36366 36367 36368 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36366 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
36371 36372 36373 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36371 def self_link_with_id @self_link_with_id end |
#tags ⇒ Array<String>
A list of instance tags to which this route applies.
Corresponds to the JSON property tags
36376 36377 36378 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36376 def @tags end |
#warnings ⇒ Array<Google::Apis::ComputeAlpha::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
36382 36383 36384 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36382 def warnings @warnings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
36389 36390 36391 36392 36393 36394 36395 36396 36397 36398 36399 36400 36401 36402 36403 36404 36405 36406 36407 36408 36409 36410 36411 36412 36413 36414 36415 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 36389 def update!(**args) @allow_conflicting_subnetworks = args[:allow_conflicting_subnetworks] if args.key?(:allow_conflicting_subnetworks) @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) @ilb_route_behavior_on_unhealthy = args[:ilb_route_behavior_on_unhealthy] if args.key?(:ilb_route_behavior_on_unhealthy) @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_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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @tags = args[:tags] if args.key?(:tags) @warnings = args[:warnings] if args.key?(:warnings) end |