report_configs

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

Overview

Name	report_configs
Type	Resource
Id	google.migrationcenter.report_configs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of resource.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Free-text description.
displayName	string	User-friendly display name. Maximum length is 63 characters.
groupPreferencesetAssignments	array	Required. Collection of combinations of groups and preference sets.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of resource.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Free-text description.
displayName	string	User-friendly display name. Maximum length is 63 characters.
groupPreferencesetAssignments	array	Required. Collection of combinations of groups and preference sets.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, reportConfigsId		Gets details of a single ReportConfig.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists ReportConfigs in a given project and location.
create	insert	projectsId, locationsId	reportConfigId, requestId	Creates a report configuration.
delete	delete	projectsId, locationsId, reportConfigsId	requestId, force	Deletes a ReportConfig.

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
locationsId	string
projectsId	string
reportConfigsId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
reportConfigId	string
requestId	string

SELECT examples

get

Gets details of a single ReportConfig.

SELECT
name,
createTime,
description,
displayName,
groupPreferencesetAssignments,
updateTime
FROM google.migrationcenter.report_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reportConfigsId = '{{ reportConfigsId }}' -- required;

list

Lists ReportConfigs in a given project and location.

SELECT
name,
createTime,
description,
displayName,
groupPreferencesetAssignments,
updateTime
FROM google.migrationcenter.report_configs
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 report configuration.

INSERT INTO google.migrationcenter.report_configs (
data__displayName,
data__description,
data__groupPreferencesetAssignments,
projectsId,
locationsId,
reportConfigId,
requestId
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ groupPreferencesetAssignments }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ reportConfigId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: report_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the report_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the report_configs resource.
    - name: displayName
      value: string
      description: >
        User-friendly display name. Maximum length is 63 characters.
        
    - name: description
      value: string
      description: >
        Free-text description.
        
    - name: groupPreferencesetAssignments
      value: array
      description: >
        Required. Collection of combinations of groups and preference sets.
        
    - name: reportConfigId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Deletes a ReportConfig.

DELETE FROM google.migrationcenter.report_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reportConfigsId = '{{ reportConfigsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}';