public sealed class RuntimeEnvironment : IMessage<RuntimeEnvironment>, IEquatable<RuntimeEnvironment>, IDeepCloneable<RuntimeEnvironment>, IBufferMessage, IMessageReference documentation and code samples for the Dataflow v1beta3 API class RuntimeEnvironment.
The environment values to set at runtime.
Implements
IMessageRuntimeEnvironment, IEquatableRuntimeEnvironment, IDeepCloneableRuntimeEnvironment, IBufferMessage, IMessageNamespace
Google.Cloud.Dataflow.V1Beta3Assembly
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; }Optional. Additional experiment flags for the job, specified with the
--experiments option.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
AdditionalUserLabels
public MapField<string, string> AdditionalUserLabels { get; }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" }.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
BypassTempDirValidation
public bool BypassTempDirValidation { get; set; }Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DiskSizeGb
public int DiskSizeGb { get; set; }Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
| Property Value | |
|---|---|
| Type | Description |
int |
|
EnableStreamingEngine
public bool EnableStreamingEngine { get; set; }Optional. Whether to enable Streaming Engine for the job.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasStreamingMode
public bool HasStreamingMode { get; }Gets whether the "streaming_mode" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IpConfiguration
public WorkerIPAddressConfiguration IpConfiguration { get; set; }Optional. Configuration for VM IPs.
| Property Value | |
|---|---|
| Type | Description |
WorkerIPAddressConfiguration |
|
KmsKeyName
public string KmsKeyName { get; set; }Optional. 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; }Optional. 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; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
Network
public string Network { get; set; }Optional. 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; }Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
| Property Value | |
|---|---|
| Type | Description |
int |
|
ServiceAccountEmail
public string ServiceAccountEmail { get; set; }Optional. The email address of the service account to run the job as.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StreamingMode
public StreamingMode StreamingMode { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
StreamingMode |
|
Subnetwork
public string Subnetwork { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TempLocation
public string TempLocation { get; set; }Required. 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; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
WorkerZone
public string WorkerZone { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Zone
public string Zone { get; set; }Optional. 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 |
|