Class: Google::Apis::DataflowV1b3::TaskRunnerSettings

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

Taskrunner configuration settings.

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

Returns a new instance of TaskRunnerSettings.



5052
5053
5054
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5052

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

Instance Attribute Details

#alsologtostderr ⇒ Boolean Also known as: alsologtostderr?

Whether to also send taskrunner log info to stderr. Corresponds to the JSON property alsologtostderr

Returns:

  • (Boolean) 


4937
4938
4939
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4937

def alsologtostderr
  @alsologtostderr
end

#base_task_dir ⇒ String

The location on the worker for task-specific subdirectories. Corresponds to the JSON property baseTaskDir

Returns:

  • (String) 


4943
4944
4945
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4943

def base_task_dir
  @base_task_dir
end

#base_url ⇒ String

The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/" Corresponds to the JSON property baseUrl

Returns:

  • (String) 


4954
4955
4956
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4954

def base_url
  @base_url
end

#commandlines_file_name ⇒ String

The file to store preprocessing commands in. Corresponds to the JSON property commandlinesFileName

Returns:

  • (String) 


4959
4960
4961
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4959

def commandlines_file_name
  @commandlines_file_name
end

#continue_on_exception ⇒ Boolean Also known as: continue_on_exception?

Whether to continue taskrunner if an exception is hit. Corresponds to the JSON property continueOnException

Returns:

  • (Boolean) 


4964
4965
4966
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4964

def continue_on_exception
  @continue_on_exception
end

#dataflow_api_version ⇒ String

The API version of endpoint, e.g. "v1b3" Corresponds to the JSON property dataflowApiVersion

Returns:

  • (String) 


4970
4971
4972
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4970

def dataflow_api_version
  @dataflow_api_version
end

#harness_command ⇒ String

The command to launch the worker harness. Corresponds to the JSON property harnessCommand

Returns:

  • (String) 


4975
4976
4977
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4975

def harness_command
  @harness_command
end

#language_hint ⇒ String

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


4980
4981
4982
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4980

def language_hint
  @language_hint
end

#log_dir ⇒ String

The directory on the VM to store logs. Corresponds to the JSON property logDir

Returns:

  • (String) 


4985
4986
4987
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4985

def log_dir
  @log_dir
end

#log_to_serialconsole ⇒ Boolean Also known as: log_to_serialconsole?

Whether to send taskrunner log info to Google Compute Engine VM serial console. Corresponds to the JSON property logToSerialconsole

Returns:

  • (Boolean) 


4991
4992
4993
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4991

def log_to_serialconsole
  @log_to_serialconsole
end

#log_upload_location ⇒ String

Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/bucket/object bucket.storage.googleapis.com/object Corresponds to the JSON property logUploadLocation

Returns:

  • (String) 


5002
5003
5004
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5002

def log_upload_location
  @log_upload_location
end

#oauth_scopes ⇒ Array<String>

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. Corresponds to the JSON property oauthScopes

Returns:

  • (Array<String>) 


5008
5009
5010
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5008

def oauth_scopes
  @oauth_scopes
end

#parallel_worker_settings ⇒ Google::Apis::DataflowV1b3::WorkerSettings

Provides data to pass through to the worker harness. Corresponds to the JSON property parallelWorkerSettings

Returns:



5013
5014
5015
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5013

def parallel_worker_settings
  @parallel_worker_settings
end

#streaming_worker_main_class ⇒ String

The streaming worker main class name. Corresponds to the JSON property streamingWorkerMainClass

Returns:

  • (String) 


5018
5019
5020
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5018

def streaming_worker_main_class
  @streaming_worker_main_class
end

#task_group ⇒ String

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". Corresponds to the JSON property taskGroup

Returns:

  • (String) 


5024
5025
5026
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5024

def task_group
  @task_group
end

#task_user ⇒ String

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". Corresponds to the JSON property taskUser

Returns:

  • (String) 


5030
5031
5032
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5030

def task_user
  @task_user
end

#temp_storage_prefix ⇒ String

The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/bucket/object bucket.storage.googleapis.com/object Corresponds to the JSON property tempStoragePrefix

Returns:

  • (String) 


5040
5041
5042
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5040

def temp_storage_prefix
  @temp_storage_prefix
end

#vm_id ⇒ String

The ID string of the VM. Corresponds to the JSON property vmId

Returns:

  • (String) 


5045
5046
5047
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5045

def vm_id
  @vm_id
end

#workflow_file_name ⇒ String

The file to store the workflow in. Corresponds to the JSON property workflowFileName

Returns:

  • (String) 


5050
5051
5052
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5050

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5057

def update!(**args)
  @alsologtostderr = args[:alsologtostderr] if args.key?(:alsologtostderr)
  @base_task_dir = args[:base_task_dir] if args.key?(:base_task_dir)
  @base_url = args[:base_url] if args.key?(:base_url)
  @commandlines_file_name = args[:commandlines_file_name] if args.key?(:commandlines_file_name)
  @continue_on_exception = args[:continue_on_exception] if args.key?(:continue_on_exception)
  @dataflow_api_version = args[:dataflow_api_version] if args.key?(:dataflow_api_version)
  @harness_command = args[:harness_command] if args.key?(:harness_command)
  @language_hint = args[:language_hint] if args.key?(:language_hint)
  @log_dir = args[:log_dir] if args.key?(:log_dir)
  @log_to_serialconsole = args[:log_to_serialconsole] if args.key?(:log_to_serialconsole)
  @log_upload_location = args[:log_upload_location] if args.key?(:log_upload_location)
  @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes)
  @parallel_worker_settings = args[:parallel_worker_settings] if args.key?(:parallel_worker_settings)
  @streaming_worker_main_class = args[:streaming_worker_main_class] if args.key?(:streaming_worker_main_class)
  @task_group = args[:task_group] if args.key?(:task_group)
  @task_user = args[:task_user] if args.key?(:task_user)
  @temp_storage_prefix = args[:temp_storage_prefix] if args.key?(:temp_storage_prefix)
  @vm_id = args[:vm_id] if args.key?(:vm_id)
  @workflow_file_name = args[:workflow_file_name] if args.key?(:workflow_file_name)
end