REST Resource: projects.locations.global.hubs

Stay organized with collections Save and categorize content based on your preferences.

Resource: Hub

A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the data transfer feature, the resources associated with those spokes must all reside in the same VPC network. Spokes that do not use data transfer can be associated with any VPC network in your project.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "uniqueId": string,
  "state": enum (State),
  "routingVpcs": [
    {
      object (RoutingVPC)
    }
  ]
}
Fields
name

string

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

createTime

string (Timestamp format)

Output only. The time the hub was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The time the hub was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

An optional description of the hub.

uniqueId

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

state

enum (State)

Output only. The current lifecycle state of this hub.

routingVpcs[]

object (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.

RoutingVPC

RoutingVPC contains information about the VPC networks that are associated with a hub's spokes.

JSON representation
{
  "uri": string,
  "requiredForNewSiteToSiteDataTransferSpokes": boolean
}
Fields
uri

string

The URI of the VPC network.

requiredForNewSiteToSiteDataTransferSpokes

boolean

Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the siteToSiteDataTransfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. At most, one VPC network will have this field set to true.

Methods

create

Creates a new hub in the specified project.

delete

Deletes the specified hub.

get

Gets details about the specified hub.

getIamPolicy

Gets the access control policy for a resource.

list

Lists hubs in a given project.

patch

Updates the description and/or labels of the specified hub.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.