REST Resource: projects.locations.global.hubs

Resource: Hub

A hub is a collection of spokes. A single hub can contain spokes from multiple regions. However, all of a hub's spokes must be associated with resources that reside in the same VPC network.

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 network associated with this hub's spokes. All of the VPN tunnels, VLAN attachments, and router appliance instances referenced by this hub's spokes must belong to this VPC network.

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 network that is associated with a hub's spokes.

JSON representation
{
  "uri": string
}
Fields
uri

string

The URI of the VPC network.

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.