Package google.dataflow.v1beta3

Index

FlexTemplatesService

Provides a service for Flex templates. This feature is not ready yet.

LaunchFlexTemplate

rpc LaunchFlexTemplate(LaunchFlexTemplateRequest) returns (LaunchFlexTemplateResponse)

Launch a job with a FlexTemplate.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

JobsV1Beta3

Provides a method to create and modify Google Cloud Dataflow jobs. A Job is a multi-stage computation graph run by the Cloud Dataflow service.

AggregatedListJobs

rpc AggregatedListJobs(ListJobsRequest) returns (ListJobsResponse)

List the jobs of a project across all regions.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

CheckActiveJobs

rpc CheckActiveJobs(CheckActiveJobsRequest) returns (CheckActiveJobsResponse)

Check for existence of active jobs in the given project across all regions.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Creates a Cloud Dataflow job.

To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

GetJob

rpc GetJob(GetJobRequest) returns (Job)

Gets the state of the specified Cloud Dataflow job.

To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

List the jobs of a project.

To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a regional endpoint. To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, as you can only get the list of jobs that are running in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

SnapshotJob

rpc SnapshotJob(SnapshotJobRequest) returns (Snapshot)

Snapshot the state of a streaming job.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

UpdateJob

rpc UpdateJob(UpdateJobRequest) returns (Job)

Updates the state of an existing Cloud Dataflow job.

To update the state of an existing job, we recommend using projects.locations.jobs.update with a regional endpoint. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

MessagesV1Beta3

The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

ListJobMessages

rpc ListJobMessages(ListJobMessagesRequest) returns (ListJobMessagesResponse)

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

MetricsV1Beta3

The Dataflow Metrics API lets you monitor the progress of Dataflow jobs.

GetJobExecutionDetails

rpc GetJobExecutionDetails(GetJobExecutionDetailsRequest) returns (JobExecutionDetails)

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

GetJobMetrics

rpc GetJobMetrics(GetJobMetricsRequest) returns (JobMetrics)

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

GetStageExecutionDetails

rpc GetStageExecutionDetails(GetStageExecutionDetailsRequest) returns (StageExecutionDetails)

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

TemplatesService

Provides a method to create Cloud Dataflow jobs from templates.

CreateJobFromTemplate

rpc CreateJobFromTemplate(CreateJobFromTemplateRequest) returns (Job)

Creates a Cloud Dataflow job from a template.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

GetTemplate

rpc GetTemplate(GetTemplateRequest) returns (GetTemplateResponse)

Get the template associated with a template.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

LaunchTemplate

rpc LaunchTemplate(LaunchTemplateRequest) returns (LaunchTemplateResponse)

Launch a template.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/userinfo.email

For more information, see the Authentication Overview.

AutoscalingAlgorithm

Specifies the algorithm used to determine the number of worker processes to run at any given point in time, based on the amount of data left to process, the number of workers, and how quickly existing workers are processing data.

Enums
AUTOSCALING_ALGORITHM_UNKNOWN The algorithm is unknown, or unspecified.
AUTOSCALING_ALGORITHM_NONE Disable autoscaling.
AUTOSCALING_ALGORITHM_BASIC Increase worker count over time to reduce job execution time.

AutoscalingEvent

A structured message reporting an autoscaling decision made by the Dataflow service.

Fields
current_num_workers

int64

The current number of workers the job has.

target_num_workers

int64

The target number of workers the worker pool wants to resize to use.

event_type

AutoscalingEventType

The type of autoscaling event to report.

description

StructuredMessage

A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.

time

Timestamp

The time this event was emitted to indicate a new target or current num_workers value.

worker_pool

string

A short and friendly name for the worker pool this event refers to, populated from the value of PoolStageRelation::user_pool_name.

AutoscalingEventType

Indicates the type of autoscaling event.

Enums
TYPE_UNKNOWN Default type for the enum. Value should never be returned.
TARGET_NUM_WORKERS_CHANGED The TARGET_NUM_WORKERS_CHANGED type should be used when the target worker pool size has changed at the start of an actuation. An event should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects a change in the target_num_workers.
CURRENT_NUM_WORKERS_CHANGED The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker pool size has been changed, but the target_num_workers has not changed.
ACTUATION_FAILURE The ACTUATION_FAILURE type should be used when we want to report an error to the user indicating why the current number of workers in the pool could not be changed. Displayed in the current status and history widgets.
NO_CHANGE Used when we want to report to the user a reason why we are not currently adjusting the number of workers. Should specify both target_num_workers, current_num_workers and a decision_message.

