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

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns [Output Only] AS path.

Returns:



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  end
end

#creation_timestamp::String

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

Returns:

  • (::String)

    [Output Only] Creation timestamp in RFC3339 text format.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  end
end

#dest_range::String

Returns The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Returns:

  • (::String)

    The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule.

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: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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:



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  end
end

#next_hop_ip::String

Returns The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

Returns:

  • (::String)

    The network IP address of an instance that should handle matching packets. Only IPv4 is supported.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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.



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  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:



21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 21097

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

  # [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 = 65707

    STATIC = 308331118

    SUBNET = 309278557

    TRANSIT = 187793843
  end
end