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



1437
1438
1439
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1437

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) 


1434
1435
1436
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1434

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) 


1379
1380
1381
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1379

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) 


1400
1401
1402
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1400

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) 


1384
1385
1386
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1384

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) 


1412
1413
1414
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1412

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) 


1338
1339
1340
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1338

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) 


1328
1329
1330
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1328

def harness_command
  @harness_command
end

#language_hint ⇒ String

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


1389
1390
1391
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1389

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) 


1333
1334
1335
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1333

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) 


1406
1407
1408
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1406

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) 


1354
1355
1356
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1354

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


1344
1345
1346
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1344

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:



1418
1419
1420
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1418

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) 


1359
1360
1361
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1359

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) 


1323
1324
1325
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1323

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) 


1424
1425
1426
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1424

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) 


1374
1375
1376
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1374

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) 


1429
1430
1431
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1429

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) 


1364
1365
1366
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1364

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1442

def update!(**args)
  @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)
  @log_upload_location = args[:log_upload_location] if args.key?(:log_upload_location)
  @streaming_worker_main_class = args[:streaming_worker_main_class] if args.key?(:streaming_worker_main_class)
  @workflow_file_name = args[:workflow_file_name] if args.key?(:workflow_file_name)
  @temp_storage_prefix = args[:temp_storage_prefix] if args.key?(:temp_storage_prefix)
  @base_task_dir = args[:base_task_dir] if args.key?(:base_task_dir)
  @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)
  @alsologtostderr = args[:alsologtostderr] if args.key?(:alsologtostderr)
end