REST Resource: projects.locations.transferConfigs.transferResources

Resource: TransferResource

Resource (table/partition) that is being transferred.

JSON representation 
{
  "name": string,
  "type": enum (ResourceType),
  "destination": enum (ResourceDestination),
  "latestRun": {
    object (TransferRunBrief)
  },
  "latestStatusDetail": {
    object (TransferResourceStatusDetail)
  },
  "lastSuccessfulRun": {
    object (TransferRunBrief)
  },
  "hierarchyDetail": {
    object (HierarchyDetail)
  },
  "updateTime": string
}
Fields
name

string

Identifier. Resource name.
type

enum (ResourceType)

Optional. Resource type.
destination

enum (ResourceDestination)

Optional. Resource destination.
latestRun

object (TransferRunBrief)

Optional. Run details for the latest run.
latestStatusDetail

object (TransferResourceStatusDetail)

Optional. Status details for the latest run.
lastSuccessfulRun

object (TransferRunBrief)

Output only. Run details for the last successful run.
hierarchyDetail

object (HierarchyDetail)

Optional. Details about the hierarchy.
updateTime

string (Timestamp format)

Output only. Time when the resource was last updated.

ResourceType

Type of resource being transferred.

Enums
RESOURCE_TYPE_UNSPECIFIED Default value.
RESOURCE_TYPE_TABLE Table resource type.
RESOURCE_TYPE_PARTITION Partition resource type.

ResourceDestination

The destination for a transferred resource.

Enums
RESOURCE_DESTINATION_UNSPECIFIED Default value.
RESOURCE_DESTINATION_BIGQUERY BigQuery.
RESOURCE_DESTINATION_DATAPROC_METASTORE Dataproc Metastore.
RESOURCE_DESTINATION_BIGLAKE_METASTORE BigLake Metastore.
RESOURCE_DESTINATION_BIGLAKE_REST_CATALOG BigLake REST Catalog.
RESOURCE_DESTINATION_BIGLAKE_HIVE_CATALOG BigLake Hive Catalog.

TransferRunBrief

Basic information about a transfer run.

JSON representation 
{
  "run": string,
  "startTime": string
}
Fields
run

string

Optional. Run URI. The format must be: projects/{project}/locations/{location}/transferConfigs/{transferConfig}/run/{run}
startTime

string (Timestamp format)

Optional. Start time of the transfer run.

TransferResourceStatusDetail

Status details of the resource being transferred.

JSON representation 
{
  "state": enum (ResourceTransferState),
  "summary": {
    object (TransferStatusSummary)
  },
  "error": {
    object (Status)
  },
  "completedPercentage": number
}
Fields
state

enum (ResourceTransferState)

Optional. Transfer state of the resource.
summary

object (TransferStatusSummary)

Optional. Transfer status summary of the resource.
error

object (Status)

Optional. Transfer error details for the resource.
completedPercentage

number

Output only. Percentage of the transfer completed. Valid values: 0-100.

ResourceTransferState

The transfer state of an individual resource (e.g., a table or partition). This may differ from the overall transfer run's state. For instance, a resource can be transferred successfully even if the run as a whole fails.

Enums
RESOURCE_TRANSFER_STATE_UNSPECIFIED Default value.
RESOURCE_TRANSFER_PENDING Resource is waiting to be transferred.
RESOURCE_TRANSFER_RUNNING Resource transfer is running.
RESOURCE_TRANSFER_SUCCEEDED Resource transfer is a success.
RESOURCE_TRANSFER_FAILED Resource transfer failed.
RESOURCE_TRANSFER_CANCELLED Resource transfer was cancelled.

TransferStatusSummary

Status summary of the resource being transferred.

JSON representation 
{
  "metrics": [
    {
      object (TransferStatusMetric)
    }
  ],
  "progressUnit": enum (TransferStatusUnit)
}
Fields
metrics[]

object (TransferStatusMetric)

Optional. List of transfer status metrics.
progressUnit

enum (TransferStatusUnit)

Input only. Unit based on which transfer status progress should be calculated.

TransferStatusMetric

Metrics for tracking the transfer status.

JSON representation 
{
  "completed": string,
  "pending": string,
  "failed": string,
  "total": string,
  "unit": enum (TransferStatusUnit)
}
Fields
completed

string (int64 format)

Optional. Number of units transferred successfully.
pending

string (int64 format)

Optional. Number of units pending transfer.
failed

string (int64 format)

Optional. Number of units that failed to transfer.
total

string (int64 format)

Optional. Total number of units for the transfer.
unit

enum (TransferStatusUnit)

Optional. Unit for measuring progress (e.g., BYTES).

TransferStatusUnit

Unit of the transfer status.

Enums
TRANSFER_STATUS_UNIT_UNSPECIFIED Default value.
TRANSFER_STATUS_UNIT_BYTES Bytes.
TRANSFER_STATUS_UNIT_OBJECTS Objects.

HierarchyDetail

Details about the hierarchy.

JSON representation 
{

  // Union field detail can be only one of the following:
  "tableDetail": {
    object (TableDetail)
  },
  "partitionDetail": {
    object (PartitionDetail)
  }
  // End of list of possible types for union field detail.
}
Fields
Union field detail. Details about the hierarchy can be one of table/partition. detail can be only one of the following:
tableDetail

object (TableDetail)

Optional. Table details related to hierarchy.
partitionDetail

object (PartitionDetail)

Optional. Partition details related to hierarchy.

TableDetail

Table details related to hierarchy.

JSON representation 
{
  "partitionCount": string
}
Fields
partitionCount

string (int64 format)

Optional. Total number of partitions being tracked within the table.

PartitionDetail

Partition details related to hierarchy.

JSON representation 
{
  "table": string
}
Fields
table

string

Optional. Name of the table which has the partitions.

Methods

get

 Returns a transfer resource.

list

 Returns information about transfer resources.