Class: Google::Apis::DataflowV1b3::WorkerSettings

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

Provides data to pass through to the worker harness.

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

Returns a new instance of WorkerSettings



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

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

Instance Attribute Details

#base_url ⇒ String

The base URL for 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) 


618
619
620
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 618

def base_url
  @base_url
end

#reporting_enabled ⇒ Boolean Also known as: reporting_enabled?

Whether to send work progress updates to the service. Corresponds to the JSON property reportingEnabled

Returns:

  • (Boolean) 


623
624
625
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 623

def reporting_enabled
  @reporting_enabled
end

#service_path ⇒ String

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". Corresponds to the JSON property servicePath

Returns:

  • (String) 


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

def service_path
  @service_path
end

#shuffle_service_path ⇒ String

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". Corresponds to the JSON property shuffleServicePath

Returns:

  • (String) 


592
593
594
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 592

def shuffle_service_path
  @shuffle_service_path
end

#temp_storage_prefix ⇒ String

The prefix of the resources the system 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) 


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

def temp_storage_prefix
  @temp_storage_prefix
end

#worker_id ⇒ String

The ID of the worker running this pipeline. Corresponds to the JSON property workerId

Returns:

  • (String) 


597
598
599
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 597

def worker_id
  @worker_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 631

def update!(**args)
  @service_path = args[:service_path] if args.key?(:service_path)
  @shuffle_service_path = args[:shuffle_service_path] if args.key?(:shuffle_service_path)
  @worker_id = args[:worker_id] if args.key?(:worker_id)
  @temp_storage_prefix = args[:temp_storage_prefix] if args.key?(:temp_storage_prefix)
  @base_url = args[:base_url] if args.key?(:base_url)
  @reporting_enabled = args[:reporting_enabled] if args.key?(:reporting_enabled)
end