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.



5022
5023
5024
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5022

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

Instance Attribute Details

#alsologtostderrBoolean Also known as: alsologtostderr?

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

Returns:

  • (Boolean)


4907
4908
4909
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4907

def alsologtostderr
  @alsologtostderr
end

#base_task_dirString

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

Returns:

  • (String)


4913
4914
4915
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4913

def base_task_dir
  @base_task_dir
end

#base_urlString

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)


4924
4925
4926
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4924

def base_url
  @base_url
end

#commandlines_file_nameString

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

Returns:

  • (String)


4929
4930
4931
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4929

def commandlines_file_name
  @commandlines_file_name
end

#continue_on_exceptionBoolean Also known as: continue_on_exception?

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

Returns:

  • (Boolean)


4934
4935
4936
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4934

def continue_on_exception
  @continue_on_exception
end

#dataflow_api_versionString

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

Returns:

  • (String)


4940
4941
4942
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4940

def dataflow_api_version
  @dataflow_api_version
end

#harness_commandString

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

Returns:

  • (String)


4945
4946
4947
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4945

def harness_command
  @harness_command
end

#language_hintString

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String)


4950
4951
4952
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4950

def language_hint
  @language_hint
end

#log_dirString

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

Returns:

  • (String)


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

def log_dir
  @log_dir
end

#log_to_serialconsoleBoolean 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)


4961
4962
4963
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4961

def log_to_serialconsole
  @log_to_serialconsole
end

#log_upload_locationString

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)


4972
4973
4974
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4972

def log_upload_location
  @log_upload_location
end

#oauth_scopesArray<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>)


4978
4979
4980
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4978

def oauth_scopes
  @oauth_scopes
end

#parallel_worker_settingsGoogle::Apis::DataflowV1b3::WorkerSettings

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



4983
4984
4985
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4983

def parallel_worker_settings
  @parallel_worker_settings
end

#streaming_worker_main_classString

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

Returns:

  • (String)


4988
4989
4990
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4988

def streaming_worker_main_class
  @streaming_worker_main_class
end

#task_groupString

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)


4994
4995
4996
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4994

def task_group
  @task_group
end

#task_userString

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)


5000
5001
5002
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5000

def task_user
  @task_user
end

#temp_storage_prefixString

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)


5010
5011
5012
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5010

def temp_storage_prefix
  @temp_storage_prefix
end

#vm_idString

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

Returns:

  • (String)


5015
5016
5017
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5015

def vm_id
  @vm_id
end

#workflow_file_nameString

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

Returns:

  • (String)


5020
5021
5022
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5020

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5027

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