Dataflow v1beta3 API - Class RuntimeEnvironment (2.0.0-beta06)

public sealed class RuntimeEnvironment : IMessage<RuntimeEnvironment>, IEquatable<RuntimeEnvironment>, IDeepCloneable<RuntimeEnvironment>, IBufferMessage, IMessage

Reference documentation and code samples for the Dataflow v1beta3 API class RuntimeEnvironment.

The environment values to set at runtime.

Inheritance

object > RuntimeEnvironment

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

RuntimeEnvironment()

public RuntimeEnvironment()

RuntimeEnvironment(RuntimeEnvironment)

public RuntimeEnvironment(RuntimeEnvironment other)
Parameter
Name Description
other RuntimeEnvironment

Properties

AdditionalExperiments

public RepeatedField<string> AdditionalExperiments { get; }

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

Property Value
Type Description
RepeatedFieldstring

AdditionalUserLabels

public MapField<string, string> AdditionalUserLabels { get; }

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

Property Value
Type Description
MapFieldstringstring

BypassTempDirValidation

public bool BypassTempDirValidation { get; set; }

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

Property Value
Type Description
bool

EnableStreamingEngine

public bool EnableStreamingEngine { get; set; }

Whether to enable Streaming Engine for the job.

Property Value
Type Description
bool

IpConfiguration

public WorkerIPAddressConfiguration IpConfiguration { get; set; }

Configuration for VM IPs.

Property Value
Type Description
WorkerIPAddressConfiguration

KmsKeyName

public string KmsKeyName { get; set; }

Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>

Property Value
Type Description
string

MachineType

public string MachineType { get; set; }

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

Property Value
Type Description
string

MaxWorkers

public int MaxWorkers { get; set; }

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

Property Value
Type Description
int

Network

public string Network { get; set; }

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

Property Value
Type Description
string

NumWorkers

public int NumWorkers { get; set; }

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

Property Value
Type Description
int

ServiceAccountEmail

public string ServiceAccountEmail { get; set; }

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

Property Value
Type Description
string

Subnetwork

public string Subnetwork { get; set; }

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.

Property Value
Type Description
string

TempLocation

public string TempLocation { get; set; }

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

Property Value
Type Description
string

WorkerRegion

public string WorkerRegion { get; set; }

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.

Property Value
Type Description
string

WorkerZone

public string WorkerZone { get; set; }

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.

Property Value
Type Description
string

Zone

public string Zone { get; set; }

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

Property Value
Type Description
string