AutoscalingSettings

Settings for WorkerPool autoscaling.

Fields
algorithm

AutoscalingAlgorithm

The algorithm to use for autoscaling.

max_num_workers

int32

The maximum number of workers to cap scaling at.

BigQueryIODetails

Metadata for a BigQuery connector used by the job.

Fields
table

string

Table accessed in the connection.

dataset

string

Dataset accessed in the connection.

project_id

string

Project accessed in the connection.

query

string

Query used to access data in the connection.

BigTableIODetails

Metadata for a BigTable connector used by the job.

Fields
project_id

string

ProjectId accessed in the connection.

instance_id

string

InstanceId accessed in the connection.

table_id

string

TableId accessed in the connection.

CheckActiveJobsRequest

Request to check is active jobs exists for a project

Fields
project_id

string

The project which owns the jobs.

CheckActiveJobsResponse

Response for CheckActiveJobsRequest.

Fields
active_jobs_exist

bool

If True, active jobs exists for project. False otherwise.

CreateJobFromTemplateRequest

A request to create a Cloud Dataflow job from a template.

Fields
project_id

string

Required. The ID of the Cloud Platform project that the job belongs to.

job_name

string

Required. The job name to use for the created job.

parameters

map<string, string>

The runtime parameters to pass to the job.

environment

RuntimeEnvironment

The runtime environment for the job.

location

string

The regional endpoint to which to direct the request.

gcs_path

string

Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://.

CreateJobRequest

Request to create a Cloud Dataflow job.

Fields
project_id

string

The ID of the Cloud Platform project that the job belongs to.

job

Job

The job to create.

view

JobView

The level of information requested in response.

replace_job_id

string

Deprecated. This field is now in the Job message.

location

string

The regional endpoint that contains this job.

DatastoreIODetails

Metadata for a Datastore connector used by the job.

Fields
namespace

string

Namespace used in the connection.

project_id

string

ProjectId accessed in the connection.

DebugOptions

Describes any options that have an effect on the debugging of pipelines.

Fields
enable_hot_key_logging

bool

When true, enables the logging of the literal hot key to the user's Cloud Logging.

DefaultPackageSet

The default set of packages to be staged on a pool of workers.

Enums
DEFAULT_PACKAGE_SET_UNKNOWN The default set of packages to stage is unknown, or unspecified.
DEFAULT_PACKAGE_SET_NONE Indicates that no packages should be staged at the worker unless explicitly specified by the job.
DEFAULT_PACKAGE_SET_JAVA Stage packages typically useful to workers written in Java.
DEFAULT_PACKAGE_SET_PYTHON Stage pacakges typically useful to workers written in Python.

Disk

Describes the data disk used by a workflow job.

Fields
size_gb

int32

Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

disk_type

string

Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default.

For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Cloud Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone.

Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this:

compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard

mount_point

string

Directory in a VM where disk is mounted.

DisplayData

Data provided with a pipeline or transform to provide descriptive info.

Fields
key

string

The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

namespace

string

The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

short_str_value

string

A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

url

string

An optional full URL.

label

string

An optional label to display in a dax UI for the element.

Union field Value. Various value types which can be used for display data. Only one will be set. Value can be only one of the following:
str_value

string

Contains value if the data is of string type.

int64_value

int64

Contains value if the data is of int64 type.

float_value

float

Contains value if the data is of float type.

java_class_value

string

Contains value if the data is of java class type.

timestamp_value

Timestamp

Contains value if the data is of timestamp type.

duration_value

Duration

Contains value if the data is of duration type.

bool_value

bool

Contains value if the data is of a boolean type.

Environment

Describes the environment in which a Dataflow Job runs.

Fields
temp_storage_prefix

string

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

cluster_manager_api_service

string

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".

experiments[]

string

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. For more details see the rationale at go/user-specified-service-options.

service_options[]

string

The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). For more details see the rationale at go/user-specified-service-options.

service_kms_key_name

string

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

worker_pools[]

WorkerPool

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

user_agent

Struct

A description of the process that generated the request.

version

Struct

A structure describing which components and their versions of the service are required in order to run the job.

dataset

string

The dataset for the current project where various workflow related tables are stored.

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

sdk_pipeline_options

Struct

The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.

internal_experiments

Any

Experimental settings.

service_account_email

