Class: Google::Apis::ComputeAlpha::Route
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Route
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table. For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway. Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==)
Defined Under Namespace
Classes: Warning
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#next_hop_instance ⇒ String
The URL to an instance that should handle matching packets.
-
#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.
-
#self_link ⇒ String
[Output Only] Server-defined fully-qualified URL for this resource.
-
#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.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Route
Returns a new instance of Route
20691 20692 20693 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20691 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
20580 20581 20582 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20580 def @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
20586 20587 20588 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20586 def description @description end |
#dest_range ⇒ String
The destination range of outgoing packets that this route applies to. Only
IPv4 is supported.
Corresponds to the JSON property destRange
20592 20593 20594 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20592 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
20598 20599 20600 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20598 def id @id end |
#kind ⇒ String
[Output Only] Type of this resource. Always compute#routes for Route resources.
Corresponds to the JSON property kind
20603 20604 20605 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20603 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])?
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
20613 20614 20615 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20613 def name @name end |
#network ⇒ String
Fully-qualified URL of the network that this route applies to.
Corresponds to the JSON property network
20618 20619 20620 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20618 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/nextHopGateway
20625 20626 20627 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20625 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. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:
- https://www.googleapis.com/compute/v1/projects/project/regions/region/ forwardingRules/forwardingRule
- regions/region/forwardingRules/forwardingRule Note that this can only be
used when the destination_range is a public (non-RFC 1918) IP CIDR range.
Corresponds to the JSON property
nextHopIlb
20636 20637 20638 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20636 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
20643 20644 20645 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20643 def next_hop_instance @next_hop_instance 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
20649 20650 20651 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20649 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
20654 20655 20656 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20654 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
20660 20661 20662 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20660 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
20665 20666 20667 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20665 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 the case of
two routes with equal prefix length, the one with the lowest-numbered priority
value wins. Default value is 1000. Valid range is 0 through 65535.
Corresponds to the JSON property priority
20673 20674 20675 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20673 def priority @priority end |
#self_link ⇒ String
[Output Only] Server-defined fully-qualified URL for this resource.
Corresponds to the JSON property selfLink
20678 20679 20680 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20678 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
20683 20684 20685 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20683 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
20689 20690 20691 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20689 def warnings @warnings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
20696 20697 20698 20699 20700 20701 20702 20703 20704 20705 20706 20707 20708 20709 20710 20711 20712 20713 20714 20715 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 20696 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 |