Skip to main content

objects

Creates, updates, deletes, gets or lists an objects resource.

Overview​

Nameobjects
TypeResource
Idgoogle.datamigration.objects

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe object's name.
createTimestring (google-datetime)Output only. The creation time of the migration job object.
errorobjectOutput only. The error details in case of failure. (id: Status)
heterogeneousMetadataobjectOutput only. Metadata for heterogeneous migration jobs objects. (id: HeterogeneousMetadata)
phasestringOutput only. The phase of the migration job object. (PHASE_UNSPECIFIED, FULL_DUMP, CDC, READY_FOR_PROMOTE, PROMOTE_IN_PROGRESS, PROMOTED, DIFF_BACKUP, CREATING_BACKUP, RESTORING_BACKUP)
sourceObjectobjectThe object identifier in the data source. (id: SourceObjectIdentifier)
statestringThe state of the migration job object. (STATE_UNSPECIFIED, NOT_STARTED, RUNNING, STOPPING, STOPPED, RESTARTING, FAILED, REMOVING, NOT_SELECTED, COMPLETED)
updateTimestring (google-datetime)Output only. The last update time of the migration job object.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, migrationJobsId, objectsIdUse this method to get details about a migration job object.
listselectprojectsId, locationsId, migrationJobsIdpageSize, pageTokenUse this method to list the objects of a specific migration job.
lookupexecprojectsId, locationsId, migrationJobsIdUse this method to look up a migration job object by its source object identifier.

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.

NameDatatypeDescription
locationsIdstring
migrationJobsIdstring
objectsIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Use this method to get details about a migration job object.

SELECT
name,
createTime,
error,
heterogeneousMetadata,
phase,
sourceObject,
state,
updateTime
FROM google.datamigration.objects
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND migrationJobsId = '{{ migrationJobsId }}' -- required
AND objectsId = '{{ objectsId }}' -- required
;

Lifecycle Methods​

Use this method to look up a migration job object by its source object identifier.

EXEC google.datamigration.objects.lookup
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@migrationJobsId='{{ migrationJobsId }}' --required
@@json=
'{
"sourceObjectIdentifier": "{{ sourceObjectIdentifier }}"
}'
;