string

Identity to run virtual machines as. Defaults to the default account.

flex_resource_scheduling_goal

FlexResourceSchedulingGoal

Which Flexible Resource Scheduling mode to run in.

worker_region

string

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

worker_zone

string

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

shuffle_mode

ShuffleMode

Output only. The shuffle mode used for the job.

debug_options

DebugOptions

Any debugging options to be supplied to the job.

ExecutionStageState

A message describing the state of a particular execution stage.

Fields
execution_stage_name

string

The name of the execution stage.

execution_stage_state

JobState

Executions stage states allow the same set of values as JobState.

current_state_time

Timestamp

The time at which the stage transitioned to this state.

ExecutionStageSummary

Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.

Fields
name

string

Dataflow service generated name for this stage.

id

string

Dataflow service generated id for this stage.

kind

KindType

Type of transform this stage is executing.

input_source[]

StageSource

Input sources for this stage.

output_source[]

StageSource

Output sources for this stage.

prerequisite_stage[]

string

Other stages that must complete before this stage can run.

component_transform[]

ComponentTransform

Transforms that comprise this execution stage.

component_source[]

ComponentSource

Collections produced and consumed by component transforms of this stage.

ComponentSource

Description of an interstitial value between transforms in an execution stage.

Fields
user_name

string

Human-readable name for this transform; may be user or system generated.

name

string

Dataflow service generated name for this source.

original_transform_or_collection

string

User name for the original user transform or collection with which this source is most closely associated.

ComponentTransform

Description of a transform executed as part of an execution stage.

Fields
user_name

string

Human-readable name for this transform; may be user or system generated.

name

string

Dataflow service generated name for this source.

original_transform

string

User name for the original user transform with which this transform is most closely associated.

StageSource

Description of an input or output of an execution stage.

Fields
user_name

string

Human-readable name for this source; may be user or system generated.

name

string

Dataflow service generated name for this source.

original_transform_or_collection

string

User name for the original user transform or collection with which this source is most closely associated.

size_bytes

int64

Size of the source, if measurable.

ExecutionState

The state of some component of job execution.

Enums
EXECUTION_STATE_UNKNOWN The component state is unknown or unspecified.
EXECUTION_STATE_NOT_STARTED The component is not yet running.
EXECUTION_STATE_RUNNING The component is currently running.
EXECUTION_STATE_SUCCEEDED The component succeeded.
EXECUTION_STATE_FAILED The component failed.
EXECUTION_STATE_CANCELLED Execution of the component was cancelled.

FailedLocation

Indicates which regional endpoint failed to respond to a request for data.

Fields
name

string

The name of the regional endpoint that failed to respond.

FileIODetails

Metadata for a File connector used by the job.

Fields
file_pattern

string

File Pattern used to access files by the connector.

FlexResourceSchedulingGoal

Specifies the resource to optimize for in Flexible Resource Scheduling.

Enums
FLEXRS_UNSPECIFIED Run in the default mode.
FLEXRS_SPEED_OPTIMIZED Optimize for lower execution time.
FLEXRS_COST_OPTIMIZED Optimize for lower cost.

FlexTemplateRuntimeEnvironment

The environment values to be set at runtime for flex template.

Fields
num_workers

int32

The initial number of Google Compute Engine instances for the job.

max_workers

int32

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

zone

string

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

service_account_email

string

The email address of the service account to run the job as.

temp_location

string

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

machine_type

string

The machine type to use for the job. Defaults to the value from the template if not specified.

additional_experiments[]

string

Additional experiment flags for the job.

network

string

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

subnetwork

string

Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.

additional_user_labels

map<string, string>

Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

kms_key_name

string

Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

ip_configuration

WorkerIPAddressConfiguration

Configuration for VM IPs.

worker_region

string

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

worker_zone

string

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence.

enable_streaming_engine

bool

Whether to enable Streaming Engine for the job.

flexrs_goal

FlexResourceSchedulingGoal

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

GetJobExecutionDetailsRequest

Request to get job execution details.

Fields
project_id

string

A project id.

job_id

string

The job to get execution details for.

location

string

The regional endpoint that contains the job specified by job_id.

page_size

int32

If specified, determines the maximum number of stages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

page_token

string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

GetJobMetricsRequest

Request to get job metrics.

Fields
project_id

string

A project id.

job_id

string

The job to get metrics for.

start_time

Timestamp

Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

location

string

The regional endpoint that contains the job specified by job_id.

