Class: Google::Apis::DataflowV1b3::Job
- Inherits:
-
Object
- Object
- Google::Apis::DataflowV1b3::Job
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dataflow_v1b3/classes.rb,
generated/google/apis/dataflow_v1b3/representations.rb,
generated/google/apis/dataflow_v1b3/representations.rb
Overview
Defines a job to be run by the Cloud Dataflow service.
Instance Attribute Summary collapse
-
#client_request_id ⇒ String
The client's unique identifier of the job, re-used across retried attempts.
-
#create_time ⇒ String
The timestamp when the job was initially created.
-
#created_from_snapshot_id ⇒ String
If this is specified, the job's initial state is populated from the given snapshot.
-
#current_state ⇒ String
The current state of the job.
-
#current_state_time ⇒ String
The timestamp associated with the current state.
-
#environment ⇒ Google::Apis::DataflowV1b3::Environment
Describes the environment in which a Dataflow Job runs.
-
#execution_info ⇒ Google::Apis::DataflowV1b3::JobExecutionInfo
Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.
-
#id ⇒ String
The unique ID of this job.
-
#job_metadata ⇒ Google::Apis::DataflowV1b3::JobMetadata
Metadata available primarily for filtering jobs.
-
#labels ⇒ Hash<String,String>
User-defined labels for this job.
-
#location ⇒ String
The regional endpoint that contains this job.
-
#name ⇒ String
The user-specified Cloud Dataflow job name.
-
#pipeline_description ⇒ Google::Apis::DataflowV1b3::PipelineDescription
A descriptive representation of submitted pipeline as well as the executed form.
-
#project_id ⇒ String
The ID of the Cloud Platform project that the job belongs to.
-
#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.
-
#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. -
#requested_state ⇒ String
The job's requested state.
-
#stage_states ⇒ Array<Google::Apis::DataflowV1b3::ExecutionStageState>
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
-
#start_time ⇒ String
The timestamp when the job was started (transitioned to JOB_STATE_PENDING).
-
#steps ⇒ Array<Google::Apis::DataflowV1b3::Step>
Exactly one of step or steps_location should be specified.
-
#steps_location ⇒ String
The GCS location where the steps are stored.
-
#temp_files ⇒ Array<String>
A set of files the system should be aware of that are used for temporary storage.
-
#transform_name_mapping ⇒ Hash<String,String>
The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
-
#type ⇒ String
The type of Cloud Dataflow job.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Job
constructor
A new instance of Job.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Job
Returns a new instance of Job
1908 1909 1910 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1908 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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.
Corresponds to the JSON property clientRequestId
1736 1737 1738 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1736 def client_request_id @client_request_id end |
#create_time ⇒ String
The timestamp when the job was initially created. Immutable and set by the
Cloud Dataflow service.
Corresponds to the JSON property createTime
1742 1743 1744 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1742 def create_time @create_time end |
#created_from_snapshot_id ⇒ String
If this is specified, the job's initial state is populated from the given
snapshot.
Corresponds to the JSON property createdFromSnapshotId
1748 1749 1750 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1748 def created_from_snapshot_id @created_from_snapshot_id end |
#current_state ⇒ String
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.
Corresponds to the JSON property currentState
1760 1761 1762 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1760 def current_state @current_state end |
#current_state_time ⇒ String
The timestamp associated with the current state.
Corresponds to the JSON property currentStateTime
1765 1766 1767 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1765 def current_state_time @current_state_time end |
#environment ⇒ Google::Apis::DataflowV1b3::Environment
Describes the environment in which a Dataflow Job runs.
Corresponds to the JSON property environment
1770 1771 1772 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1770 def environment @environment end |
#execution_info ⇒ Google::Apis::DataflowV1b3::JobExecutionInfo
Additional information about how a Cloud Dataflow job will be executed that
isn't contained in the submitted job.
Corresponds to the JSON property executionInfo
1776 1777 1778 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1776 def execution_info @execution_info end |
#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.
Corresponds to the JSON property id
1783 1784 1785 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1783 def id @id end |
#job_metadata ⇒ Google::Apis::DataflowV1b3::JobMetadata
Metadata available primarily for filtering jobs. Will be included in the
ListJob response and Job SUMMARY view.
Corresponds to the JSON property jobMetadata
1789 1790 1791 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1789 def @job_metadata end |
#labels ⇒ Hash<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
\pLo
0,62
- Values must conform to regexp: [\p
Ll
\pLo
\pN
_-]0,63
- Both keys and values are additionally constrained to be <= 128 bytes in
size.
Corresponds to the JSON property
labels
1800 1801 1802 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1800 def labels @labels end |
#location ⇒ String
The regional endpoint that
contains this job.
Corresponds to the JSON property location
1807 1808 1809 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1807 def location @location end |
#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])?
Corresponds to the JSON property name
1818 1819 1820 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1818 def name @name end |
#pipeline_description ⇒ Google::Apis::DataflowV1b3::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.
Corresponds to the JSON property pipelineDescription
1825 1826 1827 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1825 def pipeline_description @pipeline_description end |
#project_id ⇒ String
The ID of the Cloud Platform project that the job belongs to.
Corresponds to the JSON property projectId
1830 1831 1832 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1830 def project_id @project_id end |
#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.
Corresponds to the JSON property replaceJobId
1839 1840 1841 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1839 def replace_job_id @replace_job_id end |
#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.
Corresponds to the JSON property replacedByJobId
1845 1846 1847 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1845 def replaced_by_job_id @replaced_by_job_id end |
#requested_state ⇒ String
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.
Corresponds to the JSON property requestedState
1855 1856 1857 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1855 def requested_state @requested_state end |
#stage_states ⇒ Array<Google::Apis::DataflowV1b3::ExecutionStageState>
This field may be mutated by the Cloud Dataflow service;
callers cannot mutate it.
Corresponds to the JSON property stageStates
1861 1862 1863 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1861 def stage_states @stage_states end |
#start_time ⇒ String
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.
Corresponds to the JSON property startTime
1871 1872 1873 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1871 def start_time @start_time end |
#steps ⇒ Array<Google::Apis::DataflowV1b3::Step>
Exactly one of step or steps_location should be specified.
The top-level steps that constitute the entire job.
Corresponds to the JSON property steps
1877 1878 1879 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1877 def steps @steps end |
#steps_location ⇒ String
The GCS location where the steps are stored.
Corresponds to the JSON property stepsLocation
1882 1883 1884 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1882 def steps_location @steps_location end |
#temp_files ⇒ 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
Corresponds to the JSON property tempFiles
1895 1896 1897 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1895 def temp_files @temp_files end |
#transform_name_mapping ⇒ Hash<String,String>
The map of transform name prefixes of the job to be replaced to the
corresponding name prefixes of the new job.
Corresponds to the JSON property transformNameMapping
1901 1902 1903 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1901 def transform_name_mapping @transform_name_mapping end |
#type ⇒ String
The type of Cloud Dataflow job.
Corresponds to the JSON property type
1906 1907 1908 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1906 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1913 def update!(**args) @client_request_id = args[:client_request_id] if args.key?(:client_request_id) @create_time = args[:create_time] if args.key?(:create_time) @created_from_snapshot_id = args[:created_from_snapshot_id] if args.key?(:created_from_snapshot_id) @current_state = args[:current_state] if args.key?(:current_state) @current_state_time = args[:current_state_time] if args.key?(:current_state_time) @environment = args[:environment] if args.key?(:environment) @execution_info = args[:execution_info] if args.key?(:execution_info) @id = args[:id] if args.key?(:id) @job_metadata = args[:job_metadata] if args.key?(:job_metadata) @labels = args[:labels] if args.key?(:labels) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @pipeline_description = args[:pipeline_description] if args.key?(:pipeline_description) @project_id = args[:project_id] if args.key?(:project_id) @replace_job_id = args[:replace_job_id] if args.key?(:replace_job_id) @replaced_by_job_id = args[:replaced_by_job_id] if args.key?(:replaced_by_job_id) @requested_state = args[:requested_state] if args.key?(:requested_state) @stage_states = args[:stage_states] if args.key?(:stage_states) @start_time = args[:start_time] if args.key?(:start_time) @steps = args[:steps] if args.key?(:steps) @steps_location = args[:steps_location] if args.key?(:steps_location) @temp_files = args[:temp_files] if args.key?(:temp_files) @transform_name_mapping = args[:transform_name_mapping] if args.key?(:transform_name_mapping) @type = args[:type] if args.key?(:type) end |