groups

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

Overview

Name	groups
Type	Resource
Id	google.vmmigration.groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The Group name.
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the group.
displayName	string	Display name is a user defined name for this group which can be updated.
migrationTargetType	string	Immutable. The target type of this group.
updateTime	string (google-datetime)	Output only. The update time timestamp.

list

Successful response

Name	Datatype	Description
name	string	Output only. The Group name.
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the group.
displayName	string	Display name is a user defined name for this group which can be updated.
migrationTargetType	string	Immutable. The target type of this group.
updateTime	string (google-datetime)	Output only. The update time timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, groupsId		Gets details of a single Group.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Groups in a given project and location.
create	insert	projectsId, locationsId	groupId, requestId	Creates a new Group in a given project and location.
patch	update	projectsId, locationsId, groupsId	updateMask, requestId	Updates the parameters of a single Group.
delete	delete	projectsId, locationsId, groupsId	requestId	Deletes a single 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
locationsId	string
projectsId	string
filter	string
groupId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Group.

SELECT
name,
createTime,
description,
displayName,
migrationTargetType,
updateTime
FROM google.vmmigration.groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND groupsId = '{{ groupsId }}' -- required;

list

Lists Groups in a given project and location.

SELECT
name,
createTime,
description,
displayName,
migrationTargetType,
updateTime
FROM google.vmmigration.groups
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 new Group in a given project and location.

INSERT INTO google.vmmigration.groups (
data__description,
data__displayName,
data__migrationTargetType,
projectsId,
locationsId,
groupId,
requestId
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ migrationTargetType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ groupId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the groups resource.
    - name: description
      value: string
      description: >
        User-provided description of the group.
        
    - name: displayName
      value: string
      description: >
        Display name is a user defined name for this group which can be updated.
        
    - name: migrationTargetType
      value: string
      description: >
        Immutable. The target type of this group.
        
      valid_values: ['MIGRATION_TARGET_TYPE_UNSPECIFIED', 'MIGRATION_TARGET_TYPE_GCE', 'MIGRATION_TARGET_TYPE_DISKS']
    - name: groupId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single Group.

UPDATE google.vmmigration.groups
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__migrationTargetType = '{{ migrationTargetType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND groupsId = '{{ groupsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Group.

DELETE FROM google.vmmigration.groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND groupsId = '{{ groupsId }}' --required
AND requestId = '{{ requestId }}';