GetJobRequest

Request to get the state of a Cloud Dataflow job.

Fields
project_id

string

The ID of the Cloud Platform project that the job belongs to.

job_id

string

The job ID.

view

JobView

The level of information requested in response.

location

string

The regional endpoint that contains this job.

GetStageExecutionDetailsRequest

Request to get information about a particular execution stage of a job. Currently only tracked for Batch jobs.

Fields
project_id

string

A project id.

job_id

string

The job to get execution details for.

location

string

The regional endpoint that contains the job specified by job_id.

stage_id

string

The stage for which to fetch information.

page_size

int32

If specified, determines the maximum number of work items to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

page_token

string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

start_time

Timestamp

Lower time bound of work items to include, by start time.

end_time

Timestamp

Upper time bound of work items to include, by start time.

GetTemplateRequest

A request to retrieve a Cloud Dataflow job template.

Fields
project_id

string

Required. The ID of the Cloud Platform project that the job belongs to.

view

TemplateView

The view to retrieve. Defaults to METADATA_ONLY.

location

string

The regional endpoint to which to direct the request.

gcs_path

string

Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

TemplateView

The various views of a template that may be retrieved.

Enums
METADATA_ONLY Template view that retrieves only the metadata associated with the template.

GetTemplateResponse

The response to a GetTemplate request.

Fields
status

Status

The status of the get template request. Any problems with the request will be indicated in the error_details.

metadata

TemplateMetadata

The template metadata describing the template name, available parameters, etc.

template_type

TemplateType

Template Type.

runtime_metadata

RuntimeMetadata

Describes the runtime metadata with SDKInfo and available parameters.

TemplateType

Template Type.

Enums
UNKNOWN Unknown Template Type.
LEGACY Legacy Template.
FLEX Flex Template.

InvalidTemplateParameters

Used in the error_details field of a google.rpc.Status message, this indicates problems with the template parameter.

Fields
parameter_violations[]

ParameterViolation

Describes all parameter violations in a template request.

ParameterViolation

A specific template-parameter violation.

Fields
parameter

string

The parameter that failed to validate.

description

string

A description of why the parameter failed to validate.

Job

Defines a job to be run by the Cloud Dataflow service. nextID: 26

Fields
id

string

The unique ID of this job.

This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

project_id

string

The ID of the Cloud Platform project that the job belongs to.

name

string

The user-specified Cloud Dataflow job name.

Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job.

The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?

type

JobType

The type of Cloud Dataflow job.

environment

Environment

The environment for the job.

steps[]

Step

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

steps_location

string

The GCS location where the steps are stored.

current_state

JobState

The current state of the job.

Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified.

A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made.

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

current_state_time

Timestamp

The timestamp associated with the current state.

requested_state

JobState

The job's requested state.

UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.

execution_info

JobExecutionInfo

Deprecated.

create_time

Timestamp

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

replace_job_id

string

If this job is an update of an existing job, this field is the job ID of the job it replaced.

When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

transform_name_mapping

map<string, string>

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

client_request_id

string

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.

replaced_by_job_id

string

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job.

temp_files[]

string

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

labels

map<string, string>

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.
location

string

The regional endpoint that contains this job.

pipeline_description

PipelineDescription

Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

stage_states[]

ExecutionStageState

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

job_metadata

JobMetadata

This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

start_time

Timestamp

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

created_from_snapshot_id

string

If this is specified, the job's initial state is populated from the given snapshot.

satisfies_pzs

bool

Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

JobExecutionDetails

Information about the execution of a job.

Fields
stages[]

StageSummary

The stages of the job execution.

next_page_token

string

If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value.

JobExecutionInfo

Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.

Fields
stages

map<string, JobExecutionStageInfo>

A mapping from each stage to the information about that stage.

JobExecutionStageInfo

Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

Fields
step_name[]

string

The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.

JobMessage

A particular message pertaining to a Dataflow job.

Fields
id

string

Deprecated.

time

Timestamp

The timestamp of the message.

message_text

string

The text of the message.

message_importance

JobMessageImportance

Importance level of the message.

JobMessageImportance

Indicates the importance of the message.

Enums
JOB_MESSAGE_IMPORTANCE_UNKNOWN The message importance isn't specified, or is unknown.
JOB_MESSAGE_DEBUG The message is at the 'debug' level: typically only useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.
JOB_MESSAGE_DETAILED The message is at the 'detailed' level: somewhat verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.
JOB_MESSAGE_BASIC The message is at the 'basic' level: useful for keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
JOB_MESSAGE_WARNING The message is at the 'warning' level: indicating a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
JOB_MESSAGE_ERROR The message is at the 'error' level: indicating a condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

