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.



1580
1581
1582
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1580

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


1454
1455
1456
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1454

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


1463
1464
1465
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1463

def additional_user_labels
  @additional_user_labels
end

#disk_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1468
1469
1470
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1468

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


1473
1474
1475
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1473

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) 


1480
1481
1482
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1480

def flexrs_goal
  @flexrs_goal
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


1485
1486
1487
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1485

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) 


1491
1492
1493
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1491

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) 


1497
1498
1499
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1497

def machine_type
  @machine_type
end

#max_num_workers ⇒ Fixnum

The maximum number of workers to cap scaling at. Corresponds to the JSON property maxNumWorkers

Returns:

  • (Fixnum) 


1502
1503
1504
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1502

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


1508
1509
1510
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1508

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) 


1514
1515
1516
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1514

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) 


1519
1520
1521
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1519

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


1526
1527
1528
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1526

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) 


1531
1532
1533
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1531

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) 


1537
1538
1539
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1537

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) 


1547
1548
1549
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1547

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) 


1553
1554
1555
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1553

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) 


1561
1562
1563
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1561

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) 


1571
1572
1573
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1571

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) 


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

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1585

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)
  @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)
  @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)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @max_num_workers = args[:max_num_workers] if args.key?(:max_num_workers)
  @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)
  @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