Class: Google::Cloud::Compute::V1::Route

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.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

Modules: RouteStatus, RouteType

Instance Attribute Summary collapse

Instance Attribute Details

#as_paths::Array<::Google::Cloud::Compute::V1::RouteAsPath>

Returns [Output Only] AS path.

Returns:



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#creation_timestamp::String

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

  • (::String)

    [Output Only] Creation timestamp in RFC3339 text format.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#description::String

Returns 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#dest_range::String

Returns 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#id::Integer

Returns [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

  • (::Integer)

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#kind::String

Returns [Output Only] Type of this resource. Always compute#routes for Route resources.

Returns:

  • (::String)

    [Output Only] Type of this resource. Always compute#routes for Route resources.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#name::String

Returns 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.

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



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#network::String

Returns Fully-qualified URL of the network that this route applies to.

Returns:

  • (::String)

    Fully-qualified URL of the network that this route applies to.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_gateway::String

Returns 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



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_hub::String

Returns [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

Returns:

  • (::String)

    [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_ilb::String

Returns 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.

Returns:

  • (::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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_instance::String

Returns 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:



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_ip::String

Returns 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_network::String

Returns 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_peering::String

Returns [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

Returns:

  • (::String)

    [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#next_hop_vpn_tunnel::String

Returns The URL to a VpnTunnel that should handle matching packets.

Returns:

  • (::String)

    The URL to a VpnTunnel that should handle matching packets.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#priority::Integer

Returns 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#route_status::String

Returns [Output only] The status of the route. Check the RouteStatus enum for the list of possible values.

Returns:

  • (::String)

    [Output only] The status of the route. Check the RouteStatus enum for the list of possible values.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#route_type::String

Returns [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] 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.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

Returns [Output Only] Server-defined fully-qualified URL for this resource.

Returns:

  • (::String)

    [Output Only] Server-defined fully-qualified URL for this resource.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#tags::Array<::String>

Returns A list of instance tags to which this route applies.

Returns:

  • (::Array<::String>)

    A list of instance tags to which this route applies.



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end

#warnings::Array<::Google::Cloud::Compute::V1::Warnings>

Returns [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Returns:



27036
27037
27038
27039
27040
27041
27042
27043
27044
27045
27046
27047
27048
27049
27050
27051
27052
27053
27054
27055
27056
27057
27058
27059
27060
27061
27062
27063
27064
27065
27066
27067
27068
27069
27070
27071
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 27036

class Route
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # [Output only] The status of the route.
  module RouteStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_STATUS = 0

    # This route is processed and active.
    ACTIVE = 314_733_318

    # The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example
    DROPPED = 496_235_424

    # This route is processed but inactive due to failure from the backend. The backend may have rejected the route
    INACTIVE = 270_421_099

    # This route is being processed internally. The status will change once processed.
    PENDING = 35_394_935
  end

  # [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
  module RouteType
    # A value indicating that the enum field is not set.
    UNDEFINED_ROUTE_TYPE = 0

    BGP = 65_707

    STATIC = 308_331_118

    SUBNET = 309_278_557

    TRANSIT = 187_793_843
  end
end