JobMetadata

Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view.

Fields
sdk_version

SdkVersion

The SDK version used to run the job.

spanner_details[]

SpannerIODetails

Identification of a Spanner source used in the Dataflow job.

bigquery_details[]

BigQueryIODetails

Identification of a BigQuery source used in the Dataflow job.

big_table_details[]

BigTableIODetails

Identification of a BigTable source used in the Dataflow job.

pubsub_details[]

PubSubIODetails

Identification of a PubSub source used in the Dataflow job.

file_details[]

FileIODetails

Identification of a File source used in the Dataflow job.

datastore_details[]

DatastoreIODetails

Identification of a Datastore source used in the Dataflow job.

JobMetrics

JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job.

This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.

Fields
metric_time

Timestamp

Timestamp as of which metric values are current.

metrics[]

MetricUpdate

All metrics for this job.

JobState

Describes the overall state of a google.dataflow.v1beta3.Job.

Enums
JOB_STATE_UNKNOWN The job's run state isn't specified.
JOB_STATE_STOPPED JOB_STATE_STOPPED indicates that the job has not yet started to run.
JOB_STATE_RUNNING JOB_STATE_RUNNING indicates that the job is currently running.
JOB_STATE_DONE JOB_STATE_DONE indicates that the job has successfully completed. This is a terminal job state. This state may be set by the Cloud Dataflow service, as a transition from JOB_STATE_RUNNING. It may also be set via a Cloud Dataflow UpdateJob call, if the job has not yet reached a terminal state.
JOB_STATE_FAILED JOB_STATE_FAILED indicates that the job has failed. This is a terminal job state. This state may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_RUNNING.
JOB_STATE_CANCELLED JOB_STATE_CANCELLED indicates that the job has been explicitly cancelled. This is a terminal job state. This state may only be set via a Cloud Dataflow UpdateJob call, and only if the job has not yet reached another terminal state.
JOB_STATE_UPDATED JOB_STATE_UPDATED indicates that the job was successfully updated, meaning that this job was stopped and another job was started, inheriting state from this one. This is a terminal job state. This state may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_RUNNING.
JOB_STATE_DRAINING JOB_STATE_DRAINING indicates that the job is in the process of draining. A draining job has stopped pulling from its input sources and is processing any data that remains in-flight. This state may be set via a Cloud Dataflow UpdateJob call, but only as a transition from JOB_STATE_RUNNING. Jobs that are draining may only transition to JOB_STATE_DRAINED, JOB_STATE_CANCELLED, or JOB_STATE_FAILED.
JOB_STATE_DRAINED JOB_STATE_DRAINED indicates that the job has been drained. A drained job terminated by stopping pulling from its input sources and processing any data that remained in-flight when draining was requested. This state is a terminal state, may only be set by the Cloud Dataflow service, and only as a transition from JOB_STATE_DRAINING.
JOB_STATE_PENDING JOB_STATE_PENDING indicates that the job has been created but is not yet running. Jobs that are pending may only transition to JOB_STATE_RUNNING, or JOB_STATE_FAILED.
JOB_STATE_CANCELLING JOB_STATE_CANCELLING indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to JOB_STATE_CANCELLED or JOB_STATE_FAILED.
JOB_STATE_QUEUED JOB_STATE_QUEUED indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to JOB_STATE_PENDING or JOB_STATE_CANCELLED.
JOB_STATE_RESOURCE_CLEANING_UP JOB_STATE_RESOURCE_CLEANING_UP indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are intersted.

JobType

Specifies the processing model used by a google.dataflow.v1beta3.Job, which determines the way the Job is managed by the Cloud Dataflow service (how workers are scheduled, how inputs are sharded, etc).

Enums
JOB_TYPE_UNKNOWN The type of the job is unspecified, or unknown.
JOB_TYPE_BATCH A batch job with a well-defined end point: data is read, data is processed, data is written, and the job is done.
JOB_TYPE_STREAMING A continuously streaming job with no end: data is read, processed, and written continuously.

JobView

Selector for how much information is returned in Job responses.

