Class Job (0.56.0)

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

Protobuf type google.dataflow.v1beta3.Job

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.

map<string, string> labels = 17;

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

map<string, string> transform_name_mapping = 13;

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.

string client_request_id = 14;

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.

string client_request_id = 14;

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

.google.protobuf.Timestamp create_time = 11;

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

.google.protobuf.Timestamp create_time = 11;

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

string created_from_snapshot_id = 23;

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

string created_from_snapshot_id = 23;

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.dataflow.v1beta3.JobState current_state = 7;

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

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.dataflow.v1beta3.JobState current_state = 7;

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

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.

string id = 1;

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.

string id = 1;

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.dataflow.v1beta3.JobMetadata job_metadata = 21;

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.dataflow.v1beta3.JobMetadata job_metadata = 21;

Use #getLabelsMap() instead.

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.

map<string, string> labels = 17;

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.

map<string, string> labels = 17;

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.

map<string, string> labels = 17;

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.

map<string, string> labels = 17;

The regional endpoint that contains this job.

string location = 18;

The regional endpoint that contains this job.

string location = 18;

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?

string name = 3;

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?

string name = 3;

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.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

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.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

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

string project_id = 2;

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

string project_id = 2;

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.

string replace_job_id = 12;

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.

string replace_job_id = 12;

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.

string replaced_by_job_id = 15;

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.

string replaced_by_job_id = 15;

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.dataflow.v1beta3.JobState requested_state = 9;

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.dataflow.v1beta3.JobState requested_state = 9;

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

bool satisfies_pzs = 25;

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

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

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

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

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

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

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

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

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

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

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.

.google.protobuf.Timestamp start_time = 22;

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.

.google.protobuf.Timestamp start_time = 22;

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.

repeated .google.dataflow.v1beta3.Step steps = 6;

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.

repeated .google.dataflow.v1beta3.Step steps = 6;

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.

repeated .google.dataflow.v1beta3.Step steps = 6;

The Cloud Storage location where the steps are stored.

string steps_location = 24;

The Cloud Storage location where the steps are stored.

string steps_location = 24;

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.

repeated .google.dataflow.v1beta3.Step steps = 6;

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.

repeated .google.dataflow.v1beta3.Step steps = 6;

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}

repeated string temp_files = 16;

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}

repeated string temp_files = 16;

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}

repeated string temp_files = 16;

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}

repeated string temp_files = 16;

Use #getTransformNameMappingMap() instead.

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

map<string, string> transform_name_mapping = 13;

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

map<string, string> transform_name_mapping = 13;

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

map<string, string> transform_name_mapping = 13;

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

map<string, string> transform_name_mapping = 13;

The type of Cloud Dataflow job.

.google.dataflow.v1beta3.JobType type = 4;

The type of Cloud Dataflow job.

.google.dataflow.v1beta3.JobType type = 4;

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

.google.protobuf.Timestamp create_time = 11;

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

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.dataflow.v1beta3.JobMetadata job_metadata = 21;

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.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

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.

.google.protobuf.Timestamp start_time = 22;