Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::Job.
Defines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#client_request_id
def client_request_id() -> ::String
- (::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.
#client_request_id=
def client_request_id=(value) -> ::String
- value (::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.
- (::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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
- value (::Google::Protobuf::Timestamp) — The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
- (::Google::Protobuf::Timestamp) — The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
#created_from_snapshot_id
def created_from_snapshot_id() -> ::String
- (::String) — If this is specified, the job's initial state is populated from the given snapshot.
#created_from_snapshot_id=
def created_from_snapshot_id=(value) -> ::String
- value (::String) — If this is specified, the job's initial state is populated from the given snapshot.
- (::String) — If this is specified, the job's initial state is populated from the given snapshot.
#current_state
def current_state() -> ::Google::Cloud::Dataflow::V1beta3::JobState
-
(::Google::Cloud::Dataflow::V1beta3::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 might be mutated by the Dataflow service; callers cannot mutate it.
#current_state=
def current_state=(value) -> ::Google::Cloud::Dataflow::V1beta3::JobState
-
value (::Google::Cloud::Dataflow::V1beta3::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 might be mutated by the Dataflow service; callers cannot mutate it.
-
(::Google::Cloud::Dataflow::V1beta3::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 might be mutated by the Dataflow service; callers cannot mutate it.
#current_state_time
def current_state_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — The timestamp associated with the current state.
#current_state_time=
def current_state_time=(value) -> ::Google::Protobuf::Timestamp
- value (::Google::Protobuf::Timestamp) — The timestamp associated with the current state.
- (::Google::Protobuf::Timestamp) — The timestamp associated with the current state.
#environment
def environment() -> ::Google::Cloud::Dataflow::V1beta3::Environment
- (::Google::Cloud::Dataflow::V1beta3::Environment) — Optional. The environment for the job.
#environment=
def environment=(value) -> ::Google::Cloud::Dataflow::V1beta3::Environment
- value (::Google::Cloud::Dataflow::V1beta3::Environment) — Optional. The environment for the job.
- (::Google::Cloud::Dataflow::V1beta3::Environment) — Optional. The environment for the job.
#execution_info
def execution_info() -> ::Google::Cloud::Dataflow::V1beta3::JobExecutionInfo
- (::Google::Cloud::Dataflow::V1beta3::JobExecutionInfo) — Deprecated.
#execution_info=
def execution_info=(value) -> ::Google::Cloud::Dataflow::V1beta3::JobExecutionInfo
- value (::Google::Cloud::Dataflow::V1beta3::JobExecutionInfo) — Deprecated.
- (::Google::Cloud::Dataflow::V1beta3::JobExecutionInfo) — Deprecated.
#id
def id() -> ::String
-
(::String) — The 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.
#id=
def id=(value) -> ::String
-
value (::String) — The 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.
-
(::String) — The 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_metadata
def job_metadata() -> ::Google::Cloud::Dataflow::V1beta3::JobMetadata
- (::Google::Cloud::Dataflow::V1beta3::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.
#job_metadata=
def job_metadata=(value) -> ::Google::Cloud::Dataflow::V1beta3::JobMetadata
- value (::Google::Cloud::Dataflow::V1beta3::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.
- (::Google::Cloud::Dataflow::V1beta3::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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::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.
-
(::Google::Protobuf::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
def location() -> ::String
- (::String) — Optional. The regional endpoint that contains this job.
#location=
def location=(value) -> ::String
- value (::String) — Optional. The regional endpoint that contains this job.
- (::String) — Optional. The regional endpoint that contains this job.
#name
def name() -> ::String
-
(::String) — Optional. 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])?
#name=
def name=(value) -> ::String
-
value (::String) — Optional. 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])?
-
(::String) — Optional. 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])?
#pipeline_description
def pipeline_description() -> ::Google::Cloud::Dataflow::V1beta3::PipelineDescription
- (::Google::Cloud::Dataflow::V1beta3::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.
#pipeline_description=
def pipeline_description=(value) -> ::Google::Cloud::Dataflow::V1beta3::PipelineDescription
- value (::Google::Cloud::Dataflow::V1beta3::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.
- (::Google::Cloud::Dataflow::V1beta3::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.
#project_id
def project_id() -> ::String
- (::String) — The ID of the Google Cloud project that the job belongs to.
#project_id=
def project_id=(value) -> ::String
- value (::String) — The ID of the Google Cloud project that the job belongs to.
- (::String) — The ID of the Google Cloud project that the job belongs to.
#replace_job_id
def replace_job_id() -> ::String
-
(::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.
#replace_job_id=
def replace_job_id=(value) -> ::String
-
value (::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.
-
(::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.
#replaced_by_job_id
def replaced_by_job_id() -> ::String
-
(::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.
#replaced_by_job_id=
def replaced_by_job_id=(value) -> ::String
-
value (::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.
-
(::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.
#requested_state
def requested_state() -> ::Google::Cloud::Dataflow::V1beta3::JobState
-
(::Google::Cloud::Dataflow::V1beta3::JobState) — The job's requested state. Applies to
UpdateJob
requests.Set
requested_state
withUpdateJob
requests to switch between the statesJOB_STATE_STOPPED
andJOB_STATE_RUNNING
. You can also useUpdateJob
requests to change a job's state fromJOB_STATE_RUNNING
toJOB_STATE_CANCELLED
,JOB_STATE_DONE
, orJOB_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.
#requested_state=
def requested_state=(value) -> ::Google::Cloud::Dataflow::V1beta3::JobState
-
value (::Google::Cloud::Dataflow::V1beta3::JobState) — The job's requested state. Applies to
UpdateJob
requests.Set
requested_state
withUpdateJob
requests to switch between the statesJOB_STATE_STOPPED
andJOB_STATE_RUNNING
. You can also useUpdateJob
requests to change a job's state fromJOB_STATE_RUNNING
toJOB_STATE_CANCELLED
,JOB_STATE_DONE
, orJOB_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.
-
(::Google::Cloud::Dataflow::V1beta3::JobState) — The job's requested state. Applies to
UpdateJob
requests.Set
requested_state
withUpdateJob
requests to switch between the statesJOB_STATE_STOPPED
andJOB_STATE_RUNNING
. You can also useUpdateJob
requests to change a job's state fromJOB_STATE_RUNNING
toJOB_STATE_CANCELLED
,JOB_STATE_DONE
, orJOB_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.
#runtime_updatable_params
def runtime_updatable_params() -> ::Google::Cloud::Dataflow::V1beta3::RuntimeUpdatableParams
- (::Google::Cloud::Dataflow::V1beta3::RuntimeUpdatableParams) — This 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.
#runtime_updatable_params=
def runtime_updatable_params=(value) -> ::Google::Cloud::Dataflow::V1beta3::RuntimeUpdatableParams
- value (::Google::Cloud::Dataflow::V1beta3::RuntimeUpdatableParams) — This 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.
- (::Google::Cloud::Dataflow::V1beta3::RuntimeUpdatableParams) — This 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_pzi
def satisfies_pzi() -> ::Boolean
- (::Boolean) — Output 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_pzs
def satisfies_pzs() -> ::Boolean
- (::Boolean) — 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_pzs=
def satisfies_pzs=(value) -> ::Boolean
- value (::Boolean) — Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
- (::Boolean) — Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
#service_resources
def service_resources() -> ::Google::Cloud::Dataflow::V1beta3::ServiceResources
- (::Google::Cloud::Dataflow::V1beta3::ServiceResources) — Output only. Resources used by the Dataflow Service to run the job.
#stage_states
def stage_states() -> ::Array<::Google::Cloud::Dataflow::V1beta3::ExecutionStageState>
- (::Array<::Google::Cloud::Dataflow::V1beta3::ExecutionStageState>) — This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
#stage_states=
def stage_states=(value) -> ::Array<::Google::Cloud::Dataflow::V1beta3::ExecutionStageState>
- value (::Array<::Google::Cloud::Dataflow::V1beta3::ExecutionStageState>) — This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
- (::Array<::Google::Cloud::Dataflow::V1beta3::ExecutionStageState>) — This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::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.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
- value (::Google::Protobuf::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.
- (::Google::Protobuf::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.
#steps
def steps() -> ::Array<::Google::Cloud::Dataflow::V1beta3::Step>
-
(::Array<::Google::Cloud::Dataflow::V1beta3::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=
def steps=(value) -> ::Array<::Google::Cloud::Dataflow::V1beta3::Step>
-
value (::Array<::Google::Cloud::Dataflow::V1beta3::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.
-
(::Array<::Google::Cloud::Dataflow::V1beta3::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
def steps_location() -> ::String
- (::String) — The Cloud Storage location where the steps are stored.
#steps_location=
def steps_location=(value) -> ::String
- value (::String) — The Cloud Storage location where the steps are stored.
- (::String) — The Cloud Storage location where the steps are stored.
#temp_files
def temp_files() -> ::Array<::String>
-
(::Array<::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}
#temp_files=
def temp_files=(value) -> ::Array<::String>
-
value (::Array<::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}
-
(::Array<::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}
#transform_name_mapping
def transform_name_mapping() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
#transform_name_mapping=
def transform_name_mapping=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
- (::Google::Protobuf::Map{::String => ::String}) — Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
#type
def type() -> ::Google::Cloud::Dataflow::V1beta3::JobType
- (::Google::Cloud::Dataflow::V1beta3::JobType) — Optional. The type of Dataflow job.
#type=
def type=(value) -> ::Google::Cloud::Dataflow::V1beta3::JobType
- value (::Google::Cloud::Dataflow::V1beta3::JobType) — Optional. The type of Dataflow job.
- (::Google::Cloud::Dataflow::V1beta3::JobType) — Optional. The type of Dataflow job.