Class RuntimeEnvironment

The environment values to set at runtime.

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

Properties

AdditionalExperiments

Optional. Additional experiment flags for the job, specified with the --experiments option.

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

AdditionalUserLabels

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

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

BypassTempDirValidation

Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

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

DiskSizeGb

Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

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

ETag

The ETag of the item.

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

EnableStreamingEngine

Optional. Whether to enable Streaming Engine for the job.

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

IpConfiguration

Optional. Configuration for VM IPs.

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

KmsKeyName

Optional. 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

MachineType

Optional. 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

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

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

Network

Optional. 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

Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

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

ServiceAccountEmail

Optional. 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

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

Optional. 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

Required. 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

Required. 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

Optional. 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

Optional. 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