Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::Route (v1.0.0)

Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::Route.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — An optional description of the route.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of the route.
Returns
  • (::String) — An optional description of the route.

#ip_cidr_range

def ip_cidr_range() -> ::String
Returns
  • (::String) — The destination IP address range.

#ip_cidr_range=

def ip_cidr_range=(value) -> ::String
Parameter
  • value (::String) — The destination IP address range.
Returns
  • (::String) — The destination IP address range.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

#location

def location() -> ::String
Returns
  • (::String) — Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

#name

def name() -> ::String
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}

#name=

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

#next_hop_vpc_network

def next_hop_vpc_network() -> ::Google::Cloud::NetworkConnectivity::V1::NextHopVpcNetwork
Returns

#next_hop_vpc_network=

def next_hop_vpc_network=(value) -> ::Google::Cloud::NetworkConnectivity::V1::NextHopVpcNetwork
Parameter
Returns

#spoke

def spoke() -> ::String
Returns
  • (::String) — Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

#spoke=

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

#state

def state() -> ::Google::Cloud::NetworkConnectivity::V1::State
Returns

#type

def type() -> ::Google::Cloud::NetworkConnectivity::V1::RouteType
Returns

#uid

def uid() -> ::String
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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns