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_hub ⇒ String
[Output Only] The full resource name of the Network Connectivity Center hub that will 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_inter_region_cost ⇒ Fixnum
[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
-
#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_med ⇒ Fixnum
[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
-
#next_hop_network ⇒ String
The URL of the local network if it should handle matching packets.
-
#next_hop_origin ⇒ String
[Output Only] Indicates the origin of the route.
-
#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.
39740 39741 39742 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39740 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
39556 39557 39558 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39556 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
39562 39563 39564 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39562 def as_paths @as_paths end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
39567 39568 39569 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39567 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
39573 39574 39575 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39573 def description @description end |
#dest_range ⇒ String
The destination range of outgoing packets that this route applies to. Both
IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or
an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be
displayed using RFC 5952 compressed format.
Corresponds to the JSON property destRange
39581 39582 39583 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39581 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
39587 39588 39589 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39587 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
39593 39594 39595 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39593 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
39598 39599 39600 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39598 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
39608 39609 39610 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39608 def name @name end |
#network ⇒ String
Fully-qualified URL of the network that this route applies to.
Corresponds to the JSON property network
39613 39614 39615 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39613 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
39620 39621 39622 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39620 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
39626 39627 39628 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39626 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
39635 39636 39637 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39635 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
39642 39643 39644 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39642 def next_hop_instance @next_hop_instance end |
#next_hop_inter_region_cost ⇒ Fixnum
[Output only] Internal fixed region-to-region cost that Google Cloud
calculates based on factors such as network performance, distance, and
available bandwidth between regions.
Corresponds to the JSON property nextHopInterRegionCost
39649 39650 39651 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39649 def next_hop_inter_region_cost @next_hop_inter_region_cost 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
39656 39657 39658 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39656 def @next_hop_interconnect_attachment end |
#next_hop_ip ⇒ String
The network IP address of an instance that should handle matching packets.
Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4
address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC
4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6
addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::
2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
Corresponds to the JSON property nextHopIp
39666 39667 39668 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39666 def next_hop_ip @next_hop_ip end |
#next_hop_med ⇒ Fixnum
[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the
desirability of a particular route in a network.
Corresponds to the JSON property nextHopMed
39672 39673 39674 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39672 def next_hop_med @next_hop_med end |
#next_hop_network ⇒ String
The URL of the local network if it should handle matching packets.
Corresponds to the JSON property nextHopNetwork
39677 39678 39679 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39677 def next_hop_network @next_hop_network end |
#next_hop_origin ⇒ String
[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway
Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
Corresponds to the JSON property nextHopOrigin
39683 39684 39685 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39683 def next_hop_origin @next_hop_origin 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
39689 39690 39691 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39689 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
39694 39695 39696 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39694 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
39703 39704 39705 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39703 def priority @priority end |
#route_status ⇒ String
[Output only] The status of the route.
Corresponds to the JSON property routeStatus
39708 39709 39710 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39708 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
39717 39718 39719 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39717 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
39722 39723 39724 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39722 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
39727 39728 39729 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39727 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
39732 39733 39734 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39732 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
39738 39739 39740 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39738 def warnings @warnings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
39745 39746 39747 39748 39749 39750 39751 39752 39753 39754 39755 39756 39757 39758 39759 39760 39761 39762 39763 39764 39765 39766 39767 39768 39769 39770 39771 39772 39773 39774 39775 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39745 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_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_inter_region_cost = args[:next_hop_inter_region_cost] if args.key?(:next_hop_inter_region_cost) @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_med = args[:next_hop_med] if args.key?(:next_hop_med) @next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network) @next_hop_origin = args[:next_hop_origin] if args.key?(:next_hop_origin) @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 |