# Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment (v0.17.0)

0.17.0 (latest) 0.16.0 0.15.0 0.14.1 0.13.1 0.12.1 0.11.0 0.10.0 0.9.1 0.8.2 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.4 Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::RuntimeEnvironment.

The environment values to set at runtime.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #additional_experiments

    def additional_experiments() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Optional. Additional experiment flags for the job, specified with the `--experiments` option.

### #additional_experiments=

    def additional_experiments=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Optional. Additional experiment flags for the job, specified with the `--experiments` option.
**Returns**

- (::Array\<::String\>) --- Optional. Additional experiment flags for the job, specified with the `--experiments` option.

### #additional_pipeline_options

    def additional_pipeline_options() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Optional. Additional pipeline option flags for the job.

### #additional_pipeline_options=

    def additional_pipeline_options=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Optional. Additional pipeline option flags for the job.
**Returns**

- (::Array\<::String\>) --- Optional. Additional pipeline option flags for the job.

### #additional_user_labels

    def additional_user_labels() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
  restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

### #additional_user_labels=

    def additional_user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
  restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
  restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

### #bypass_temp_dir_validation

    def bypass_temp_dir_validation() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

### #bypass_temp_dir_validation=

    def bypass_temp_dir_validation=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
**Returns**

- (::Boolean) --- Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

### #disk_size_gb

    def disk_size_gb() -> ::Integer

**Returns**

- (::Integer) --- Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

### #disk_size_gb=

    def disk_size_gb=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
**Returns**

- (::Integer) --- Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

### #enable_streaming_engine

    def enable_streaming_engine() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. Whether to enable Streaming Engine for the job.

### #enable_streaming_engine=

    def enable_streaming_engine=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. Whether to enable Streaming Engine for the job.
**Returns**

- (::Boolean) --- Optional. Whether to enable Streaming Engine for the job.

### #ip_configuration

    def ip_configuration() -> ::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration

**Returns**

- ([::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-WorkerIPAddressConfiguration)) --- Optional. Configuration for VM IPs.

### #ip_configuration=

    def ip_configuration=(value) -> ::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration

**Parameter**

- **value** ([::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-WorkerIPAddressConfiguration)) --- Optional. Configuration for VM IPs.
**Returns**

- ([::Google::Cloud::Dataflow::V1beta3::WorkerIPAddressConfiguration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-WorkerIPAddressConfiguration)) --- Optional. Configuration for VM IPs.

### #kms_key_name

    def kms_key_name() -> ::String

**Returns**

- (::String) --- Optional. Name for the Cloud KMS key for the job. Key format is: projects/

### #kms_key_name=

    def kms_key_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Name for the Cloud KMS key for the job. Key format is: projects/
**Returns**

- (::String) --- Optional. Name for the Cloud KMS key for the job. Key format is: projects/

### #machine_type

    def machine_type() -> ::String

**Returns**

- (::String) --- Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

### #machine_type=

    def machine_type=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
**Returns**

- (::String) --- Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

### #max_workers

    def max_workers() -> ::Integer

**Returns**

- (::Integer) --- 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.

### #max_workers=

    def max_workers=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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.
**Returns**

- (::Integer) --- 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.

### #network

    def network() -> ::String

**Returns**

- (::String) --- Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

### #network=

    def network=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
**Returns**

- (::String) --- Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

### #num_workers

    def num_workers() -> ::Integer

**Returns**

- (::Integer) --- Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

### #num_workers=

    def num_workers=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
**Returns**

- (::Integer) --- Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

### #service_account_email

    def service_account_email() -> ::String

**Returns**

- (::String) --- Optional. The email address of the service account to run the job as.

### #service_account_email=

    def service_account_email=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The email address of the service account to run the job as.
**Returns**

- (::String) --- Optional. The email address of the service account to run the job as.

### #streaming_mode

    def streaming_mode() -> ::Google::Cloud::Dataflow::V1beta3::StreamingMode

**Returns**

- ([::Google::Cloud::Dataflow::V1beta3::StreamingMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-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](https://cloud.google.com/dataflow/docs/guides/streaming-modes).

### #streaming_mode=

    def streaming_mode=(value) -> ::Google::Cloud::Dataflow::V1beta3::StreamingMode

**Parameter**

- **value** ([::Google::Cloud::Dataflow::V1beta3::StreamingMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-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](https://cloud.google.com/dataflow/docs/guides/streaming-modes).
**Returns**

- ([::Google::Cloud::Dataflow::V1beta3::StreamingMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-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](https://cloud.google.com/dataflow/docs/guides/streaming-modes).

### #subnetwork

    def subnetwork() -> ::String

**Returns**

- (::String) --- 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.

### #subnetwork=

    def subnetwork=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.
**Returns**

- (::String) --- 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.

### #temp_location

    def temp_location() -> ::String

**Returns**

- (::String) --- Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.

### #temp_location=

    def temp_location=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
**Returns**

- (::String) --- Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.

### #worker_region

    def worker_region() -> ::String

**Returns**

- (::String) --- 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.

### #worker_region=

    def worker_region=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.
**Returns**

- (::String) --- 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.

### #worker_zone

    def worker_zone() -> ::String

**Returns**

- (::String) --- 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.

### #worker_zone=

    def worker_zone=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.
**Returns**

- (::String) --- 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.

### #zone

    def zone() -> ::String

**Returns**

- (::String) --- Optional. The Compute Engine [availability
  zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

### #zone=

    def zone=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The Compute Engine [availability
  zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
**Returns**

- (::String) --- Optional. The Compute Engine [availability
  zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.