spokes

Creates, updates, deletes, gets or lists a spokes resource.

Overview

Name	spokes
Type	Resource
Id	google.networkconnectivity.spokes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
createTime	string (google-datetime)	Output only. The time the spoke was created.
description	string	Optional. An optional description of 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	array	Optional. The list of fields waiting for hub administration's approval.
group	string	Optional. The name of the group that this spoke is associated with.
hub	string	Immutable. The name of the hub that this spoke is attached to.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments	object	Optional. VLAN attachments that are associated with the spoke. (id: LinkedInterconnectAttachments)
linkedProducerVpcNetwork	object	Optional. The linked producer VPC that is associated with the spoke. (id: LinkedProducerVpcNetwork)
linkedRouterApplianceInstances	object	Optional. Router appliance instances that are associated with the spoke. (id: LinkedRouterApplianceInstances)
linkedVpcNetwork	object	Optional. VPC network that is associated with the spoke. (id: LinkedVpcNetwork)
linkedVpnTunnels	object	Optional. VPN tunnels that are associated with the spoke. (id: LinkedVpnTunnels)
reasons	array	Output only. The reasons for current state of the spoke.
spokeType	string	Output only. The type of resource associated with the spoke.
state	string	Output only. The current lifecycle state of this 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 unique_id.
updateTime	string (google-datetime)	Output only. The time the spoke was last updated.

list_spokes

Successful response

Name	Datatype	Description
name	string	Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
createTime	string (google-datetime)	Output only. The time the spoke was created.
description	string	Optional. An optional description of 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	array	Optional. The list of fields waiting for hub administration's approval.
group	string	Optional. The name of the group that this spoke is associated with.
hub	string	Immutable. The name of the hub that this spoke is attached to.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments	object	Optional. VLAN attachments that are associated with the spoke. (id: LinkedInterconnectAttachments)
linkedProducerVpcNetwork	object	Optional. The linked producer VPC that is associated with the spoke. (id: LinkedProducerVpcNetwork)
linkedRouterApplianceInstances	object	Optional. Router appliance instances that are associated with the spoke. (id: LinkedRouterApplianceInstances)
linkedVpcNetwork	object	Optional. VPC network that is associated with the spoke. (id: LinkedVpcNetwork)
linkedVpnTunnels	object	Optional. VPN tunnels that are associated with the spoke. (id: LinkedVpnTunnels)
reasons	array	Output only. The reasons for current state of the spoke.
spokeType	string	Output only. The type of resource associated with the spoke.
state	string	Output only. The current lifecycle state of this 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 unique_id.
updateTime	string (google-datetime)	Output only. The time the spoke was last updated.

list

Successful response

Name	Datatype	Description
name	string	Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
createTime	string (google-datetime)	Output only. The time the spoke was created.
description	string	Optional. An optional description of 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	array	Optional. The list of fields waiting for hub administration's approval.
group	string	Optional. The name of the group that this spoke is associated with.
hub	string	Immutable. The name of the hub that this spoke is attached to.
labels	object	Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments	object	Optional. VLAN attachments that are associated with the spoke. (id: LinkedInterconnectAttachments)
linkedProducerVpcNetwork	object	Optional. The linked producer VPC that is associated with the spoke. (id: LinkedProducerVpcNetwork)
linkedRouterApplianceInstances	object	Optional. Router appliance instances that are associated with the spoke. (id: LinkedRouterApplianceInstances)
linkedVpcNetwork	object	Optional. VPC network that is associated with the spoke. (id: LinkedVpcNetwork)
linkedVpnTunnels	object	Optional. VPN tunnels that are associated with the spoke. (id: LinkedVpnTunnels)
reasons	array	Output only. The reasons for current state of the spoke.
spokeType	string	Output only. The type of resource associated with the spoke.
state	string	Output only. The current lifecycle state of this 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 unique_id.
updateTime	string (google-datetime)	Output only. The time the spoke was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, spokesId		Gets details about a Network Connectivity Center spoke.
list_spokes	select	projectsId, hubsId	spokeLocations, pageSize, pageToken, filter, orderBy, view	Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists the Network Connectivity Center spokes in a specified project and location.
create	insert	projectsId, locationsId	spokeId, requestId	Creates a Network Connectivity Center spoke.
patch	update	projectsId, locationsId, spokesId	updateMask, requestId	Updates the parameters of a Network Connectivity Center spoke.
delete	delete	projectsId, locationsId, spokesId	requestId	Deletes a Network Connectivity Center spoke.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
hubsId	string
locationsId	string
projectsId	string
spokesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
spokeId	string
spokeLocations	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets details about a Network Connectivity Center spoke.

