transfer_resources
Creates, updates, deletes, gets or lists a transfer_resources resource.
Overview
| Name | transfer_resources |
| Type | Resource |
| Id | google.bigquerydatatransfer.transfer_resources |
Fields
The following fields are returned by SELECT queries:
- projects_locations_transfer_configs_transfer_resources_get
- projects_transfer_configs_transfer_resources_get
- projects_locations_transfer_configs_transfer_resources_list
- projects_transfer_configs_transfer_resources_list
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. Resource name. |
destination | string | Optional. Resource destination. (RESOURCE_DESTINATION_UNSPECIFIED, RESOURCE_DESTINATION_BIGQUERY, RESOURCE_DESTINATION_DATAPROC_METASTORE, RESOURCE_DESTINATION_BIGLAKE_METASTORE, RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG, RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG) |
hierarchyDetail | object | Optional. Details about the hierarchy. (id: HierarchyDetail) |
lastSuccessfulRun | object | Output only. Run details for the last successful run. (id: TransferRunBrief) |
latestRun | object | Optional. Run details for the latest run. (id: TransferRunBrief) |
latestStatusDetail | object | Optional. Status details for the latest run. (id: TransferResourceStatusDetail) |
type | string | Optional. Resource type. (RESOURCE_TYPE_UNSPECIFIED, RESOURCE_TYPE_TABLE, RESOURCE_TYPE_PARTITION) |
updateTime | string (google-datetime) | Output only. Time when the resource was last updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. Resource name. |
destination | string | Optional. Resource destination. (RESOURCE_DESTINATION_UNSPECIFIED, RESOURCE_DESTINATION_BIGQUERY, RESOURCE_DESTINATION_DATAPROC_METASTORE, RESOURCE_DESTINATION_BIGLAKE_METASTORE, RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG, RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG) |
hierarchyDetail | object | Optional. Details about the hierarchy. (id: HierarchyDetail) |
lastSuccessfulRun | object | Output only. Run details for the last successful run. (id: TransferRunBrief) |
latestRun | object | Optional. Run details for the latest run. (id: TransferRunBrief) |
latestStatusDetail | object | Optional. Status details for the latest run. (id: TransferResourceStatusDetail) |
type | string | Optional. Resource type. (RESOURCE_TYPE_UNSPECIFIED, RESOURCE_TYPE_TABLE, RESOURCE_TYPE_PARTITION) |
updateTime | string (google-datetime) | Output only. Time when the resource was last updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. Resource name. |
destination | string | Optional. Resource destination. (RESOURCE_DESTINATION_UNSPECIFIED, RESOURCE_DESTINATION_BIGQUERY, RESOURCE_DESTINATION_DATAPROC_METASTORE, RESOURCE_DESTINATION_BIGLAKE_METASTORE, RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG, RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG) |
hierarchyDetail | object | Optional. Details about the hierarchy. (id: HierarchyDetail) |
lastSuccessfulRun | object | Output only. Run details for the last successful run. (id: TransferRunBrief) |
latestRun | object | Optional. Run details for the latest run. (id: TransferRunBrief) |
latestStatusDetail | object | Optional. Status details for the latest run. (id: TransferResourceStatusDetail) |
type | string | Optional. Resource type. (RESOURCE_TYPE_UNSPECIFIED, RESOURCE_TYPE_TABLE, RESOURCE_TYPE_PARTITION) |
updateTime | string (google-datetime) | Output only. Time when the resource was last updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. Resource name. |
destination | string | Optional. Resource destination. (RESOURCE_DESTINATION_UNSPECIFIED, RESOURCE_DESTINATION_BIGQUERY, RESOURCE_DESTINATION_DATAPROC_METASTORE, RESOURCE_DESTINATION_BIGLAKE_METASTORE, RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG, RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG) |
hierarchyDetail | object | Optional. Details about the hierarchy. (id: HierarchyDetail) |
lastSuccessfulRun | object | Output only. Run details for the last successful run. (id: TransferRunBrief) |
latestRun | object | Optional. Run details for the latest run. (id: TransferRunBrief) |
latestStatusDetail | object | Optional. Status details for the latest run. (id: TransferResourceStatusDetail) |
type | string | Optional. Resource type. (RESOURCE_TYPE_UNSPECIFIED, RESOURCE_TYPE_TABLE, RESOURCE_TYPE_PARTITION) |
updateTime | string (google-datetime) | Output only. Time when the resource was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
projects_locations_transfer_configs_transfer_resources_get | select | projectsId, locationsId, transferConfigsId, transferResourcesId | Returns a transfer resource. | |
projects_transfer_configs_transfer_resources_get | select | projectsId, transferConfigsId, transferResourcesId | Returns a transfer resource. | |
projects_locations_transfer_configs_transfer_resources_list | select | projectsId, locationsId, transferConfigsId | pageSize, pageToken, filter | Returns information about transfer resources. |
projects_transfer_configs_transfer_resources_list | select | projectsId, transferConfigsId | pageSize, pageToken, filter | Returns information about transfer resources. |
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 | |
transferConfigsId | string | |
transferResourcesId | string | |
filter | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT examples
- projects_locations_transfer_configs_transfer_resources_get
- projects_transfer_configs_transfer_resources_get
- projects_locations_transfer_configs_transfer_resources_list
- projects_transfer_configs_transfer_resources_list
Returns a transfer resource.
SELECT
name,
destination,
hierarchyDetail,
lastSuccessfulRun,
latestRun,
latestStatusDetail,
type,
updateTime
FROM google.bigquerydatatransfer.transfer_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND transferResourcesId = '{{ transferResourcesId }}' -- required
;
Returns a transfer resource.
SELECT
name,
destination,
hierarchyDetail,
lastSuccessfulRun,
latestRun,
latestStatusDetail,
type,
updateTime
FROM google.bigquerydatatransfer.transfer_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND transferResourcesId = '{{ transferResourcesId }}' -- required
;
Returns information about transfer resources.
SELECT
name,
destination,
hierarchyDetail,
lastSuccessfulRun,
latestRun,
latestStatusDetail,
type,
updateTime
FROM google.bigquerydatatransfer.transfer_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;
Returns information about transfer resources.
SELECT
name,
destination,
hierarchyDetail,
lastSuccessfulRun,
latestRun,
latestStatusDetail,
type,
updateTime
FROM google.bigquerydatatransfer.transfer_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND transferConfigsId = '{{ transferConfigsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;