FlexTemplateRuntimeEnvironment

import type { FlexTemplateRuntimeEnvironment } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

The environment values to be set at runtime for flex template. LINT.IfChange

interface FlexTemplateRuntimeEnvironment {

additionalExperiments?: string[];

additionalUserLabels?: {

[key: string]: string;

};

autoscalingAlgorithm?: "AUTOSCALING_ALGORITHM_UNKNOWN" | "AUTOSCALING_ALGORITHM_NONE" | "AUTOSCALING_ALGORITHM_BASIC";

diskSizeGb?: number;

dumpHeapOnOom?: boolean;

enableLauncherVmSerialPortLogging?: boolean;

enableStreamingEngine?: boolean;

flexrsGoal?: "FLEXRS_UNSPECIFIED" | "FLEXRS_SPEED_OPTIMIZED" | "FLEXRS_COST_OPTIMIZED";

ipConfiguration?: "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE";

kmsKeyName?: string;

launcherMachineType?: string;

machineType?: string;

maxWorkers?: number;

network?: string;

numWorkers?: number;

saveHeapDumpsToGcsPath?: string;

sdkContainerImage?: string;

serviceAccountEmail?: string;

stagingLocation?: string;

streamingMode?: "STREAMING_MODE_UNSPECIFIED" | "STREAMING_MODE_EXACTLY_ONCE" | "STREAMING_MODE_AT_LEAST_ONCE";

subnetwork?: string;

tempLocation?: string;

workerRegion?: string;

workerZone?: string;

zone?: string;

}

§Properties

additionalExperiments?: string[]

[src]

Additional experiment flags for the job.

additionalUserLabels?: {

[key: string]: string;

}

[src]

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" }.

autoscalingAlgorithm?: "AUTOSCALING_ALGORITHM_UNKNOWN" | "AUTOSCALING_ALGORITHM_NONE" | "AUTOSCALING_ALGORITHM_BASIC"

[src]

The algorithm to use for autoscaling

diskSizeGb?: number

[src]

Worker disk size, in gigabytes.

dumpHeapOnOom?: boolean

[src]

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.

enableLauncherVmSerialPortLogging?: boolean

[src]

If true serial port logging will be enabled for the launcher VM.

enableStreamingEngine?: boolean

[src]

Whether to enable Streaming Engine for the job.

flexrsGoal?: "FLEXRS_UNSPECIFIED" | "FLEXRS_SPEED_OPTIMIZED" | "FLEXRS_COST_OPTIMIZED"

[src]

Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs

ipConfiguration?: "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE"

[src]

Configuration for VM IPs.

kmsKeyName?: string

[src]

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

launcherMachineType?: string

[src]

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

machineType?: string

[src]

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

maxWorkers?: number

[src]

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

network?: string

[src]

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

numWorkers?: number

[src]

The initial number of Google Compute Engine instances for the job.

saveHeapDumpsToGcsPath?: string

[src]

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

sdkContainerImage?: string

[src]

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.

serviceAccountEmail?: string

[src]

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

stagingLocation?: string

[src]

The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.

streamingMode?: "STREAMING_MODE_UNSPECIFIED" | "STREAMING_MODE_EXACTLY_ONCE" | "STREAMING_MODE_AT_LEAST_ONCE"

[src]

Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see Set the pipeline streaming mode.

subnetwork?: string

[src]

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.

tempLocation?: string

[src]

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

workerRegion?: string

[src]

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.

workerZone?: string

[src]

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.

zone?: string

[src]

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