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



1517
1518
1519
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1517

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) 


1431
1432
1433
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1431

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) 


1484
1485
1486
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1484

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) 


1515
1516
1517
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1515

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) 


1499
1500
1501
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1499

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) 


1409
1410
1411
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1409

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) 


1459
1460
1461
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1459

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) 


1443
1444
1445
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1443

def harness_command
  @harness_command
end

#language_hint ⇒ String

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


1504
1505
1506
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1504

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) 


1448
1449
1450
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1448

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) 


1403
1404
1405
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1403

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) 


1469
1470
1471
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1469

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


1454
1455
1456
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1454

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:



1415
1416
1417
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1415

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) 


1474
1475
1476
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1474

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) 


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

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) 


1426
1427
1428
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1426

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) 


1494
1495
1496
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1494

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) 


1420
1421
1422
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1420

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) 


1479
1480
1481
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1479

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1522

def update!(**args)
  @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)
  @vm_id = args[:vm_id] if args.key?(:vm_id)
  @task_user = args[:task_user] if args.key?(:task_user)
  @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)
  @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes)
  @dataflow_api_version = args[:dataflow_api_version] if args.key?(:dataflow_api_version)
  @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)
  @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)
end