Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::Hub (v1.1.0)

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

A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

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

#description=

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

#export_psc

def export_psc() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.

#export_psc=

def export_psc=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.
Returns
  • (::Boolean) — Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.

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

#name

def name() -> ::String
Returns
  • (::String) — Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
Returns
  • (::String) — Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}

#policy_mode

def policy_mode() -> ::Google::Cloud::NetworkConnectivity::V1::PolicyMode
Returns

#policy_mode=

def policy_mode=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PolicyMode
Parameter
Returns

#preset_topology

def preset_topology() -> ::Google::Cloud::NetworkConnectivity::V1::PresetTopology
Returns
  • (::Google::Cloud::NetworkConnectivity::V1::PresetTopology) — Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.

#preset_topology=

def preset_topology=(value) -> ::Google::Cloud::NetworkConnectivity::V1::PresetTopology
Parameter
  • value (::Google::Cloud::NetworkConnectivity::V1::PresetTopology) — Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.
Returns
  • (::Google::Cloud::NetworkConnectivity::V1::PresetTopology) — Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.

#route_tables

def route_tables() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

    This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.

#routing_vpcs

def routing_vpcs() -> ::Array<::Google::Cloud::NetworkConnectivity::V1::RoutingVPC>
Returns

#routing_vpcs=

def routing_vpcs=(value) -> ::Array<::Google::Cloud::NetworkConnectivity::V1::RoutingVPC>
Parameter
Returns

#spoke_summary

def spoke_summary() -> ::Google::Cloud::NetworkConnectivity::V1::SpokeSummary
Returns
  • (::Google::Cloud::NetworkConnectivity::V1::SpokeSummary) — Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

#state

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

#unique_id

def unique_id() -> ::String
Returns
  • (::String) — Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id.

#update_time

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