Class: Google::Apis::DataflowV1b3::Job

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Job


1871
1872
1873
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1871

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#client_request_idString

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


1701
1702
1703
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1701

def client_request_id
  @client_request_id
end

#create_timeString

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. Corresponds to the JSON property createTime


1707
1708
1709
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1707

def create_time
  @create_time
end

#created_from_snapshot_idString

If this is specified, the job's initial state is populated from the given snapshot. Corresponds to the JSON property createdFromSnapshotId


1713
1714
1715
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1713

def created_from_snapshot_id
  @created_from_snapshot_id
end

#current_stateString

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


1725
1726
1727
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1725

def current_state
  @current_state
end

#current_state_timeString

The timestamp associated with the current state. Corresponds to the JSON property currentStateTime


1730
1731
1732
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1730

def current_state_time
  @current_state_time
end

#environmentGoogle::Apis::DataflowV1b3::Environment

Describes the environment in which a Dataflow Job runs. Corresponds to the JSON property environment


1735
1736
1737
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1735

def environment
  @environment
end

#execution_infoGoogle::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


1741
1742
1743
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1741

def execution_info
  @execution_info
end

#idString

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


1748
1749
1750
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1748

def id
  @id
end

#job_metadataGoogle::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


1754
1755
1756
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1754

def 
  
end

#labelsHash<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: \pLl\pLo0,62
  • Values must conform to regexp: [\pLl\pLo\pN_-]0,63
  • Both keys and values are additionally constrained to be <= 128 bytes in size. Corresponds to the JSON property labels

1765
1766
1767
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1765

def labels
  @labels
end

#locationString

The location that contains this job. Corresponds to the JSON property location


1770
1771
1772
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1770

def location
  @location
end

#nameString

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


1781
1782
1783
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1781

def name
  @name
end

#pipeline_descriptionGoogle::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 interpretting Dataflow provided metrics. Corresponds to the JSON property pipelineDescription


1788
1789
1790
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1788

def pipeline_description
  @pipeline_description
end

#project_idString

The ID of the Cloud Platform project that the job belongs to. Corresponds to the JSON property projectId


1793
1794
1795
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1793

def project_id
  @project_id
end

#replace_job_idString

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


1802
1803
1804
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1802

def replace_job_id
  @replace_job_id
end

#replaced_by_job_idString

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


1808
1809
1810
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1808

def replaced_by_job_id
  @replaced_by_job_id
end

#requested_stateString

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


1818
1819
1820
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1818

def requested_state
  @requested_state
end

#stage_statesArray<Google::Apis::DataflowV1b3::ExecutionStageState>

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. Corresponds to the JSON property stageStates


1824
1825
1826
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1824

def stage_states
  @stage_states
end

#start_timeString

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


1834
1835
1836
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1834

def start_time
  @start_time
end

#stepsArray<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


1840
1841
1842
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1840

def steps
  @steps
end

#steps_locationString

The GCS location where the steps are stored. Corresponds to the JSON property stepsLocation


1845
1846
1847
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1845

def steps_location
  @steps_location
end

#temp_filesArray<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


1858
1859
1860
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1858

def temp_files
  @temp_files
end

#transform_name_mappingHash<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


1864
1865
1866
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1864

def transform_name_mapping
  @transform_name_mapping
end

#typeString

The type of Cloud Dataflow job. Corresponds to the JSON property type


1869
1870
1871
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1869

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1876

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)
   = 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