collectors

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

Overview

Name	collectors
Type	Resource
Id	google.rapidmigrationassessment.collectors

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	name of resource.
bucket	string	Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
clientVersion	string	Output only. Client version.
collectionDays	integer (int32)	How many days to collect data.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	User specified description of the Collector.
displayName	string	User specified name of the Collector.
eulaUri	string	Uri for EULA (End User License Agreement) from customer.
expectedAssetCount	string (int64)	User specified expected asset count.
guestOsScan	object	Output only. Reference to MC Source Guest Os Scan. (id: GuestOsScan)
labels	object	Labels as key value pairs.
serviceAccount	string	Service Account email used to ingest data to this Collector.
state	string	Output only. State of the Collector.
updateTime	string (google-datetime)	Output only. Update time stamp.
vsphereScan	object	Output only. Reference to MC Source vsphere_scan. (id: VSphereScan)

list

Successful response

Name	Datatype	Description
name	string	name of resource.
bucket	string	Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
clientVersion	string	Output only. Client version.
collectionDays	integer (int32)	How many days to collect data.
createTime	string (google-datetime)	Output only. Create time stamp.
description	string	User specified description of the Collector.
displayName	string	User specified name of the Collector.
eulaUri	string	Uri for EULA (End User License Agreement) from customer.
expectedAssetCount	string (int64)	User specified expected asset count.
guestOsScan	object	Output only. Reference to MC Source Guest Os Scan. (id: GuestOsScan)
labels	object	Labels as key value pairs.
serviceAccount	string	Service Account email used to ingest data to this Collector.
state	string	Output only. State of the Collector.
updateTime	string (google-datetime)	Output only. Update time stamp.
vsphereScan	object	Output only. Reference to MC Source vsphere_scan. (id: VSphereScan)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, collectorsId		Gets details of a single Collector.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Collectors in a given project and location.
create	insert	projectsId, locationsId	collectorId, requestId	Create a Collector to manage the on-prem appliance which collects information about Customer assets.
patch	update	projectsId, locationsId, collectorsId	updateMask, requestId	Updates the parameters of a single Collector.
delete	delete	projectsId, locationsId, collectorsId	requestId	Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion through producer API.
resume	exec	projectsId, locationsId, collectorsId		Resumes the given collector.
register	exec	projectsId, locationsId, collectorsId		Registers the given collector.
pause	exec	projectsId, locationsId, collectorsId		Pauses the given collector.

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

SELECT examples

get

Gets details of a single Collector.

SELECT
name,
bucket,
clientVersion,
collectionDays,
createTime,
description,
displayName,
eulaUri,
expectedAssetCount,
guestOsScan,
labels,
serviceAccount,
state,
updateTime,
vsphereScan
FROM google.rapidmigrationassessment.collectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectorsId = '{{ collectorsId }}' -- required;

list

Lists Collectors in a given project and location.

SELECT
name,
bucket,
clientVersion,
collectionDays,
createTime,
description,
displayName,
eulaUri,
expectedAssetCount,
guestOsScan,
labels,
serviceAccount,
state,
updateTime,
vsphereScan
FROM google.rapidmigrationassessment.collectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

INSERT INTO google.rapidmigrationassessment.collectors (
data__name,
data__labels,
data__displayName,
data__description,
data__serviceAccount,
data__expectedAssetCount,
data__collectionDays,
data__eulaUri,
projectsId,
locationsId,
collectorId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ description }}',
'{{ serviceAccount }}',
'{{ expectedAssetCount }}',
{{ collectionDays }},
'{{ eulaUri }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectorId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: collectors
  props:
    - name: projectsId
      value: string
      description: Required parameter for the collectors resource.
    - name: locationsId
      value: string
      description: Required parameter for the collectors resource.
    - name: name
      value: string
      description: >
        name of resource.
        
    - name: labels
      value: object
      description: >
        Labels as key value pairs.
        
    - name: displayName
      value: string
      description: >
        User specified name of the Collector.
        
    - name: description
      value: string
      description: >
        User specified description of the Collector.
        
    - name: serviceAccount
      value: string
      description: >
        Service Account email used to ingest data to this Collector.
        
    - name: expectedAssetCount
      value: string
      description: >
        User specified expected asset count.
        
    - name: collectionDays
      value: integer
      description: >
        How many days to collect data.
        
    - name: eulaUri
      value: string
      description: >
        Uri for EULA (End User License Agreement) from customer.
        
    - name: collectorId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single Collector.

UPDATE google.rapidmigrationassessment.collectors
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__serviceAccount = '{{ serviceAccount }}',
data__expectedAssetCount = '{{ expectedAssetCount }}',
data__collectionDays = {{ collectionDays }},
data__eulaUri = '{{ eulaUri }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectorsId = '{{ collectorsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion through producer API.

DELETE FROM google.rapidmigrationassessment.collectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectorsId = '{{ collectorsId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

resume

Resumes the given collector.

EXEC google.rapidmigrationassessment.collectors.resume 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectorsId='{{ collectorsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';

register

Registers the given collector.

EXEC google.rapidmigrationassessment.collectors.register 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectorsId='{{ collectorsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';

pause

Pauses the given collector.

EXEC google.rapidmigrationassessment.collectors.pause 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectorsId='{{ collectorsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';