REST Resource: projects.locations.jobs

Resource: Job

Describes a BigQuery Engine for Apache Flink job resource.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "deploymentId": string,
  "jobSpec": {
    object (JobSpec)
  },
  "displayGraph": {
    object (DisplayGraph)
  }
}
Fields
name

string

Identifier. The name of the job.
state

enum (State)

Output only. The state of the Apache Flink job.
createTime

string (Timestamp format)

Output only. The time when the job was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the job was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. User defined labels as key value pairs.
deploymentId

string

Optional. The deployment that this job belongs to. If empty, the job is created in an ephemeral on-demand Apache Flink cluster.
jobSpec

object (JobSpec)

Required. The specification of the Apache Flink job.
displayGraph

object (DisplayGraph)

Output only. The display graph of the Apache Flink job. This is only populated on a GetAPI call. It is not populated on a ListAPI call.

State

The states of an Apache Flink job. The states are based on the Apache Flink REST API.

Enums
STATE_UNSPECIFIED State unspecified.
PENDING_CREATION Job is pending creation.
INITIALIZING Job is initializing.
CREATED Job has been created.
RUNNING Job is running.
FAILING Job is failing.
FAILED Job has failed.
CANCELLING Job is getting cancelled.
CANCELLED Job has been cancelled.
FINISHED Job has finished.
RESTARTING Job is restarting.
SUSPENDED Job has been suspended.
RECONCILING Job is reconciling.

JobSpec

The specification of the Apache Flink job.

JSON representation 
{
  "jarUris": [
    string
  ],
  "jobGraphUri": string,
  "artifactUris": [
    string
  ],
  "autotuningConfig": {
    object (AutotuningConfig)
  },
  "networkConfig": {
    object (NetworkConfig)
  },
  "displayName": string,
  "jobName": string,
  "managedKafkaConfig": {
    object (ManagedKafkaConfig)
  },
  "jobGraphEncoding": string
}
Fields
jarUris[]

string

Optional. The list of URIs for the job JARs in Cloud Storage.
jobGraphUri

string

Required. The job graph URI in Cloud Storage.
artifactUris[]

string

Required. The list of URIs for the job artifact files in Cloud Storage.
autotuningConfig

object (AutotuningConfig)

Optional. Autotuning configuration for the job.
networkConfig

object (NetworkConfig)

Optional. Network configuration for the job.
displayName

string

Optional. Display name of the job. This name is explicitly set by the user.
jobName

string

Optional. Job name of the job. The client automatically derives this name from the job graph.
managedKafkaConfig

object (ManagedKafkaConfig)

Optional. The configuration for the Google Cloud Managed Service for Apache Kafka clusters to be used by the job.
jobGraphEncoding

string

Optional. The encoding type of the job graph.

AutotuningConfig

The autotuning configuration for the Apache Flink job.

JSON representation 
{

  // 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.
}
Fields
Union field horizontal_autoscaling_policy. The horizontal autoscaling policy for the job. horizontal_autoscaling_policy can be only one of the following:
fixed

object (Fixed)

Fixed policy to disable autoscaling.
throughputBased

object (Elastic)

The throughput-based autoscaling policy that leverages observed throughput and true processing rate (estimated maximum achievable throughput) to autoscale the task parallelism per job vertex.

Fixed

Fixed policy to disable autoscaling.

JSON representation 
{
  "parallelism": integer
}
Fields
parallelism

integer

Optional. The fixed task parallelism for the job.

Elastic

Elastic autoscaling policy to enable autoscaling with min/max limits.

JSON representation 
{
  "parallelism": integer,
  "minParallelism": integer,
  "maxParallelism": integer
}
Fields
parallelism

integer

Optional. The initial task parallelism for the job.
minParallelism

integer

Optional. The minimum task parallelism for the job.
maxParallelism

integer

Optional. The maximum task parallelism for the job.

ManagedKafkaConfig

The configuration for the Google Cloud Managed Service for Apache Kafka clusters to be used by the job.

JSON representation 
{
  "managedKafkaClusters": [
    string
  ]
}
Fields
managedKafkaClusters[]

string

Optional. The list of Managed Service for Apache Kafka clusters connected to the job, specified in the following format: projects/<project-id>/locations/<region>/clusters/<cluster-name>.

DisplayGraph

The Apache Flink display graph of the job.

JSON representation 
{
  "displayGraphJson": string,
  "state": enum (State)
}
Fields
displayGraphJson

string

Output only. The display graph in JSON format.
state

enum (State)

Output only. The state of the display graph.

State

Enum defining the states of a display graph.

Enums
STATE_UNSPECIFIED Display graph state unspecified.
DISPLAY_GRAPH_POPULATED Display graph is populated.
DISPLAY_GRAPH_TOO_LARGE Display graph is too large.
DISPLAY_GRAPH_EMPTY Display graph is empty.

Methods

create

 Creates a new job in the specified project and location.

delete

 Deletes a single job.

get

 Gets details of a single job.

list

 Lists jobs in the specified project and location.

patch

 Updates the parameters of a single job.