Class Job

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

Attributes
NameDescription
strid
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.
strproject_id
The ID of the Cloud Platform project that the job belongs to.
strname
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])?``
google.cloud.dataflow_v1beta3.types.JobTypetype_
The type of Cloud Dataflow job.
google.cloud.dataflow_v1beta3.types.Environmentenvironment
The environment for the job.
Sequence[google.cloud.dataflow_v1beta3.types.Step]steps
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.
strsteps_location
The Cloud Storage location where the steps are stored.
google.cloud.dataflow_v1beta3.types.JobStatecurrent_state
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.
google.protobuf.timestamp_pb2.Timestampcurrent_state_time
The timestamp associated with the current state.
google.cloud.dataflow_v1beta3.types.JobStaterequested_state
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.
google.cloud.dataflow_v1beta3.types.JobExecutionInfoexecution_info
Deprecated.
google.protobuf.timestamp_pb2.Timestampcreate_time
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
strreplace_job_id
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.
Sequence[google.cloud.dataflow_v1beta3.types.Job.TransformNameMappingEntry]transform_name_mapping
The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
strclient_request_id
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.
strreplaced_by_job_id
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.
Sequence[str]temp_files
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}
Sequence[google.cloud.dataflow_v1beta3.types.Job.LabelsEntry]labels
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="">
strlocation
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
google.cloud.dataflow_v1beta3.types.PipelineDescriptionpipeline_description
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.
Sequence[google.cloud.dataflow_v1beta3.types.ExecutionStageState]stage_states
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
google.cloud.dataflow_v1beta3.types.JobMetadatajob_metadata
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.
google.protobuf.timestamp_pb2.Timestampstart_time
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.
strcreated_from_snapshot_id
If this is specified, the job's initial state is populated from the given snapshot.
boolsatisfies_pzs
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

Inheritance

builtins.object > proto.message.Message > Job

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for dataflow_v1beta3.types.Job.LabelsEntry class.

TransformNameMappingEntry

TransformNameMappingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for dataflow_v1beta3.types.Job.TransformNameMappingEntry class.