collectors

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

Overview

Name	collectors
Type	Resource
Id	google.rapidmigrationassessment.collectors

Fields

Name	Datatype	Description
name	string	name of resource.
description	string	User specified description of the Collector.
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	How many days to collect data.
createTime	string	Output only. Create time stamp.
displayName	string	User specified name of the Collector.
eulaUri	string	Uri for EULA (End User License Agreement) from customer.
expectedAssetCount	string	User specified expected asset count.
guestOsScan	object	Message describing a MC Source of type Guest OS Scan.
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	Output only. Update time stamp.
vsphereScan	object	Message describing a MC Source of type VSphere Scan.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	collectorsId, locationsId, projectsId	Gets details of a single Collector.
list	SELECT	locationsId, projectsId	Lists Collectors in a given project and location.
create	INSERT	locationsId, projectsId	Create a Collector to manage the on-prem appliance which collects information about Customer assets.
delete	DELETE	collectorsId, locationsId, projectsId	Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.
patch	UPDATE	collectorsId, locationsId, projectsId	Updates the parameters of a single Collector.
pause	EXEC	collectorsId, locationsId, projectsId	Pauses the given collector.
register	EXEC	collectorsId, locationsId, projectsId	Registers the given collector.
resume	EXEC	collectorsId, locationsId, projectsId	Resumes the given collector.

SELECT examples

Lists Collectors in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new collectors resource.

All Properties

/*+ create */
INSERT INTO google.rapidmigrationassessment.collectors (
locationsId,
projectsId,
name,
labels,
displayName,
description,
serviceAccount,
expectedAssetCount,
collectionDays,
eulaUri
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ description }}',
'{{ serviceAccount }}',
'{{ expectedAssetCount }}',
'{{ collectionDays }}',
'{{ eulaUri }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: displayName
      value: string
    - name: description
      value: string
    - name: serviceAccount
      value: string
    - name: bucket
      value: string
    - name: expectedAssetCount
      value: string
    - name: state
      value: string
    - name: clientVersion
      value: string
    - name: guestOsScan
      value:
        - name: coreSource
          value: string
    - name: vsphereScan
      value:
        - name: coreSource
          value: string
    - name: collectionDays
      value: integer
    - name: eulaUri
      value: string

UPDATE example

Updates a collectors resource.

/*+ update */
UPDATE google.rapidmigrationassessment.collectors
SET 
name = '{{ name }}',
labels = '{{ labels }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
serviceAccount = '{{ serviceAccount }}',
expectedAssetCount = '{{ expectedAssetCount }}',
collectionDays = '{{ collectionDays }}',
eulaUri = '{{ eulaUri }}'
WHERE 
collectorsId = '{{ collectorsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified collectors resource.

/*+ delete */
DELETE FROM google.rapidmigrationassessment.collectors
WHERE collectorsId = '{{ collectorsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';