objects
Creates, updates, deletes, gets or lists an objects
resource.
Overview
Name | objects |
Type | Resource |
Id | google.datamigration.objects |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Successful response
Name | Datatype | Description |
---|---|---|
name | string | The object's name. |
createTime | string (google-datetime) | Output only. The creation time of the migration job object. |
error | object | Output only. The error details in case of failure. (id: Status) |
heterogeneousMetadata | object | Output only. Metadata for heterogeneous migration jobs objects. (id: HeterogeneousMetadata) |
phase | string | Output only. The phase of the migration job object. |
sourceObject | object | The object identifier in the data source. (id: SourceObjectIdentifier) |
state | string | The state of the migration job object. |
updateTime | string (google-datetime) | Output only. The last update time of the migration job object. |
Successful response
Name | Datatype | Description |
---|---|---|
name | string | The object's name. |
createTime | string (google-datetime) | Output only. The creation time of the migration job object. |
error | object | Output only. The error details in case of failure. (id: Status) |
heterogeneousMetadata | object | Output only. Metadata for heterogeneous migration jobs objects. (id: HeterogeneousMetadata) |
phase | string | Output only. The phase of the migration job object. |
sourceObject | object | The object identifier in the data source. (id: SourceObjectIdentifier) |
state | string | The state of the migration job object. |
updateTime | string (google-datetime) | Output only. The last update time of the migration job object. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | projectsId , locationsId , migrationJobsId , objectsId | Use this method to get details about a migration job object. | |
list | select | projectsId , locationsId , migrationJobsId | pageSize , pageToken | Use this method to list the objects of a specific migration job. |
lookup | exec | projectsId , locationsId , migrationJobsId | Use 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.
Name | Datatype | Description |
---|---|---|
locationsId | string | |
migrationJobsId | string | |
objectsId | string | |
projectsId | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT
examples
- get
- list
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;
Use this method to list the objects of a specific migration job.
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 pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
Lifecycle Methods
- lookup
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 }}"
}';