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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataflow_v1b3/classes.rb,
lib/google/apis/dataflow_v1b3/representations.rb,
lib/google/apis/dataflow_v1b3/representations.rb

Overview

The environment values to set at runtime.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RuntimeEnvironment

Returns a new instance of RuntimeEnvironment.



4562
4563
4564
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4562

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

Instance Attribute Details

#additional_experiments ⇒ Array<String>

Optional. Additional experiment flags for the job, specified with the -- experiments option. Corresponds to the JSON property additionalExperiments

Returns:

  • (Array<String>) 


4440
4441
4442
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4440

def additional_experiments
  @additional_experiments
end

#additional_user_labels ⇒ Hash<String,String>

Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: "name": "wrench", " mass": "1kg", "count": "3". Corresponds to the JSON property additionalUserLabels

Returns:

  • (Hash<String,String>) 


4449
4450
4451
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4449

def additional_user_labels
  @additional_user_labels
end

#bypass_temp_dir_validation ⇒ Boolean Also known as: bypass_temp_dir_validation?

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

Returns:

  • (Boolean) 


4455
4456
4457
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4455

def bypass_temp_dir_validation
  @bypass_temp_dir_validation
end

#disk_size_gb ⇒ Fixnum

Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


4462
4463
4464
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4462

def disk_size_gb
  @disk_size_gb
end

#enable_streaming_engine ⇒ Boolean Also known as: enable_streaming_engine?

Optional. Whether to enable Streaming Engine for the job. Corresponds to the JSON property enableStreamingEngine

Returns:

  • (Boolean) 


4467
4468
4469
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4467

def enable_streaming_engine
  @enable_streaming_engine
end

#ip_configuration ⇒ String

Optional. Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


4473
4474
4475
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4473

def ip_configuration
  @ip_configuration
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) 


4479
4480
4481
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4479

def kms_key_name
  @kms_key_name
end

#machine_type ⇒ String

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


4485
4486
4487
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4485

def machine_type
  @machine_type
end

#max_workers ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4492
4493
4494
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4492

def max_workers
  @max_workers
end

#network ⇒ String

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


4498
4499
4500
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4498

def network
  @network
end

#num_workers ⇒ Fixnum

Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. Corresponds to the JSON property numWorkers

Returns:

  • (Fixnum) 


4504
4505
4506
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4504

def num_workers
  @num_workers
end

#service_account_email ⇒ String

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

Returns:

  • (String) 


4509
4510
4511
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4509

def 
  @service_account_email
end

#streaming_mode ⇒ String

Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see Set the pipeline streaming mode. Corresponds to the JSON property streamingMode

Returns:

  • (String) 


4519
4520
4521
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4519

def streaming_mode
  @streaming_mode
end

#subnetwork ⇒ String

Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/ HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/ subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


4529
4530
4531
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4529

def subnetwork
  @subnetwork
end

#temp_location ⇒ String

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


4535
4536
4537
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4535

def temp_location
  @temp_location
end

#worker_region ⇒ String

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


4543
4544
4545
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4543

def worker_region
  @worker_region
end

#worker_zone ⇒ String

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


4553
4554
4555
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4553

def worker_zone
  @worker_zone
end

#zone ⇒ String

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


4560
4561
4562
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4560

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4567

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)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @enable_streaming_engine = args[:enable_streaming_engine] if args.key?(:enable_streaming_engine)
  @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration)
  @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)
  @streaming_mode = args[:streaming_mode] if args.key?(:streaming_mode)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @temp_location = args[:temp_location] if args.key?(:temp_location)
  @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