REST Resource: projects.locations.jobs

资源：Job

介绍适用于 Apache Flink 的 BigQuery 引擎作业资源。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "deploymentId": string,
  "jobSpec": {
    object (JobSpec)
  },
  "displayGraph": {
    object (DisplayGraph)
  }
}
字段
name

string

标识符。作业的名称。
state

enum (State)

仅限输出。Apache Flink 作业的状态。
createTime

string (Timestamp format)

仅限输出。作业的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

仅限输出。上次更新作业的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

可选。用户定义的标签，以键值对的形式。
deploymentId

string

可选。此作业所属的部署。如果为空，则在临时按需 Apache Flink 集群中创建作业。
jobSpec

object (JobSpec)

必需。Apache Flink 作业的规范。
displayGraph

object (DisplayGraph)

仅限输出。Apache Flink 作业的显示图表。此字段仅在 GetAPI 调用时填充。系统不会在 ListAPI 调用中填充此值。

州

Apache Flink 作业的状态。这些状态基于 Apache Flink REST API。

枚举
STATE_UNSPECIFIED 状态未指定。
PENDING_CREATION 作业正在等待创建。
INITIALIZING 作业正在初始化。
CREATED 已创建作业。
RUNNING 作业正在运行。
FAILING 作业失败。
FAILED 作业已失败。
CANCELLING 作业正在取消。
CANCELLED 作业已取消。
FINISHED 作业已完成。
RESTARTING 作业正在重启。
SUSPENDED 作业已暂停。
RECONCILING 作业正在协调。

JobSpec

Apache Flink 作业的规范。

JSON 表示法 
{
  "jarUris": [
    string
  ],
  "jobGraphUri": string,
  "artifactUris": [
    string
  ],
  "autotuningConfig": {
    object (AutotuningConfig)
  },
  "networkConfig": {
    object (NetworkConfig)
  },
  "displayName": string,
  "jobName": string,
  "managedKafkaConfig": {
    object (ManagedKafkaConfig)
  },
  "jobGraphEncoding": string
}
字段
jarUris[]

string

可选。Cloud Storage 中作业 JAR 的 URI 列表。
jobGraphUri

string

必需。Cloud Storage 中的作业图 URI。
artifactUris[]

string

必需。Cloud Storage 中作业工件文件的 URI 列表。
autotuningConfig

object (AutotuningConfig)

可选。作业的自动调整配置。
networkConfig

object (NetworkConfig)

可选。作业的网络配置。
displayName

string

可选。作业的显示名称。此名称由用户明确设置。
jobName

string

可选。作业的作业名称。客户端会自动从作业图中派生此名称。
managedKafkaConfig

object (ManagedKafkaConfig)

可选。作业要使用的 Google Cloud Managed Service for Apache Kafka 集群的配置。
jobGraphEncoding

string

可选。作业图的编码类型。

AutotuningConfig

Apache Flink 作业的自动调整配置。

JSON 表示法 
{

  // Union field horizontal_autoscaling_policy can be only one of the following:
  "fixed": {
    object (Fixed)
  },
  "throughputBased": {
    object (Elastic)
  }
  // End of list of possible types for union field horizontal_autoscaling_policy.
}
字段
联合字段 horizontal_autoscaling_policy。作业的横向自动扩缩政策。horizontal_autoscaling_policy 只能是下列其中一项：
fixed

object (Fixed)

修复了用于停用自动扩缩的政策。
throughputBased

object (Elastic)

基于吞吐量的自动扩缩政策，可利用观察到的吞吐量和实际处理速率（估算的最大可实现吞吐量）来自动扩缩每个作业顶点的任务并行度。

固定

修复了用于停用自动扩缩的政策。

JSON 表示法 
{
  "parallelism": integer
}
字段
parallelism

integer

可选。作业的固定任务并行处理数。

Elastic

弹性自动扩缩政策，用于启用设有下限/上限的自动扩缩。

JSON 表示法 
{
  "parallelism": integer,
  "minParallelism": integer,
  "maxParallelism": integer
}
字段
parallelism

integer

可选。作业的初始任务并行处理数。
minParallelism

integer

可选。作业的任务并行处理数下限。
maxParallelism

integer

可选。作业的任务并行数量上限。

ManagedKafkaConfig

作业要使用的 Google Cloud Managed Service for Apache Kafka 集群的配置。

JSON 表示法 
{
  "managedKafkaClusters": [
    string
  ]
}
字段
managedKafkaClusters[]

string

可选。与作业关联的 Managed Service for Apache Kafka 集群的列表，采用以下格式指定：projects/<project-id>/locations/<region>/clusters/<cluster-name>。

DisplayGraph

作业的 Apache Flink 显示图表。

JSON 表示法 
{
  "displayGraphJson": string,
  "state": enum (State)
}
字段
displayGraphJson

string

仅限输出。JSON 格式的显示图表。
state

enum (State)

仅限输出。显示图表的状态。

州

用于定义显示图表状态的枚举。

枚举
STATE_UNSPECIFIED 未指定显示图表状态。
DISPLAY_GRAPH_POPULATED 系统会填充显示图表。
DISPLAY_GRAPH_TOO_LARGE 显示图表过大。
DISPLAY_GRAPH_EMPTY 显示图表为空。

方法

create

 在指定的项目和位置中创建新作业。

delete

 删除单个作业。

get

 获取单个作业的详细信息。

list

 列出指定项目和位置中的作业。

patch

 更新单个作业的参数。