Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Route (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Route.

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 theRoutes overview.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#as_paths

def as_paths() -> ::Array<::Google::Cloud::Compute::V1::RouteAsPath>
Returns

#as_paths=

def as_paths=(value) -> ::Array<::Google::Cloud::Compute::V1::RouteAsPath>
Parameter
Returns

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this field when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this field when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this field when you create the resource.

#dest_range

def dest_range() -> ::String
Returns
  • (::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.

#dest_range=

def dest_range=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#id

def id() -> ::Integer
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — Output only. [Output Only] Type of this resource. Always compute#routes for Route resources.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Type of this resource. Always compute#routes for Route resources.
Returns
  • (::String) — Output only. [Output Only] Type of this resource. Always compute#routes for Route resources.

#name

def name() -> ::String
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

#network

def network() -> ::String
Returns
  • (::String) — Fully-qualified URL of the network that this route applies to.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — Fully-qualified URL of the network that this route applies to.
Returns
  • (::String) — Fully-qualified URL of the network that this route applies to.

#next_hop_gateway

def next_hop_gateway() -> ::String
Returns
  • (::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

#next_hop_gateway=

def next_hop_gateway=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#next_hop_hub

def next_hop_hub() -> ::String
Returns
  • (::String) — Output only. [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

#next_hop_hub=

def next_hop_hub=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
Returns
  • (::String) — Output only. [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

#next_hop_ilb

def next_hop_ilb() -> ::String
Returns
  • (::String) — The URL to a forwarding rule of typeloadBalancingScheme=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.

#next_hop_ilb=

def next_hop_ilb=(value) -> ::String
Parameter
  • value (::String) — The URL to a forwarding rule of typeloadBalancingScheme=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.

Returns
  • (::String) — The URL to a forwarding rule of typeloadBalancingScheme=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.

#next_hop_instance

def next_hop_instance() -> ::String
Returns
  • (::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/

#next_hop_instance=

def next_hop_instance=(value) -> ::String
Parameter
  • value (::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/
Returns
  • (::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/

#next_hop_inter_region_cost

def next_hop_inter_region_cost() -> ::Integer
Returns
  • (::Integer) — Output only. [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_inter_region_cost=

def next_hop_inter_region_cost=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [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.
Returns
  • (::Integer) — Output only. [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

def next_hop_interconnect_attachment() -> ::String
Returns
  • (::String) — Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.

#next_hop_interconnect_attachment=

def next_hop_interconnect_attachment=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.
Returns
  • (::String) — Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.

#next_hop_ip

def next_hop_ip() -> ::String
Returns
  • (::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.

#next_hop_ip=

def next_hop_ip=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#next_hop_med

def next_hop_med() -> ::Integer
Returns
  • (::Integer) — Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

#next_hop_med=

def next_hop_med=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
Returns
  • (::Integer) — Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

#next_hop_network

def next_hop_network() -> ::String
Returns
  • (::String) — The URL of the local network if it should handle matching packets.

#next_hop_network=

def next_hop_network=(value) -> ::String
Parameter
  • value (::String) — The URL of the local network if it should handle matching packets.
Returns
  • (::String) — The URL of the local network if it should handle matching packets.

#next_hop_origin

def next_hop_origin() -> ::String
Returns
  • (::String) — Output only. [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

#next_hop_origin=

def next_hop_origin=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.
Returns
  • (::String) — Output only. [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

#next_hop_peering

def next_hop_peering() -> ::String
Returns
  • (::String) — Output only. [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

#next_hop_peering=

def next_hop_peering=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Returns
  • (::String) — Output only. [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

#next_hop_vpn_tunnel

def next_hop_vpn_tunnel() -> ::String
Returns
  • (::String) — The URL to a VpnTunnel that should handle matching packets.

#next_hop_vpn_tunnel=

def next_hop_vpn_tunnel=(value) -> ::String
Parameter
  • value (::String) — The URL to a VpnTunnel that should handle matching packets.
Returns
  • (::String) — The URL to a VpnTunnel that should handle matching packets.

#params

def params() -> ::Google::Cloud::Compute::V1::RouteParams
Returns

#params=

def params=(value) -> ::Google::Cloud::Compute::V1::RouteParams
Parameter
Returns

#priority

def priority() -> ::Integer
Returns
  • (::Integer) — 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.

#priority=

def priority=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#route_status

def route_status() -> ::String
Returns
  • (::String) — [Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. Check the RouteStatus enum for the list of possible values.

#route_status=

def route_status=(value) -> ::String
Parameter
  • value (::String) — [Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. Check the RouteStatus enum for the list of possible values.
Returns
  • (::String) — [Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. Check the RouteStatus enum for the list of possible values.

#route_type

def route_type() -> ::String
Returns
  • (::String) —

    Output only. [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 Check the RouteType enum for the list of possible values.

#route_type=

def route_type=(value) -> ::String
Parameter
  • value (::String) —

    Output only. [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 Check the RouteType enum for the list of possible values.
Returns
  • (::String) —

    Output only. [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 Check the RouteType enum for the list of possible values.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined fully-qualified URL for this resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined fully-qualified URL for this resource.
Returns
  • (::String) — [Output Only] Server-defined fully-qualified URL for this resource.

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — A list of instance tags to which this route applies.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — A list of instance tags to which this route applies.
Returns
  • (::Array<::String>) — A list of instance tags to which this route applies.

#warnings

def warnings() -> ::Array<::Google::Cloud::Compute::V1::Warnings>
Returns
  • (::Array<::Google::Cloud::Compute::V1::Warnings>) — Output only. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

#warnings=

def warnings=(value) -> ::Array<::Google::Cloud::Compute::V1::Warnings>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::Warnings>) — Output only. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
Returns
  • (::Array<::Google::Cloud::Compute::V1::Warnings>) — Output only. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.