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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ labels
array| Google\Protobuf\Internal\MapField
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
↳ description
string
Optional. 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< 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
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.
↳ policy_mode
int
Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.
↳ preset_topology
int
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.
↳ export_psc
bool
Optional. Whether Private Service Connect connection propagation 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.
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}
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}
var
string
$this
getCreateTime
Output only. The time the hub was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the hub was created.
$this
getUpdateTime
Output only. The time the hub was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the hub was last updated.
$this
getLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
setLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
$this
getDescription
Optional. An optional description of the hub.
string
setDescription
Optional. An optional description of the hub.
var
string
$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.
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.
var
string
$this
getState
Output only. The current lifecycle state of this hub.
int
setState
Output only. The current lifecycle state of this hub.
var
int
$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.
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.
$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.
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.
var
string[]
$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.
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.
$this
getPolicyMode
Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.
int
setPolicyMode
Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.
var
int
$this
getPresetTopology
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.
int
setPresetTopology
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.
var
int
$this
getExportPsc
Optional. Whether Private Service Connect connection propagation 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.
bool
hasExportPsc
clearExportPsc
setExportPsc
Optional. Whether Private Service Connect connection propagation 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.
var
bool
$this
