REST Resource: projects.locations.spokes

Resource: Spoke

A Network Connectivity Center spoke represents one or more network connectivity resources.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

  • linkedVpnTunnels
  • linkedInterconnectAttachments
  • linkedRouterApplianceInstances
  • linkedVpcNetwork
JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "hub": string,
  "group": string,
  "linkedVpnTunnels": {
    object (LinkedVpnTunnels)
  },
  "linkedInterconnectAttachments": {
    object (LinkedInterconnectAttachments)
  },
  "linkedRouterApplianceInstances": {
    object (LinkedRouterApplianceInstances)
  },
  "linkedVpcNetwork": {
    object (LinkedVpcNetwork)
  },
  "linkedProducerVpcNetwork": {
    object (LinkedProducerVpcNetwork)
  },
  "uniqueId": string,
  "state": enum (State),
  "reasons": [
    {
      object (StateReason)
    }
  ],
  "spokeType": enum (SpokeType),
  "etag": string,
  "fieldPathsPendingUpdate": [
    string
  ]
}
Fields
name

string

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{projectNumber}/locations/{region}/spokes/{spokeId}
createTime

string (Timestamp format)

Output only. The time the spoke was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time the spoke was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional labels in key-value pair 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

Optional. An optional description of the spoke.
hub

string

Immutable. The name of the hub that this spoke is attached to.
group

string

Optional. The name of the group that this spoke is associated with.
linkedVpnTunnels

object (LinkedVpnTunnels)

Optional. VPN tunnels that are associated with the spoke.
linkedInterconnectAttachments

object (LinkedInterconnectAttachments)

Optional. VLAN attachments that are associated with the spoke.
linkedRouterApplianceInstances

object (LinkedRouterApplianceInstances)

Optional. Router appliance instances that are associated with the spoke.
linkedVpcNetwork

object (LinkedVpcNetwork)

Optional. VPC network that is associated with the spoke.
linkedProducerVpcNetwork

object (LinkedProducerVpcNetwork)

Optional. The linked producer VPC that is associated with the spoke.
uniqueId

string

Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different uniqueId.
state

enum (State)

Output only. The current lifecycle state of this spoke.
reasons[]

object (StateReason)

Output only. The reasons for current state of the spoke.
spokeType

enum (SpokeType)

Output only. The type of resource associated with the spoke.
etag

string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
fieldPathsPendingUpdate[]

string

Optional. The list of fields waiting for hub administration's approval.

Methods

create

 Creates a Network Connectivity Center spoke.

delete

 Deletes a Network Connectivity Center spoke.

get

 Gets details about a Network Connectivity Center spoke.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists the Network Connectivity Center spokes in a specified project and location.

patch

 Updates the parameters of a Network Connectivity Center spoke.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.