sources

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

Overview

Name	sources
Type	Resource
Id	google.vmmigration.sources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The Source name.
aws	object	AWS type source details. (id: AwsSourceDetails)
azure	object	Azure type source details. (id: AzureSourceDetails)
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the source.
encryption	object	Optional. Immutable. The encryption details of the source data stored by the service. (id: Encryption)
labels	object	The labels of the source.
updateTime	string (google-datetime)	Output only. The update time timestamp.
vmware	object	Vmware type source details. (id: VmwareSourceDetails)

list

Name	Datatype	Description
name	string	Output only. The Source name.
aws	object	AWS type source details. (id: AwsSourceDetails)
azure	object	Azure type source details. (id: AzureSourceDetails)
createTime	string (google-datetime)	Output only. The create time timestamp.
description	string	User-provided description of the source.
encryption	object	Optional. Immutable. The encryption details of the source data stored by the service. (id: Encryption)
labels	object	The labels of the source.
updateTime	string (google-datetime)	Output only. The update time timestamp.
vmware	object	Vmware type source details. (id: VmwareSourceDetails)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, sourcesId		Gets details of a single Source.
list	select	projectsId, locationsId	pageToken, pageSize, filter, orderBy	Lists Sources in a given project and location.
create	insert	projectsId, locationsId	sourceId, requestId	Creates a new Source in a given project and location.
patch	update	projectsId, locationsId, sourcesId	updateMask, requestId	Updates the parameters of a single Source.
delete	delete	projectsId, locationsId, sourcesId	requestId	Deletes a single Source.

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

SELECT examples

get

Gets details of a single Source.

SELECT
name,
aws,
azure,
createTime,
description,
encryption,
labels,
updateTime,
vmware
FROM google.vmmigration.sources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
;

list

Lists Sources in a given project and location.

SELECT
name,
aws,
azure,
createTime,
description,
encryption,
labels,
updateTime,
vmware
FROM google.vmmigration.sources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new Source in a given project and location.

INSERT INTO google.vmmigration.sources (
data__azure,
data__encryption,
data__aws,
data__labels,
data__vmware,
data__description,
projectsId,
locationsId,
sourceId,
requestId
)
SELECT 
'{{ azure }}',
'{{ encryption }}',
'{{ aws }}',
'{{ labels }}',
'{{ vmware }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sourceId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: sources
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the sources resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the sources resource.
  - name: azure
    description: |
      Azure type source details.
    value:
      error:
        code: {{ code }}
        details: "{{ details }}"
        message: "{{ message }}"
      resourceGroupId: "{{ resourceGroupId }}"
      subscriptionId: "{{ subscriptionId }}"
      migrationResourcesUserTags: "{{ migrationResourcesUserTags }}"
      clientSecretCreds:
        tenantId: "{{ tenantId }}"
        clientSecret: "{{ clientSecret }}"
        clientId: "{{ clientId }}"
      azureLocation: "{{ azureLocation }}"
      state: "{{ state }}"
  - name: encryption
    description: |
      Optional. Immutable. The encryption details of the source data stored by the service.
    value:
      kmsKey: "{{ kmsKey }}"
  - name: aws
    description: |
      AWS type source details.
    value:
      accessKeyCreds:
        secretAccessKey: "{{ secretAccessKey }}"
        accessKeyId: "{{ accessKeyId }}"
        sessionToken: "{{ sessionToken }}"
      state: "{{ state }}"
      publicIp: "{{ publicIp }}"
      error:
        code: {{ code }}
        details: "{{ details }}"
        message: "{{ message }}"
      inventoryTagList:
        - key: "{{ key }}"
          value: "{{ value }}"
      inventorySecurityGroupNames:
        - "{{ inventorySecurityGroupNames }}"
      awsRegion: "{{ awsRegion }}"
      migrationResourcesUserTags: "{{ migrationResourcesUserTags }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      The labels of the source.
  - name: vmware
    description: |
      Vmware type source details.
    value:
      username: "{{ username }}"
      password: "{{ password }}"
      vcenterIp: "{{ vcenterIp }}"
      thumbprint: "{{ thumbprint }}"
      resolvedVcenterHost: "{{ resolvedVcenterHost }}"
  - name: description
    value: "{{ description }}"
    description: |
      User-provided description of the source.
  - name: sourceId
    value: "{{ sourceId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single Source.

UPDATE google.vmmigration.sources
SET 
data__azure = '{{ azure }}',
data__encryption = '{{ encryption }}',
data__aws = '{{ aws }}',
data__labels = '{{ labels }}',
data__vmware = '{{ vmware }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Source.

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