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



4809
4810
4811
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4809

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) 


4694
4695
4696
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4694

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) 


4700
4701
4702
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4700

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) 


4711
4712
4713
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4711

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) 


4716
4717
4718
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4716

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) 


4721
4722
4723
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4721

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) 


4727
4728
4729
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4727

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) 


4732
4733
4734
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4732

def harness_command
  @harness_command
end

#language_hint ⇒ String

The suggested backend language. Corresponds to the JSON property languageHint

Returns:

  • (String) 


4737
4738
4739
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4737

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) 


4742
4743
4744
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4742

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) 


4748
4749
4750
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4748

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) 


4759
4760
4761
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4759

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


4765
4766
4767
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4765

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:



4770
4771
4772
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4770

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) 


4775
4776
4777
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4775

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) 


4781
4782
4783
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4781

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) 


4787
4788
4789
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4787

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) 


4797
4798
4799
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4797

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) 


4802
4803
4804
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4802

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) 


4807
4808
4809
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4807

def workflow_file_name
  @workflow_file_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4814

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