REST Resource: projects.locations.transferConfigs.runs

Resource: TransferRun

Represents a data transfer run. Next id: 23

JSON representation
{
  "name": string,
  "destinationDatasetId": string,
  "scheduleTime": string,
  "params": {
    object
  },
  "runTime": string,
  "errorStatus": {
    object(Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "dataSourceId": string,
  "state": enum(TransferState),
  "userId": string,
  "schedule": string,
}
Fields
name

string

The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.

destinationDatasetId

string

The BigQuery target dataset id.

scheduleTime

string (Timestamp format)

Minimum time after which a transfer run can be started.

params

object (Struct format)

Data transfer specific parameters.

runTime

string (Timestamp format)

For batch transfer runs, specifies the date and time that data should be ingested.

errorStatus

object(Status)

Status of the transfer run.

startTime

string (Timestamp format)

Output only. Time when transfer run was started. Parameter ignored by server for input requests.

endTime

string (Timestamp format)

Output only. Time when transfer run ended. Parameter ignored by server for input requests.

updateTime

string (Timestamp format)

Output only. Last time the data transfer run state was updated.

dataSourceId

string

Output only. Data source id.

state

enum(TransferState)

Data transfer run state. Ignored for input requests.

userId

string (int64 format)

Output only. Unique ID of the user on whose behalf transfer is done. Applicable only to data sources that do not support service accounts. When set to 0, the data source service account credentials are used. May be negative.

schedule

string

Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so scheduleTime doesn't always matches this.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs
Overview

The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.

Language mapping

The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.

  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.

  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.

  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.

  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.

JSON representation
{
  "code": number,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ],
}
Fields
code

number

The status code, which should be an enum value of google.rpc.Code.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

delete

Deletes the specified transfer run.

get

Returns information about the particular transfer run.

list

Returns information about running and completed jobs.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...