Enums
JOB_VIEW_UNKNOWN The job view to return isn't specified, or is unknown. Responses will contain at least the JOB_VIEW_SUMMARY information, and may contain additional information.
JOB_VIEW_SUMMARY Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.
JOB_VIEW_ALL Request all information available for this job.
JOB_VIEW_DESCRIPTION Request summary info and limited job description data for steps, labels and environment.

KindType

Type of transform or stage operation.

Enums
UNKNOWN_KIND Unrecognized transform type.
PAR_DO_KIND ParDo transform.
GROUP_BY_KEY_KIND Group By Key transform.
FLATTEN_KIND Flatten transform.
READ_KIND Read transform.
WRITE_KIND Write transform.
CONSTANT_KIND Constructs from a constant value, such as with Create.of.
SINGLETON_KIND Creates a Singleton view of a collection.
SHUFFLE_KIND Opening or closing a shuffle session, often as part of a GroupByKey.

LaunchFlexTemplateParameter

Launch FlexTemplate Parameter.

Fields
job_name

string

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

parameters

map<string, string>

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

launch_options

map<string, string>

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

environment

FlexTemplateRuntimeEnvironment

The runtime environment for the FlexTemplate job

update

bool

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

transform_name_mappings

map<string, string>

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

container_spec_gcs_path

string

Gcs path to a file with json serialized ContainerSpec as content.

LaunchFlexTemplateRequest

A request to launch a Cloud Dataflow job from a FlexTemplate.

Fields
project_id

string

Required. The ID of the Cloud Platform project that the job belongs to.

launch_parameter

LaunchFlexTemplateParameter

Required. Parameter to launch a job form Flex Template.

location

string

Required. The regional endpoint to which to direct the request. E.g., us-central1, us-west1.

validate_only

bool

If true, the request is validated but not actually executed. Defaults to false.

LaunchFlexTemplateResponse

Response to the request to launch a job from Flex Template.

Fields
job

Job

The job that was launched, if the request was not a dry run and the job was successfully launched.

LaunchTemplateParameters

Parameters to provide to the template being launched.

Fields
job_name

string

Required. The job name to use for the created job.

parameters

map<string, string>

The runtime parameters to pass to the job.

environment

RuntimeEnvironment

The runtime environment for the job.

update

bool

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

transform_name_mapping

map<string, string>

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

LaunchTemplateRequest

A request to launch a template.

Fields
project_id

string

Required. The ID of the Cloud Platform project that the job belongs to.

validate_only

bool

If true, the request is validated but not actually executed. Defaults to false.

launch_parameters

LaunchTemplateParameters

The parameters of the template to launch. This should be part of the body of the POST request.

location

string

The regional endpoint to which to direct the request.

gcs_path

string

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

LaunchTemplateResponse

Response to the request to launch a template.

Fields
job

Job

The job that was launched, if the request was not a dry run and the job was successfully launched.

ListJobMessagesRequest

Request to list job messages. Up to max_results messages will be returned in the time range specified starting with the oldest messages first. If no time range is specified the results with start with the oldest message.

Fields
project_id

string

A project id.

job_id

string

The job to get messages about.

minimum_importance

JobMessageImportance

Filter to only get messages with importance >= level

page_size

int32

If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

page_token

string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

start_time

Timestamp

If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

end_time

Timestamp

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

location

string

The regional endpoint that contains the job specified by job_id.

ListJobMessagesResponse

Response to a request to list job messages.

Fields
job_messages[]

JobMessage

Messages in ascending timestamp order.

next_page_token

string

The token to obtain the next page of results if there are more.

autoscaling_events[]

AutoscalingEvent

Autoscaling events in ascending timestamp order.

ListJobsRequest

Request to list Cloud Dataflow jobs.

Fields
filter

Filter

The kind of filter to use.

project_id

string

The project which owns the jobs.

view
(deprecated)

JobView

Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

page_size

int32

If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.

page_token

string

Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

location

string

The regional endpoint that contains this job.

Filter

This field filters out and returns jobs in the specified job state. The order of data returned is determined by the filter used, and is subject to change.

Enums
UNKNOWN The filter isn't specified, or is unknown. This returns all jobs ordered on descending JobUuid.
ALL Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.
TERMINATED Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: JOB_STATE_STOPPED, JOB_STATE_UPDATED, JOB_STATE_DRAINED, etc.
ACTIVE Filters the jobs that are running ordered on the creation timestamp.

ListJobsResponse

Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}.

Fields
jobs[]

Job

A subset of the requested job information.

next_page_token

string

