Class: Google::Apis::DataflowV1b3::WorkItem

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

WorkItem represents basic information about a WorkItem to be executed in the cloud.

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) ⇒ WorkItem

Returns a new instance of WorkItem



2020
2021
2022
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2020

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

Instance Attribute Details

#configuration ⇒ String

Work item-specific configuration as an opaque blob. Corresponds to the JSON property configuration

Returns:

  • (String) 


1946
1947
1948
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1946

def configuration
  @configuration
end

#id ⇒ Fixnum

Identifies this WorkItem. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


1941
1942
1943
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1941

def id
  @id
end

#initial_report_index ⇒ Fixnum

The initial index to use when reporting the status of the WorkItem. Corresponds to the JSON property initialReportIndex

Returns:

  • (Fixnum) 


2002
2003
2004
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2002

def initial_report_index
  @initial_report_index
end

#job_id ⇒ String

Identifies the workflow job this WorkItem belongs to. Corresponds to the JSON property jobId

Returns:

  • (String) 


2018
2019
2020
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2018

def job_id
  @job_id
end

#lease_expire_time ⇒ String

Time when the lease on this Work will expire. Corresponds to the JSON property leaseExpireTime

Returns:

  • (String) 


1997
1998
1999
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1997

def lease_expire_time
  @lease_expire_time
end

#map_task ⇒ Google::Apis::DataflowV1b3::MapTask

MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output. Corresponds to the JSON property mapTask

Returns:



1955
1956
1957
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1955

def map_task
  @map_task
end

#packages ⇒ Array<Google::Apis::DataflowV1b3::Package>

Any required packages that need to be fetched in order to execute this WorkItem. Corresponds to the JSON property packages

Returns:



1966
1967
1968
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1966

def packages
  @packages
end

#project_id ⇒ String

Identifies the cloud project this WorkItem belongs to. Corresponds to the JSON property projectId

Returns:

  • (String) 


1971
1972
1973
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1971

def project_id
  @project_id
end

#report_status_interval ⇒ String

Recommended reporting interval. Corresponds to the JSON property reportStatusInterval

Returns:

  • (String) 


1987
1988
1989
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1987

def report_status_interval
  @report_status_interval
end

#seq_map_task ⇒ Google::Apis::DataflowV1b3::SeqMapTask

Describes a particular function to invoke. Corresponds to the JSON property seqMapTask

Returns:



1960
1961
1962
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1960

def seq_map_task
  @seq_map_task
end

#shell_task ⇒ Google::Apis::DataflowV1b3::ShellTask

A task which consists of a shell command for the worker to execute. Corresponds to the JSON property shellTask

Returns:



2013
2014
2015
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2013

def shell_task
  @shell_task
end

#source_operation_task ⇒ Google::Apis::DataflowV1b3::SourceOperationRequest

A work item that represents the different operations that can be performed on a user-defined Source specification. Corresponds to the JSON property sourceOperationTask

Returns:



1977
1978
1979
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1977

def source_operation_task
  @source_operation_task
end

#streaming_computation_task ⇒ Google::Apis::DataflowV1b3::StreamingComputationTask

A task which describes what action should be performed for the specified streaming computation ranges. Corresponds to the JSON property streamingComputationTask

Returns:



2008
2009
2010
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2008

def streaming_computation_task
  @streaming_computation_task
end

#streaming_config_task ⇒ Google::Apis::DataflowV1b3::StreamingConfigTask

A task that carries configuration information for streaming computations. Corresponds to the JSON property streamingConfigTask

Returns:



1992
1993
1994
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1992

def streaming_config_task
  @streaming_config_task
end

#streaming_setup_task ⇒ Google::Apis::DataflowV1b3::StreamingSetupTask

A task which initializes part of a streaming Dataflow job. Corresponds to the JSON property streamingSetupTask

Returns:



1982
1983
1984
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1982

def streaming_setup_task
  @streaming_setup_task
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2025

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @configuration = args[:configuration] if args.key?(:configuration)
  @map_task = args[:map_task] if args.key?(:map_task)
  @seq_map_task = args[:seq_map_task] if args.key?(:seq_map_task)
  @packages = args[:packages] if args.key?(:packages)
  @project_id = args[:project_id] if args.key?(:project_id)
  @source_operation_task = args[:source_operation_task] if args.key?(:source_operation_task)
  @streaming_setup_task = args[:streaming_setup_task] if args.key?(:streaming_setup_task)
  @report_status_interval = args[:report_status_interval] if args.key?(:report_status_interval)
  @streaming_config_task = args[:streaming_config_task] if args.key?(:streaming_config_task)
  @lease_expire_time = args[:lease_expire_time] if args.key?(:lease_expire_time)
  @initial_report_index = args[:initial_report_index] if args.key?(:initial_report_index)
  @streaming_computation_task = args[:streaming_computation_task] if args.key?(:streaming_computation_task)
  @shell_task = args[:shell_task] if args.key?(:shell_task)
  @job_id = args[:job_id] if args.key?(:job_id)
end