groups

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

Overview

Name	groups
Type	Resource
Id	google.networkconnectivity.groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Immutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}
autoAccept	object	Optional. The auto-accept setting for this group. (id: AutoAccept)
createTime	string (google-datetime)	Output only. The time the group was created.
description	string	Optional. The description of the group.
labels	object	Optional. Labels in key-value pair format. For more information about labels, see Requirements for labels.
routeTable	string	Output only. The name of the route table that corresponds to this group. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}
state	string	Output only. The current lifecycle state of this group.
uid	string	Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. The time the group was last updated.

list

Successful response

Name	Datatype	Description
name	string	Immutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}
autoAccept	object	Optional. The auto-accept setting for this group. (id: AutoAccept)
createTime	string (google-datetime)	Output only. The time the group was created.
description	string	Optional. The description of the group.
labels	object	Optional. Labels in key-value pair format. For more information about labels, see Requirements for labels.
routeTable	string	Output only. The name of the route table that corresponds to this group. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}
state	string	Output only. The current lifecycle state of this group.
uid	string	Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.
updateTime	string (google-datetime)	Output only. The time the group was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, hubsId, groupsId		Gets details about a Network Connectivity Center group.
list	select	projectsId, hubsId	pageSize, pageToken, filter, orderBy	Lists groups in a given hub.
patch	update	projectsId, hubsId, groupsId	updateMask, requestId	Updates the parameters of a Network Connectivity Center group.

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
groupsId	string
hubsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details about a Network Connectivity Center group.

SELECT
name,
autoAccept,
createTime,
description,
labels,
routeTable,
state,
uid,
updateTime
FROM google.networkconnectivity.groups
WHERE projectsId = '{{ projectsId }}' -- required
AND hubsId = '{{ hubsId }}' -- required
AND groupsId = '{{ groupsId }}' -- required;

list

Lists groups in a given hub.

SELECT
name,
autoAccept,
createTime,
description,
labels,
routeTable,
state,
uid,
updateTime
FROM google.networkconnectivity.groups
WHERE projectsId = '{{ projectsId }}' -- required
AND hubsId = '{{ hubsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

UPDATE examples

patch

Updates the parameters of a Network Connectivity Center group.

UPDATE google.networkconnectivity.groups
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__autoAccept = '{{ autoAccept }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND hubsId = '{{ hubsId }}' --required
AND groupsId = '{{ groupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;