Set if there may be more results than fit in this response.

failed_location[]

FailedLocation

Zero or more messages describing the regional endpoints that failed to respond.

MetricStructuredName

Identifies a metric, by describing the source which generated the metric.

Fields
origin

string

Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.

name

string

Worker-defined metric name.

context

map<string, string>

Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.

For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = .

MetricUpdate

Describes the state of a metric.

Fields
name

MetricStructuredName

Name of the metric.

kind

string

Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive.

If omitted, this is not an aggregated value but instead a single metric sample value.

cumulative

bool

True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.

scalar

Value

Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

mean_sum

Value

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.

mean_count

Value

Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.

set

Value

Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.

distribution

Value

A struct value describing properties of a distribution of numeric values.

gauge

Value

A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

internal

Value

Worker-computed aggregate value for internal use by the Dataflow service.

update_time

Timestamp

Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

Package

The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool.

This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run.

Fields
name

string

The name of the package.

location

string

The resource to read the package from. The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

ParameterMetadata

Metadata for a specific parameter.

Fields
name

string

Required. The name of the parameter.

label

string

Required. The label to display for the parameter.

help_text

string

Required. The help text to display for the parameter.

is_optional

bool

Optional. Whether the parameter is optional. Defaults to false.

regexes[]

string

Optional. Regexes that the parameter must match.

param_type

ParameterType

Optional. The type of the parameter. Used for selecting input picker.

ParameterType

ParameterType specifies what kind of input we need for this parameter.

Enums
DEFAULT Default input type.
TEXT The parameter specifies generic text input.
GCS_READ_BUCKET The parameter specifies a GCS Bucket to read from.
GCS_WRITE_BUCKET The parameter specifies a GCS Bucket to write to.
GCS_READ_FILE The parameter specifies a GCS file path to read from.
GCS_WRITE_FILE The parameter specifies a GCS file path to write to.
GCS_READ_FOLDER The parameter specifies a GCS folder path to read from.
GCS_WRITE_FOLDER The parameter specifies a GCS folder to write to.
PUBSUB_TOPIC The parameter specifies a Pub/Sub Topic.
PUBSUB_SUBSCRIPTION The parameter specifies a Pub/Sub Subscription.

PipelineDescription

A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics.

Fields
original_pipeline_transform[]

TransformSummary

Description of each transform in the pipeline and collections between them.

execution_pipeline_stage[]

ExecutionStageSummary

Description of each stage of execution of the pipeline.

display_data[]

DisplayData

Pipeline level display data.

ProgressTimeseries

Information about the progress of some component of job execution.

Fields
current_progress

double

The current progress of the component, in the range [0,1].

data_points[]

Point

History of progress for the component.

Points are sorted by time.

Point

A point in the timeseries.

Fields
time

Timestamp

The timestamp of the point.

value

double

The value of the point.

PubSubIODetails

Metadata for a PubSub connector used by the job.

Fields
topic

string

Topic accessed in the connection.

subscription

string

Subscription used in the connection.

PubsubSnapshotMetadata

Represents a Pubsub snapshot.

Fields
topic_name

string

The name of the Pubsub topic.

snapshot_name

string

The name of the Pubsub snapshot.

expire_time

Timestamp

The expire time of the Pubsub snapshot.

RuntimeEnvironment

The environment values to set at runtime.

Fields
num_workers

int32

The initial number of Google Compute Engine instnaces for the job.

max_workers

int32

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

zone

string

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

service_account_email

string

The email address of the service account to run the job as.

temp_location

string

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

bypass_temp_dir_validation

bool

Whether to bypass the safety checks for the job's temporary directory. Use with caution.

machine_type

string

The machine type to use for the job. Defaults to the value from the template if not specified.

additional_experiments[]

string

Additional experiment flags for the job.

network

string

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

subnetwork

string

Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.

additional_user_labels

map<string, string>

Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

kms_key_name

string

Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

ip_configuration

WorkerIPAddressConfiguration

Configuration for VM IPs.

worker_region

string

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

worker_zone

string

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence.

enable_streaming_engine

bool

Whether to enable Streaming Engine for the job.

RuntimeMetadata

RuntimeMetadata describing a runtime environment.

Fields
sdk_info

SDKInfo

SDK Info for the template.

parameters[]

ParameterMetadata

The parameters for the template.

SDKInfo

SDK Information.

Fields
language

Language

Required. The SDK Language.

version

string

Optional. The SDK version.

