Google Cloud Network Connectivity V1 Client - Class Hub (1.5.5)

Version 1.5.5

• 2.0.1 (latest)
• 2.0.0
• 1.5.5
• 1.4.2
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.5

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class 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.

Generated from protobuf message google.cloud.networkconnectivity.v1.Hub

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	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}
↳ create_time	Google\Protobuf\Timestamp Output only. The time the hub was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The time the hub was last updated.
↳ labels	array|Google\Protobuf\Internal\MapField Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
↳ description	string An optional description of the hub.
↳ unique_id	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.
↳ state	int Output only. The current lifecycle state of this hub.
↳ routing_vpcs	array<Google\Cloud\NetworkConnectivity\V1\RoutingVPC> The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.
↳ route_tables	array 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.
↳ spoke_summary	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.

getName

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
Type	Description
string

setName

Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. The time the hub was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the hub was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time the hub was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the hub was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

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

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDescription

An optional description of the hub.

Returns
Type	Description
string

setDescription

An optional description of the hub.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUniqueId

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.

Returns
Type	Description
string

setUniqueId

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. The current lifecycle state of this hub.

Returns
Type	Description
int

setState

Output only. The current lifecycle state of this hub.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRoutingVpcs

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRoutingVpcs

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

Parameter
Name	Description
var	array<Google\Cloud\NetworkConnectivity\V1\RoutingVPC>

Returns
Type	Description
$this

getRouteTables

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRouteTables

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getSpokeSummary

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.

Returns
Type	Description
Google\Cloud\NetworkConnectivity\V1\SpokeSummary|null

hasSpokeSummary

clearSpokeSummary

setSpokeSummary

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.

Parameter
Name	Description
var	Google\Cloud\NetworkConnectivity\V1\SpokeSummary

Returns
Type	Description
$this