Class: Google::Cloud::NetworkConnectivity::V1::Route

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkconnectivity/v1/hub.rb

Overview

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the route was created.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns An optional description of the route.

Returns:

  • (::String) —

    An optional description of the route.



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ip_cidr_range ⇒ ::String

Returns The destination IP address range.

Returns:

  • (::String) —

    The destination IP address range.



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#location ⇒ ::String (readonly)

Returns Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1.

Returns:

  • (::String) —

    Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}.

Returns:

  • (::String) —

    Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#next_hop_interconnect_attachment ⇒ ::Google::Cloud::NetworkConnectivity::V1::NextHopInterconnectAttachment

Returns Immutable. The next-hop VLAN attachment for packets on this route.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#next_hop_router_appliance_instance ⇒ ::Google::Cloud::NetworkConnectivity::V1::NextHopRouterApplianceInstance

Returns Immutable. The next-hop Router appliance instance for packets on this route.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#next_hop_vpc_network ⇒ ::Google::Cloud::NetworkConnectivity::V1::NextHopVpcNetwork

Returns Immutable. The destination VPC network for packets on this route.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#next_hop_vpn_tunnel ⇒ ::Google::Cloud::NetworkConnectivity::V1::NextHopVPNTunnel

Returns Immutable. The next-hop VPN tunnel for packets on this route.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#priority ⇒ ::Integer (readonly)

Returns Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.

Returns:

  • (::Integer) —

    Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spoke ⇒ ::String

Returns Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE.

Returns:

  • (::String) —

    Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::NetworkConnectivity::V1::State (readonly)

Returns Output only. The current lifecycle state of the route.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::Google::Cloud::NetworkConnectivity::V1::RouteType (readonly)

Returns Output only. The route's type. Its type is determined by the properties of its IP address range.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

Returns:

  • (::String) —

    Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the route was last updated.

Returns:



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'proto_docs/google/cloud/networkconnectivity/v1/hub.rb', line 363

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end