Class: Google::Apis::ComputeV1::Route
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Route
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/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.
Defined Under Namespace
Classes: Warning
Instance Attribute Summary collapse
-
#as_paths ⇒ Array<Google::Apis::ComputeV1::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.
-
#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_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.
-
#tags ⇒ Array<String>
A list of instance tags to which this route applies.
-
#warnings ⇒ Array<Google::Apis::ComputeV1::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.
34348 34349 34350 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34348 def initialize(**args) update!(**args) end |
Instance Attribute Details
#as_paths ⇒ Array<Google::Apis::ComputeV1::RouteAsPath>
[Output Only] AS path.
Corresponds to the JSON property asPaths
34202 34203 34204 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34202 def as_paths @as_paths end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
34207 34208 34209 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34207 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
34213 34214 34215 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34213 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
34221 34222 34223 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34221 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
34227 34228 34229 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34227 def id @id end |
#kind ⇒ String
[Output Only] Type of this resource. Always compute#routes for Route resources.
Corresponds to the JSON property kind
34232 34233 34234 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34232 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
34242 34243 34244 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34242 def name @name end |
#network ⇒ String
Fully-qualified URL of the network that this route applies to.
Corresponds to the JSON property network
34247 34248 34249 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34247 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
34254 34255 34256 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34254 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
34260 34261 34262 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34260 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: - https://www.googleapis.com/compute/v1/
projects/project/regions/region /forwardingRules/forwardingRule - regions/
region/forwardingRules/forwardingRule If an IP address is provided, must
specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291
format. For example, the following are all valid IP addresses: - 10.128.0.56 -
2001:db8::2d9:51:0:0 - 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 nextHopIlb
34274 34275 34276 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34274 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
34281 34282 34283 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34281 def next_hop_instance @next_hop_instance 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
34291 34292 34293 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34291 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
34296 34297 34298 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34296 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
34302 34303 34304 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34302 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
34307 34308 34309 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34307 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
34316 34317 34318 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34316 def priority @priority end |
#route_status ⇒ String
[Output only] The status of the route.
Corresponds to the JSON property routeStatus
34321 34322 34323 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34321 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
34330 34331 34332 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34330 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
34335 34336 34337 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34335 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
34340 34341 34342 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34340 def @tags end |
#warnings ⇒ Array<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
34346 34347 34348 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34346 def warnings @warnings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
34353 34354 34355 34356 34357 34358 34359 34360 34361 34362 34363 34364 34365 34366 34367 34368 34369 34370 34371 34372 34373 34374 34375 34376 |
# File 'lib/google/apis/compute_v1/classes.rb', line 34353 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_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 |