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



199
200
201
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 199

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) 


84
85
86
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 84

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) 


137
138
139
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 137

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) 


168
169
170
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 168

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) 


152
153
154
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 152

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) 


180
181
182
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 180

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) 


106
107
108
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 106

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) 


96
97
98
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 96

def harness_command
  @harness_command
end

#language_hint ⇒ String

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


157
158
159
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 157

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) 


101
102
103
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 101

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) 


174
175
176
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 174

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) 


127
128
129
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 127

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


112
113
114
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 112

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:



186
187
188
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 186

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) 


117
118
119
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 117

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) 


91
92
93
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 91

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) 


192
193
194
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 192

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) 


147
148
149
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 147

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) 


197
198
199
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 197

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) 


132
133
134
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 132

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 204

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