Class: Google::Apis::DataflowV1b3::FlexTemplateRuntimeEnvironment

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 be set at runtime for flex template.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FlexTemplateRuntimeEnvironment

Returns a new instance of FlexTemplateRuntimeEnvironment.



1722
1723
1724
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1722

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


1568
1569
1570
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1568

def additional_experiments
  @additional_experiments
end

#additional_user_labels ⇒ Hash<String,String>

Additional user labels to be specified for the job. Keys and values must 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>) 


1577
1578
1579
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1577

def additional_user_labels
  @additional_user_labels
end

#autoscaling_algorithm ⇒ String

The algorithm to use for autoscaling Corresponds to the JSON property autoscalingAlgorithm

Returns:

  • (String) 


1582
1583
1584
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1582

def autoscaling_algorithm
  @autoscaling_algorithm
end

#disk_size_gb ⇒ Fixnum

Worker disk size, in gigabytes. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


1587
1588
1589
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1587

def disk_size_gb
  @disk_size_gb
end

#dump_heap_on_oom ⇒ Boolean Also known as: dump_heap_on_oom?

If true, when processing time is spent almost entirely on garbage collection ( GC), saves a heap dump before ending the thread or process. If false, ends the thread or process without saving a heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory error during processing. The location of the heap file is either echoed back to the user, or the user is given the opportunity to download the heap file. Corresponds to the JSON property dumpHeapOnOom

Returns:

  • (Boolean) 


1597
1598
1599
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1597

def dump_heap_on_oom
  @dump_heap_on_oom
end

#enable_launcher_vm_serial_port_logging ⇒ Boolean Also known as: enable_launcher_vm_serial_port_logging?

If true serial port logging will be enabled for the launcher VM. Corresponds to the JSON property enableLauncherVmSerialPortLogging

Returns:

  • (Boolean) 


1603
1604
1605
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1603

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


1609
1610
1611
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1609

def enable_streaming_engine
  @enable_streaming_engine
end

#flexrs_goal ⇒ String

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/ flexrs Corresponds to the JSON property flexrsGoal

Returns:

  • (String) 


1616
1617
1618
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1616

def flexrs_goal
  @flexrs_goal
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


1621
1622
1623
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1621

def ip_configuration
  @ip_configuration
end

#kms_key_name ⇒ String

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

Returns:

  • (String) 


1627
1628
1629
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1627

def kms_key_name
  @kms_key_name
end

#launcher_machine_type ⇒ String

The machine type to use for launching the job. The default is n1-standard-1. Corresponds to the JSON property launcherMachineType

Returns:

  • (String) 


1632
1633
1634
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1632

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


1638
1639
1640
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1638

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) 


1644
1645
1646
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1644

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) 


1650
1651
1652
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1650

def network
  @network
end

#num_workers ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1655
1656
1657
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1655

def num_workers
  @num_workers
end

#save_heap_dumps_to_gcs_path ⇒ String

Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that dump_heap_on_oom is set to true. Corresponds to the JSON property saveHeapDumpsToGcsPath

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1661

def save_heap_dumps_to_gcs_path
  @save_heap_dumps_to_gcs_path
end

#sdk_container_image ⇒ String

Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines. Corresponds to the JSON property sdkContainerImage

Returns:

  • (String) 


1668
1669
1670
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1668

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


1673
1674
1675
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1673

def 
  @service_account_email
end

#staging_location ⇒ String

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://. Corresponds to the JSON property stagingLocation

Returns:

  • (String) 


1679
1680
1681
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1679

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


1689
1690
1691
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1689

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) 


1695
1696
1697
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1695

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) 


1703
1704
1705
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1703

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) 


1713
1714
1715
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1713

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) 


1720
1721
1722
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1720

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1727

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)
  @autoscaling_algorithm = args[:autoscaling_algorithm] if args.key?(:autoscaling_algorithm)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @dump_heap_on_oom = args[:dump_heap_on_oom] if args.key?(:dump_heap_on_oom)
  @enable_launcher_vm_serial_port_logging = args[:enable_launcher_vm_serial_port_logging] if args.key?(:enable_launcher_vm_serial_port_logging)
  @enable_streaming_engine = args[:enable_streaming_engine] if args.key?(:enable_streaming_engine)
  @flexrs_goal = args[:flexrs_goal] if args.key?(:flexrs_goal)
  @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @launcher_machine_type = args[:launcher_machine_type] if args.key?(:launcher_machine_type)
  @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)
  @save_heap_dumps_to_gcs_path = args[:save_heap_dumps_to_gcs_path] if args.key?(:save_heap_dumps_to_gcs_path)
  @sdk_container_image = args[:sdk_container_image] if args.key?(:sdk_container_image)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @staging_location = args[:staging_location] if args.key?(:staging_location)
  @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