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.



659
660
661
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 659

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

Instance Attribute Details

#alsologtostderr ⇒ Boolean Also known as: alsologtostderr?

Also send taskrunner log info to stderr? Corresponds to the JSON property alsologtostderr

Returns:

  • (Boolean) 


607
608
609
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 607

def alsologtostderr
  @alsologtostderr
end

#base_task_dir ⇒ String

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

Returns:

  • (String) 


590
591
592
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 590

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) 


575
576
577
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 575

def base_url
  @base_url
end

#commandlines_file_name ⇒ String

Store preprocessing commands in this file. Corresponds to the JSON property commandlinesFileName

Returns:

  • (String) 


642
643
644
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 642

def commandlines_file_name
  @commandlines_file_name
end

#continue_on_exception ⇒ Boolean Also known as: continue_on_exception?

Do we continue taskrunner if an exception is hit? Corresponds to the JSON property continueOnException

Returns:

  • (Boolean) 


595
596
597
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 595

def continue_on_exception
  @continue_on_exception
end

#dataflow_api_version ⇒ String

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

Returns:

  • (String) 


580
581
582
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 580

def dataflow_api_version
  @dataflow_api_version
end

#harness_command ⇒ String

Command to launch the worker harness. Corresponds to the JSON property harnessCommand

Returns:

  • (String) 


632
633
634
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 632

def harness_command
  @harness_command
end

#language_hint ⇒ String

Suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


652
653
654
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 652

def language_hint
  @language_hint
end

#log_dir ⇒ String

Directory on the VM to store logs. Corresponds to the JSON property logDir

Returns:

  • (String) 


620
621
622
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 620

def log_dir
  @log_dir
end

#log_to_serialconsole ⇒ Boolean Also known as: log_to_serialconsole?

Send taskrunner log into to Google Compute Engine VM serial console? Corresponds to the JSON property logToSerialconsole

Returns:

  • (Boolean) 


601
602
603
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 601

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) 


615
616
617
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 615

def log_upload_location
  @log_upload_location
end

#oauth_scopes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


565
566
567
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 565

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:



585
586
587
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 585

def parallel_worker_settings
  @parallel_worker_settings
end

#streaming_worker_main_class ⇒ String

Streaming worker main class name. Corresponds to the JSON property streamingWorkerMainClass

Returns:

  • (String) 


657
658
659
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 657

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) 


559
560
561
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 559

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) 


553
554
555
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 553

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) 


627
628
629
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 627

def temp_storage_prefix
  @temp_storage_prefix
end

#vm_id ⇒ String

ID string of VM. Corresponds to the JSON property vmId

Returns:

  • (String) 


647
648
649
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 647

def vm_id
  @vm_id
end

#workflow_file_name ⇒ String

Store the workflow in this file. Corresponds to the JSON property workflowFileName

Returns:

  • (String) 


637
638
639
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 637

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 664

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