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

Returns a new instance of Job



1717
1718
1719
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1717

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

Returns:

  • (String) 


1575
1576
1577
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1575

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

Returns:

  • (String) 


1581
1582
1583
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1581

def create_time
  @create_time
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

Returns:

  • (String) 


1593
1594
1595
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1593

def current_state
  @current_state
end

#current_state_time ⇒ String

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

Returns:

  • (String) 


1598
1599
1600
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1598

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

Returns:



1603
1604
1605
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1603

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

Returns:



1609
1610
1611
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1609

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

Returns:

  • (String) 


1616
1617
1618
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1616

def id
  @id
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: \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

Returns:

  • (Hash<String,String>) 


1627
1628
1629
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1627

def labels
  @labels
end

#location ⇒ String

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

Returns:

  • (String) 


1632
1633
1634
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1632

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

Returns:

  • (String) 


1643
1644
1645
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1643

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

Returns:



1650
1651
1652
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1650

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

Returns:

  • (String) 


1655
1656
1657
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1655

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

Returns:

  • (String) 


1664
1665
1666
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1664

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

Returns:

  • (String) 


1670
1671
1672
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1670

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

Returns:

  • (String) 


1680
1681
1682
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1680

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

Returns:



1686
1687
1688
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1686

def stage_states
  @stage_states
end

#steps ⇒ Array<Google::Apis::DataflowV1b3::Step>

The top-level steps that constitute the entire job. Corresponds to the JSON property steps

Returns:



1691
1692
1693
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1691

def steps
  @steps
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

Returns:

  • (Array<String>) 


1704
1705
1706
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1704

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

Returns:

  • (Hash<String,String>) 


1710
1711
1712
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1710

def transform_name_mapping
  @transform_name_mapping
end

#type ⇒ String

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

Returns:

  • (String) 


1715
1716
1717
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1715

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1722

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)
  @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)
  @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)
  @steps = args[:steps] if args.key?(:steps)
  @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