Class FlexTemplateRuntimeEnvironment

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

Inheritance
object
FlexTemplateRuntimeEnvironment
Implements
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3.Data
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class FlexTemplateRuntimeEnvironment : IDirectResponseSchema

Properties

AdditionalExperiments

Additional experiment flags for the job.

Declaration
[JsonProperty("additionalExperiments")]
public virtual IList<string> AdditionalExperiments { get; set; }
Property Value
Type Description
IList<string>

AdditionalPipelineOptions

Optional. Additional pipeline option flags for the job.

Declaration
[JsonProperty("additionalPipelineOptions")]
public virtual IList<string> AdditionalPipelineOptions { get; set; }
Property Value
Type Description
IList<string>

AdditionalUserLabels

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

Declaration
[JsonProperty("additionalUserLabels")]
public virtual IDictionary<string, string> AdditionalUserLabels { get; set; }
Property Value
Type Description
IDictionary<string, string>

AutoscalingAlgorithm

The algorithm to use for autoscaling

Declaration
[JsonProperty("autoscalingAlgorithm")]
public virtual string AutoscalingAlgorithm { get; set; }
Property Value
Type Description
string

DiskSizeGb

Worker disk size, in gigabytes.

Declaration
[JsonProperty("diskSizeGb")]
public virtual int? DiskSizeGb { get; set; }
Property Value
Type Description
int?

DumpHeapOnOom

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.

Declaration
[JsonProperty("dumpHeapOnOom")]
public virtual bool? DumpHeapOnOom { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableLauncherVmSerialPortLogging

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

Declaration
[JsonProperty("enableLauncherVmSerialPortLogging")]
public virtual bool? EnableLauncherVmSerialPortLogging { get; set; }
Property Value
Type Description
bool?

EnableStreamingEngine

Whether to enable Streaming Engine for the job.

Declaration
[JsonProperty("enableStreamingEngine")]
public virtual bool? EnableStreamingEngine { get; set; }
Property Value
Type Description
bool?

FlexrsGoal

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

Declaration
[JsonProperty("flexrsGoal")]
public virtual string FlexrsGoal { get; set; }
Property Value
Type Description
string

IpConfiguration

Configuration for VM IPs.

Declaration
[JsonProperty("ipConfiguration")]
public virtual string IpConfiguration { get; set; }
Property Value
Type Description
string

KmsKeyName

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

Declaration
[JsonProperty("kmsKeyName")]
public virtual string KmsKeyName { get; set; }
Property Value
Type Description
string

LauncherMachineType

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

Declaration
[JsonProperty("launcherMachineType")]
public virtual string LauncherMachineType { get; set; }
Property Value
Type Description
string

MachineType

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

Declaration
[JsonProperty("machineType")]
public virtual string MachineType { get; set; }
Property Value
Type Description
string

MaxWorkers

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

Declaration
[JsonProperty("maxWorkers")]
public virtual int? MaxWorkers { get; set; }
Property Value
Type Description
int?

Network

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

Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
Type Description
string

NumWorkers

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

Declaration
[JsonProperty("numWorkers")]
public virtual int? NumWorkers { get; set; }
Property Value
Type Description
int?

SaveHeapDumpsToGcsPath

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

Declaration
[JsonProperty("saveHeapDumpsToGcsPath")]
public virtual string SaveHeapDumpsToGcsPath { get; set; }
Property Value
Type Description
string

SdkContainerImage

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.

Declaration
[JsonProperty("sdkContainerImage")]
public virtual string SdkContainerImage { get; set; }
Property Value
Type Description
string

ServiceAccountEmail

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

Declaration
[JsonProperty("serviceAccountEmail")]
public virtual string ServiceAccountEmail { get; set; }
Property Value
Type Description
string

StagingLocation

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

Declaration
[JsonProperty("stagingLocation")]
public virtual string StagingLocation { get; set; }
Property Value
Type Description
string

StreamingMode

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.

Declaration
[JsonProperty("streamingMode")]
public virtual string StreamingMode { get; set; }
Property Value
Type Description
string

Subnetwork

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.

Declaration
[JsonProperty("subnetwork")]
public virtual string Subnetwork { get; set; }
Property Value
Type Description
string

TempLocation

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

Declaration
[JsonProperty("tempLocation")]
public virtual string TempLocation { get; set; }
Property Value
Type Description
string

WorkerRegion

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.

Declaration
[JsonProperty("workerRegion")]
public virtual string WorkerRegion { get; set; }
Property Value
Type Description
string

WorkerZone

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.

Declaration
[JsonProperty("workerZone")]
public virtual string WorkerZone { get; set; }
Property Value
Type Description
string

Zone

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

Declaration
[JsonProperty("zone")]
public virtual string Zone { get; set; }
Property Value
Type Description
string

Implements