Dataflow Job

A Dataflow Job in Google Cloud is a managed service execution of a data processing pipeline built with Apache Beam. It allows you to process and transform large datasets in both batch and streaming modes without managing infrastructure. Dataflow automatically handles resource provisioning, scaling, and optimization, enabling efficient ETL, real-time analytics, and machine learning data preparation.

gcp.dataflow_job

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
client_request_idcorestringThe 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.
create_timecoretimestampThe timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
created_from_snapshot_idcorestringIf this is specified, the job's initial state is populated from the given snapshot.
current_statecorestringThe 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 might be mutated by the Dataflow service; callers cannot mutate it.
current_state_timecoretimestampThe timestamp associated with the current state.
datadog_display_namecorestring
environmentcorejsonOptional. The environment for the job.
execution_infocorejsonDeprecated.
idcorestringThe unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
job_metadatacorejsonThis 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.
labelscorearray<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}{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.
locationcorestringOptional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
namecorestringOptional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
organization_idcorestring
parentcorestring
pipeline_descriptioncorejsonPreliminary 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.
project_idcorestringThe ID of the Google Cloud project that the job belongs to.
project_numbercorestring
replace_job_idcorestringIf 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.
replaced_by_job_idcorestringIf 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.
requested_statecorestringThe job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
resource_namecorestring
runtime_updatable_paramscorejsonThis field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
satisfies_pzicoreboolOutput only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
satisfies_pzscoreboolReserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
service_resourcescorejsonOutput only. Resources used by the Dataflow Service to run the job.
stage_statescorejsonThis field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
start_timecoretimestampThe 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.
stepscorejsonExactly 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_locationcorestringThe Cloud Storage location where the steps are stored.
tagscorehstore
temp_filescorearray<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}
typecorestringOptional. The type of Dataflow job.