Class: Google::Apis::DataflowV1b3::RuntimeEnvironment

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

The environment values to set at runtime.

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

Returns a new instance of RuntimeEnvironment



3418
3419
3420
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3418

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

Instance Attribute Details

#additional_experiments ⇒ Array<String>

Additional experiment flags for the job. Corresponds to the JSON property additionalExperiments

Returns:

  • (Array<String>) 


3318
3319
3320
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3318

def additional_experiments
  @additional_experiments
end

#additional_user_labels ⇒ Hash<String,String>

Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. Corresponds to the JSON property additionalUserLabels

Returns:

  • (Hash<String,String>) 


3327
3328
3329
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3327

def additional_user_labels
  @additional_user_labels
end

#bypass_temp_dir_validation ⇒ Boolean Also known as: bypass_temp_dir_validation?

Whether to bypass the safety checks for the job's temporary directory. Use with caution. Corresponds to the JSON property bypassTempDirValidation

Returns:

  • (Boolean) 


3333
3334
3335
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3333

def bypass_temp_dir_validation
  @bypass_temp_dir_validation
end

#kms_key_name ⇒ String

Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


3341
3342
3343
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3341

def kms_key_name
  @kms_key_name
end

#machine_type ⇒ String

The machine type to use for the job. Defaults to the value from the template if not specified. Corresponds to the JSON property machineType

Returns:

  • (String) 


3347
3348
3349
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3347

def machine_type
  @machine_type
end

#max_workers ⇒ Fixnum

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. Corresponds to the JSON property maxWorkers

Returns:

  • (Fixnum) 


3353
3354
3355
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3353

def max_workers
  @max_workers
end

#network ⇒ String

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". Corresponds to the JSON property network

Returns:

  • (String) 


3359
3360
3361
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3359

def network
  @network
end

#num_workers ⇒ Fixnum

The initial number of Google Compute Engine instnaces for the job. Corresponds to the JSON property numWorkers

Returns:

  • (Fixnum) 


3364
3365
3366
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3364

def num_workers
  @num_workers
end

#service_account_email ⇒ String

The email address of the service account to run the job as. Corresponds to the JSON property serviceAccountEmail

Returns:

  • (String) 


3369
3370
3371
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3369

def 
  @service_account_email
end

#subnetwork ⇒ String

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". Corresponds to the JSON property subnetwork

Returns:

  • (String) 


3375
3376
3377
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3375

def subnetwork
  @subnetwork
end

#temp_location ⇒ String

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://. Corresponds to the JSON property tempLocation

Returns:

  • (String) 


3381
3382
3383
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3381

def temp_location
  @temp_location
end

#use_private_ips ⇒ Boolean Also known as: use_private_ips?

Optional. Specifies whether worker pools should be started with private IP addresses. False by default. Corresponds to the JSON property usePrivateIps

Returns:

  • (Boolean) 


3388
3389
3390
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3388

def use_private_ips
  @use_private_ips
end

#worker_region ⇒ String

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. Corresponds to the JSON property workerRegion

Returns:

  • (String) 


3398
3399
3400
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3398

def worker_region
  @worker_region
end

#worker_zone ⇒ String

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence. Corresponds to the JSON property workerZone

Returns:

  • (String) 


3408
3409
3410
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3408

def worker_zone
  @worker_zone
end

#zone ⇒ String

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. Corresponds to the JSON property zone

Returns:

  • (String) 


3416
3417
3418
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3416

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3423

def update!(**args)
  @additional_experiments = args[:additional_experiments] if args.key?(:additional_experiments)
  @additional_user_labels = args[:additional_user_labels] if args.key?(:additional_user_labels)
  @bypass_temp_dir_validation = args[:bypass_temp_dir_validation] if args.key?(:bypass_temp_dir_validation)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @max_workers = args[:max_workers] if args.key?(:max_workers)
  @network = args[:network] if args.key?(:network)
  @num_workers = args[:num_workers] if args.key?(:num_workers)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @temp_location = args[:temp_location] if args.key?(:temp_location)
  @use_private_ips = args[:use_private_ips] if args.key?(:use_private_ips)
  @worker_region = args[:worker_region] if args.key?(:worker_region)
  @worker_zone = args[:worker_zone] if args.key?(:worker_zone)
  @zone = args[:zone] if args.key?(:zone)
end