EnvironmentArgs

data class EnvironmentArgs(val clusterManagerApiService: Output<String>? = null, val dataset: Output<String>? = null, val debugOptions: Output<DebugOptionsArgs>? = null, val experiments: Output<List<String>>? = null, val flexResourceSchedulingGoal: Output<EnvironmentFlexResourceSchedulingGoal>? = null, val internalExperiments: Output<Map<String, String>>? = null, val sdkPipelineOptions: Output<Map<String, String>>? = null, val serviceAccountEmail: Output<String>? = null, val serviceKmsKeyName: Output<String>? = null, val serviceOptions: Output<List<String>>? = null, val tempStoragePrefix: Output<String>? = null, val userAgent: Output<Map<String, String>>? = null, val version: Output<Map<String, String>>? = null, val workerPools: Output<List<WorkerPoolArgs>>? = null, val workerRegion: Output<String>? = null, val workerZone: Output<String>? = null) : ConvertibleToJava<EnvironmentArgs>

Describes the environment in which a Dataflow Job runs.

Constructors

Link copied to clipboard
fun EnvironmentArgs(clusterManagerApiService: Output<String>? = null, dataset: Output<String>? = null, debugOptions: Output<DebugOptionsArgs>? = null, experiments: Output<List<String>>? = null, flexResourceSchedulingGoal: Output<EnvironmentFlexResourceSchedulingGoal>? = null, internalExperiments: Output<Map<String, String>>? = null, sdkPipelineOptions: Output<Map<String, String>>? = null, serviceAccountEmail: Output<String>? = null, serviceKmsKeyName: Output<String>? = null, serviceOptions: Output<List<String>>? = null, tempStoragePrefix: Output<String>? = null, userAgent: Output<Map<String, String>>? = null, version: Output<Map<String, String>>? = null, workerPools: Output<List<WorkerPoolArgs>>? = null, workerRegion: Output<String>? = null, workerZone: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): EnvironmentArgs

Properties

Link copied to clipboard
val clusterManagerApiService: Output<String>? = null

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".

Link copied to clipboard
val dataset: Output<String>? = null

The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

Link copied to clipboard
val debugOptions: Output<DebugOptionsArgs>? = null

Any debugging options to be supplied to the job.

Link copied to clipboard
val experiments: Output<List<String>>? = null

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

Link copied to clipboard

Which Flexible Resource Scheduling mode to run in.

Link copied to clipboard
val internalExperiments: Output<Map<String, String>>? = null

Experimental settings.

Link copied to clipboard
val sdkPipelineOptions: Output<Map<String, String>>? = null

The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.

Link copied to clipboard
val serviceAccountEmail: Output<String>? = null

Identity to run virtual machines as. Defaults to the default account.

Link copied to clipboard
val serviceKmsKeyName: Output<String>? = null

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

Link copied to clipboard
val serviceOptions: Output<List<String>>? = null

The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on).

Link copied to clipboard
val tempStoragePrefix: Output<String>? = null

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Link copied to clipboard
val userAgent: Output<Map<String, String>>? = null

A description of the process that generated the request.

Link copied to clipboard
val version: Output<Map<String, String>>? = null

A structure describing which components and their versions of the service are required in order to run the job.

Link copied to clipboard
val workerPools: Output<List<WorkerPoolArgs>>? = null

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

Link copied to clipboard
val workerRegion: Output<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 worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

Link copied to clipboard
val workerZone: Output<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 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.