Class: Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1RuntimeEnvironment

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

Overview

The environment values to set at runtime.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatapipelinesV1RuntimeEnvironment

Returns a new instance of GoogleCloudDatapipelinesV1RuntimeEnvironment.



713
714
715
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 713

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


609
610
611
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 609

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


618
619
620
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 618

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) 


624
625
626
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 624

def bypass_temp_dir_validation
  @bypass_temp_dir_validation
end

#enable_streaming_engine ⇒ Boolean Also known as: enable_streaming_engine?

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

Returns:

  • (Boolean) 


630
631
632
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 630

def enable_streaming_engine
  @enable_streaming_engine
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


636
637
638
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 636

def ip_configuration
  @ip_configuration
end

#kms_key_name ⇒ String

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

Returns:

  • (String) 


642
643
644
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 642

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) 


648
649
650
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 648

def machine_type
  @machine_type
end

#max_workers ⇒ Fixnum

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

Returns:

  • (Fixnum) 


654
655
656
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 654

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) 


660
661
662
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 660

def network
  @network
end

#num_workers ⇒ Fixnum

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

Returns:

  • (Fixnum) 


665
666
667
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 665

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) 


670
671
672
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 670

def 
  @service_account_email
end

#subnetwork ⇒ String

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) 


680
681
682
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 680

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) 


686
687
688
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 686

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

Returns:

  • (String) 


694
695
696
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 694

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) 


704
705
706
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 704

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) 


711
712
713
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 711

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 718

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