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.



1566
1567
1568
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1566

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


1457
1458
1459
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1457

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


1466
1467
1468
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1466

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


1471
1472
1473
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1471

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) 


1478
1479
1480
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1478

def flexrs_goal
  @flexrs_goal
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


1483
1484
1485
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1483

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) 


1489
1490
1491
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1489

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) 


1495
1496
1497
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1495

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) 


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

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) 


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

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) 


1512
1513
1514
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1512

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) 


1517
1518
1519
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1517

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) 


1523
1524
1525
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1523

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) 


1533
1534
1535
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1533

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) 


1539
1540
1541
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1539

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) 


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

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) 


1557
1558
1559
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1557

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) 


1564
1565
1566
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1564

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 1571

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