REST 资源:projects.locations.transferConfigs.runs

资源:TransferRun

表示数据传输运行。

JSON 表示形式

{
  "name": string,
  "scheduleTime": string,
  "runTime": string,
  "errorStatus": {
    object (Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "params": {
    object
  },
  "dataSourceId": string,
  "state": enum (TransferState),
  "userId": string,
  "schedule": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
字段
name

string

转移作业运行的资源名称。转移作业运行名称采用 projects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id} 格式。创建转移作业运行时,系统将忽略该名称。

scheduleTime

string (Timestamp format)

在开始转移作业运行之前需要等待的最短时间。

runTime

string (Timestamp format)

对于批量转移作业运行,请指定应提取的数据的日期和时间。

errorStatus

object (Status)

转移作业运行的状态。

startTime

string (Timestamp format)

仅供输出。传输运行开始的时间。对于输入请求,服务器将忽略该参数。

endTime

string (Timestamp format)

仅供输出。传输运行结束的时间。对于输入请求,服务器将忽略该参数。

updateTime

string (Timestamp format)

仅供输出。数据转移作业运行状态的上次更新时间。

params

object (Struct format)

仅供输出。特定于数据转移作业的参数。

dataSourceId

string

仅供输出。数据源 ID。

state

enum (TransferState)

数据转移作业运行状态。对于输入请求,系统会忽略此参数。

userId

string (int64 format)

已弃用。用户的唯一 ID,转移作业由其他方代表该用户完成。

schedule

string

仅供输出。如果此转移作业运行是定期创建的,则说明其时间表。对于手动安排的批量转移作业运行,此字段为空。注意:系统可能会根据当前负载选择将时间安排往后推迟,因此 scheduleTime 不一定始终与此时间表相符。

notificationPubsubTopic

string

仅供输出。Pub/Sub 主题,系统将在此转移作业运行完成后通过该主题发送通知。

emailPreferences

object (EmailPreferences)

仅供输出。电子邮件通知将根据这些偏好设置发送到拥有相应转移作业配置(即派生了此运行的转移作业配置)的用户的电子邮件地址。

destinationDatasetId

string

仅供输出。BigQuery 目标数据集 ID。

状态

Status 类型定义了适用于不同编程环境(包括 REST API 和 RPC API)的逻辑错误模型。此类型供 gRPC 使用。每条 Status 消息包含三部分数据:错误代码、错误消息和错误详细信息。

如需详细了解该错误模型及其使用方法,请参阅 API 设计指南

JSON 表示法

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
字段
code

integer

状态代码,应为 google.rpc.Code 的枚举值。

message

string

面向开发者的错误消息(应采用英语)。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送,或者由客户端进行本地化。

details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。

可以包含任意类型字段的对象。附加字段 "@type" 包含用于标示相应类型的 URI。示例:{ "id": 1234, "@type": "types.example.com/standard/id" }

方法

delete

删除指定的转移作业运行。

get

返回特定转移作业运行的相关信息。

list

返回有关正在运行和已完成的作业的信息。