Class: Google::Apis::DataflowV1b3::Environment

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

Describes the environment in which a Dataflow Job runs.

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

Returns a new instance of Environment.



329
330
331
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 329

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

Instance Attribute Details

#cluster_manager_api_service ⇒ String

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com". Corresponds to the JSON property clusterManagerApiService

Returns:

  • (String) 


281
282
283
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 281

def cluster_manager_api_service
  @cluster_manager_api_service
end

#dataset ⇒ String

The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis. com/dataset Corresponds to the JSON property dataset

Returns:

  • (String) 


310
311
312
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 310

def dataset
  @dataset
end

#experiments ⇒ Array<String>

The list of experiments to enable. Corresponds to the JSON property experiments

Returns:

  • (Array<String>) 


286
287
288
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 286

def experiments
  @experiments
end

#internal_experiments ⇒ Hash<String,Object>

Experimental settings. Corresponds to the JSON property internalExperiments

Returns:

  • (Hash<String,Object>) 


322
323
324
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 322

def internal_experiments
  @internal_experiments
end

#sdk_pipeline_options ⇒ Hash<String,Object>

The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. Corresponds to the JSON property sdkPipelineOptions

Returns:

  • (Hash<String,Object>) 


317
318
319
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 317

def sdk_pipeline_options
  @sdk_pipeline_options
end

#service_account_email ⇒ String

Identity to run virtual machines as. Defaults to the default account. Corresponds to the JSON property serviceAccountEmail

Returns:

  • (String) 


327
328
329
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 327

def 
  @service_account_email
end

#temp_storage_prefix ⇒ String

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-JOBNAME to this resource prefix, where JOBNAME is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. 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) 


274
275
276
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 274

def temp_storage_prefix
  @temp_storage_prefix
end

#user_agent ⇒ Hash<String,Object>

A description of the process that generated the request. Corresponds to the JSON property userAgent

Returns:

  • (Hash<String,Object>) 


297
298
299
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 297

def user_agent
  @user_agent
end

#version ⇒ Hash<String,Object>

A structure describing which components and their versions of the service are required in order to run the job. Corresponds to the JSON property version

Returns:

  • (Hash<String,Object>) 


303
304
305
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 303

def version
  @version
end

#worker_pools ⇒ Array<Google::Apis::DataflowV1b3::WorkerPool>

Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. Corresponds to the JSON property workerPools

Returns:



292
293
294
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 292

def worker_pools
  @worker_pools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 334

def update!(**args)
  @temp_storage_prefix = args[:temp_storage_prefix] if args.key?(:temp_storage_prefix)
  @cluster_manager_api_service = args[:cluster_manager_api_service] if args.key?(:cluster_manager_api_service)
  @experiments = args[:experiments] if args.key?(:experiments)
  @worker_pools = args[:worker_pools] if args.key?(:worker_pools)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
  @version = args[:version] if args.key?(:version)
  @dataset = args[:dataset] if args.key?(:dataset)
  @sdk_pipeline_options = args[:sdk_pipeline_options] if args.key?(:sdk_pipeline_options)
  @internal_experiments = args[:internal_experiments] if args.key?(:internal_experiments)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
end