Class: Google::Apis::DataflowV1b3::RuntimeEnvironment
- Inherits:
-
Object
- Object
- Google::Apis::DataflowV1b3::RuntimeEnvironment
- 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
-
#additional_experiments ⇒ Array<String>
Additional experiment flags for the job.
-
#additional_user_labels ⇒ Hash<String,String>
Additional user labels to be specified for the job.
-
#bypass_temp_dir_validation ⇒ Boolean
(also: #bypass_temp_dir_validation?)
Whether to bypass the safety checks for the job's temporary directory.
-
#ip_configuration ⇒ String
Configuration for VM IPs.
-
#kms_key_name ⇒ String
Optional.
-
#machine_type ⇒ String
The machine type to use for the job.
-
#max_workers ⇒ Fixnum
The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
-
#network ⇒ String
Network to which VMs will be assigned.
-
#num_workers ⇒ Fixnum
The initial number of Google Compute Engine instnaces for the job.
-
#service_account_email ⇒ String
The email address of the service account to run the job as.
-
#subnetwork ⇒ String
Subnetwork to which VMs will be assigned, if desired.
-
#temp_location ⇒ String
The Cloud Storage path to use for temporary files.
-
#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.
-
#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.
-
#zone ⇒ String
The Compute Engine availability zone for launching worker instances to run your pipeline.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RuntimeEnvironment
constructor
A new instance of RuntimeEnvironment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ RuntimeEnvironment
Returns a new instance of RuntimeEnvironment.
3552 3553 3554 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3552 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
3455 3456 3457 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3455 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
3464 3465 3466 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3464 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
3470 3471 3472 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3470 def bypass_temp_dir_validation @bypass_temp_dir_validation end |
#ip_configuration ⇒ String
Configuration for VM IPs.
Corresponds to the JSON property ipConfiguration
3476 3477 3478 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3476 def ip_configuration @ip_configuration end |
#kms_key_name ⇒ String
Optional. Name for the Cloud KMS key for the job.
Key format is:
projects/kmsKeyName
3483 3484 3485 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3483 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
3489 3490 3491 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3489 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
3495 3496 3497 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3495 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
3501 3502 3503 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3501 def network @network end |
#num_workers ⇒ Fixnum
The initial number of Google Compute Engine instnaces for the job.
Corresponds to the JSON property numWorkers
3506 3507 3508 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3506 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
3511 3512 3513 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3511 def service_account_email @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
3517 3518 3519 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3517 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
3523 3524 3525 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3523 def temp_location @temp_location 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
3532 3533 3534 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3532 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
3542 3543 3544 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3542 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
3550 3551 3552 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3550 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3557 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) @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) @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 |