PipelineWorkloadDataflowFlexTemplateRequestLaunchParameterEnvironment

data class PipelineWorkloadDataflowFlexTemplateRequestLaunchParameterEnvironment(val additionalExperiments: List<String>? = null, val additionalUserLabels: Map<String, String>? = null, val enableStreamingEngine: Boolean? = null, val flexrsGoal: String? = null, val ipConfiguration: String? = null, val kmsKeyName: String? = null, val machineType: String? = null, val maxWorkers: Int? = null, val network: String? = null, val numWorkers: Int? = null, val serviceAccountEmail: String? = null, val subnetwork: String? = null, val tempLocation: String? = null, val workerRegion: String? = null, val workerZone: String? = null, val zone: String? = null)

Constructors

constructor(additionalExperiments: List<String>? = null, additionalUserLabels: Map<String, String>? = null, enableStreamingEngine: Boolean? = null, flexrsGoal: String? = null, ipConfiguration: String? = null, kmsKeyName: String? = null, machineType: String? = null, maxWorkers: Int? = null, network: String? = null, numWorkers: Int? = null, serviceAccountEmail: String? = null, subnetwork: String? = null, tempLocation: String? = null, workerRegion: String? = null, workerZone: String? = null, zone: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Additional experiment flags for the job.

Link copied to clipboard

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" }.' 'An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'

Link copied to clipboard

Whether to enable Streaming Engine for the job.

Link copied to clipboard
val flexrsGoal: String? = null

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs https://cloud.google.com/dataflow/docs/reference/data-pipelines/rest/v1/projects.locations.pipelines#FlexResourceSchedulingGoal Possible values are: FLEXRS_UNSPECIFIED, FLEXRS_SPEED_OPTIMIZED, FLEXRS_COST_OPTIMIZED.

Link copied to clipboard
val ipConfiguration: String? = null

Configuration for VM IPs. https://cloud.google.com/dataflow/docs/reference/data-pipelines/rest/v1/projects.locations.pipelines#WorkerIPAddressConfiguration Possible values are: WORKER_IP_UNSPECIFIED, WORKER_IP_PUBLIC, WORKER_IP_PRIVATE.

Link copied to clipboard
val kmsKeyName: String? = null

'Name for the Cloud KMS key for the job. The key format is: projects//locations//keyRings//cryptoKeys/'

Link copied to clipboard
val machineType: String? = null

The machine type to use for the job. Defaults to the value from the template if not specified.

Link copied to clipboard
val maxWorkers: Int? = null

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

Link copied to clipboard
val network: String? = null

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Link copied to clipboard
val numWorkers: Int? = null

The initial number of Compute Engine instances for the job.

Link copied to clipboard

The email address of the service account to run the job as.

Link copied to clipboard
val subnetwork: String? = null

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.

Link copied to clipboard
val tempLocation: String? = null

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Link copied to clipboard
val workerRegion: String? = null

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 workerZone. If neither workerRegion nor workerZone is specified, default to the control plane's region.

Link copied to clipboard
val workerZone: String? = null

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 workerRegion. If neither workerRegion nor workerZone is specified, a zone in the control plane's region is chosen based on available capacity. If both workerZone and zone are set, workerZone takes precedence.

Link copied to clipboard
val zone: String? = null

The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, workerZone will take precedence.