Language

SDK Language.

Enums
UNKNOWN UNKNOWN Language.
JAVA Java.
PYTHON Python.

SdkHarnessContainerImage

Defines a SDK harness container for executing Dataflow pipelines.

Fields
container_image

string

A docker container image that resides in Google Container Registry.

use_single_core_per_container

bool

If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

environment_id

string

Environment ID for the Beam runner API proto Environment that corresponds to the current SDK Harness.

SdkVersion

The version of the SDK used to run the job.

Fields
version

string

The version of the SDK used to run the job.

version_display_name

string

A readable string describing the version of the SDK.

sdk_support_status

SdkSupportStatus

The support status for this SDK version.

SdkSupportStatus

The support status of the SDK used to run the job.

Enums
UNKNOWN Cloud Dataflow is unaware of this version.
SUPPORTED This is a known version of an SDK, and is supported.
STALE A newer version of the SDK family exists, and an update is recommended.
DEPRECATED This version of the SDK is deprecated and will eventually be no longer supported.
UNSUPPORTED Support for this SDK version has ended and it should no longer be used.

ShuffleMode

Specifies the shuffle mode used by a google.dataflow.v1beta3.Job, which determines the approach data is shuffled during processing. More details in: https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#dataflow-shuffle

Enums
SHUFFLE_MODE_UNSPECIFIED Shuffle mode information is not available.
VM_BASED Shuffle is done on the worker VMs.
SERVICE_BASED Shuffle is done on the service side.

Snapshot

Represents a snapshot of a job.

Fields
id

string

The unique ID of this snapshot.

project_id

string

The project this snapshot belongs to.

source_job_id

string

The job this snapshot was created from.

creation_time

Timestamp

The time this snapshot was created.

ttl

Duration

The time after which this snapshot will be automatically deleted.

state

SnapshotState

State of the snapshot.

pubsub_metadata[]

PubsubSnapshotMetadata

PubSub snapshot metadata.

description

string

User specified description of the snapshot. Maybe empty.

disk_size_bytes

int64

The disk byte size of the snapshot. Only available for snapshots in READY state.

SnapshotJobRequest

Request to create a snapshot of a job.

Fields
project_id

string

The project which owns the job to be snapshotted.

job_id

string

The job to be snapshotted.

ttl

Duration

TTL for the snapshot.

location

string

The location that contains this job.

snapshot_sources

bool

If true, perform snapshots for sources which support this.

description

string

User specified description of the snapshot. Maybe empty.

SnapshotState

Snapshot state.

Enums
UNKNOWN_SNAPSHOT_STATE Unknown state.
PENDING Snapshot intent to create has been persisted, snapshotting of state has not yet started.
RUNNING Snapshotting is being performed.
READY Snapshot has been created and is ready to be used.
FAILED Snapshot failed to be created.
DELETED Snapshot has been deleted.

SpannerIODetails

Metadata for a Spanner connector used by the job.

Fields
project_id

string

ProjectId accessed in the connection.

instance_id

string

InstanceId accessed in the connection.

database_id

string

DatabaseId accessed in the connection.

StageExecutionDetails

Information about the workers and work items within a stage.

Fields
workers[]

WorkerDetails

Workers that have done work on the stage.

next_page_token

string

If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value.

StageSummary

Information about a particular execution stage of a job.

Fields
stage_id

string

ID of this stage

state

ExecutionState

State of this stage.

start_time

Timestamp

Start time of this stage.

end_time

Timestamp

End time of this stage.

If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

progress

ProgressTimeseries

Progress for this stage. Only applicable to Batch jobs.

metrics[]

MetricUpdate

Metrics for this stage.

Step

Defines a particular step within a Cloud Dataflow job.

A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job.

Here's an example of a sequence of steps which together implement a Map-Reduce job:

  • Read a collection of data from some source, parsing the collection's elements.

  • Validate the elements.

  • Apply a user-defined function to map each element to some value and extract an element-specific key value.

  • Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection.

  • Write the elements out to some data sink.

Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.

Fields
kind

string

The kind of step in the Cloud Dataflow job.

name

string

The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

properties

Struct

Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

StructuredMessage

A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption.

Fields
message_text

string

Human-readable version of message.

message_key

string

Identifier for this message type. Used by external systems to internationalize or personalize message.

parameters[]

Parameter

The structured data associated with this message.

Parameter

Structured data associated with this message.

Fields
key

string

Key or name for this parameter.