SELECT
name,
createTime,
description,
etag,
fieldPathsPendingUpdate,
group,
hub,
labels,
linkedInterconnectAttachments,
linkedProducerVpcNetwork,
linkedRouterApplianceInstances,
linkedVpcNetwork,
linkedVpnTunnels,
reasons,
spokeType,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.spokes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND spokesId = '{{ spokesId }}' -- required;

list_spokes

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

SELECT
name,
createTime,
description,
etag,
fieldPathsPendingUpdate,
group,
hub,
labels,
linkedInterconnectAttachments,
linkedProducerVpcNetwork,
linkedRouterApplianceInstances,
linkedVpcNetwork,
linkedVpnTunnels,
reasons,
spokeType,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.spokes
WHERE projectsId = '{{ projectsId }}' -- required
AND hubsId = '{{ hubsId }}' -- required
AND spokeLocations = '{{ spokeLocations }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND view = '{{ view }}';

list

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

SELECT
name,
createTime,
description,
etag,
fieldPathsPendingUpdate,
group,
hub,
labels,
linkedInterconnectAttachments,
linkedProducerVpcNetwork,
linkedRouterApplianceInstances,
linkedVpcNetwork,
linkedVpnTunnels,
reasons,
spokeType,
state,
uniqueId,
updateTime
FROM google.networkconnectivity.spokes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a Network Connectivity Center spoke.

INSERT INTO google.networkconnectivity.spokes (
data__name,
data__labels,
data__description,
data__hub,
data__group,
data__linkedVpnTunnels,
data__linkedInterconnectAttachments,
data__linkedRouterApplianceInstances,
data__linkedVpcNetwork,
data__linkedProducerVpcNetwork,
data__etag,
data__fieldPathsPendingUpdate,
projectsId,
locationsId,
spokeId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ hub }}',
'{{ group }}',
'{{ linkedVpnTunnels }}',
'{{ linkedInterconnectAttachments }}',
'{{ linkedRouterApplianceInstances }}',
'{{ linkedVpcNetwork }}',
'{{ linkedProducerVpcNetwork }}',
'{{ etag }}',
'{{ fieldPathsPendingUpdate }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ spokeId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: spokes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the spokes resource.
    - name: locationsId
      value: string
      description: Required parameter for the spokes resource.
    - name: name
      value: string
      description: >
        Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}`
        
    - name: labels
      value: object
      description: >
        Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
        
    - name: description
      value: string
      description: >
        Optional. An optional description of the spoke.
        
    - name: hub
      value: string
      description: >
        Immutable. The name of the hub that this spoke is attached to.
        
    - name: group
      value: string
      description: >
        Optional. The name of the group that this spoke is associated with.
        
    - name: linkedVpnTunnels
      value: object
      description: >
        Optional. VPN tunnels that are associated with the spoke.
        
    - name: linkedInterconnectAttachments
      value: object
      description: >
        Optional. VLAN attachments that are associated with the spoke.
        
    - name: linkedRouterApplianceInstances
      value: object
      description: >
        Optional. Router appliance instances that are associated with the spoke.
        
    - name: linkedVpcNetwork
      value: object
      description: >
        Optional. VPC network that is associated with the spoke.
        
    - name: linkedProducerVpcNetwork
      value: object
      description: >
        Optional. The linked producer VPC that is associated with the spoke.
        
    - name: etag
      value: string
      description: >
        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.
        
    - name: fieldPathsPendingUpdate
      value: array
      description: >
        Optional. The list of fields waiting for hub administration's approval.
        
    - name: spokeId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a Network Connectivity Center spoke.

UPDATE google.networkconnectivity.spokes
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__hub = '{{ hub }}',
data__group = '{{ group }}',
data__linkedVpnTunnels = '{{ linkedVpnTunnels }}',
data__linkedInterconnectAttachments = '{{ linkedInterconnectAttachments }}',
data__linkedRouterApplianceInstances = '{{ linkedRouterApplianceInstances }}',
data__linkedVpcNetwork = '{{ linkedVpcNetwork }}',
data__linkedProducerVpcNetwork = '{{ linkedProducerVpcNetwork }}',
data__etag = '{{ etag }}',
data__fieldPathsPendingUpdate = '{{ fieldPathsPendingUpdate }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND spokesId = '{{ spokesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a Network Connectivity Center spoke.

DELETE FROM google.networkconnectivity.spokes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND spokesId = '{{ spokesId }}' --required
AND requestId = '{{ requestId }}';