Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class RuntimeEnvironment.
The environment values to set at runtime.
Generated from protobuf message google.dataflow.v1beta3.RuntimeEnvironment
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ num_workers
int
Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
↳ max_workers
int
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.
↳ zone
string
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
↳ service_account_email
string
Optional. The email address of the service account to run the job as.
↳ temp_location
string
Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://
.
↳ bypass_temp_dir_validation
bool
Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
↳ machine_type
string
Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
↳ additional_experiments
array
Optional. Additional experiment flags for the job, specified with the --experiments
option.
↳ network
string
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
↳ subnetwork
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.
↳ additional_user_labels
array| Google\Protobuf\Internal\MapField
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" }.
↳ kms_key_name
string
Optional. Name for the Cloud KMS key for the job. Key format is: projects/
↳ ip_configuration
int
Optional. Configuration for VM IPs.
↳ worker_region
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
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.
↳ enable_streaming_engine
bool
Optional. Whether to enable Streaming Engine for the job.
↳ disk_size_gb
int
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
↳ streaming_mode
int
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 .
getNumWorkers
Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
int
setNumWorkers
Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
var
int
$this
getMaxWorkers
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.
int
setMaxWorkers
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.
var
int
$this
getZone
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline.
In the future, worker_zone will take precedence.
string
setZone
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline.
In the future, worker_zone will take precedence.
var
string
$this
getServiceAccountEmail
Optional. The email address of the service account to run the job as.
string
setServiceAccountEmail
Optional. The email address of the service account to run the job as.
var
string
$this
getTempLocation
Required. The Cloud Storage path to use for temporary files.
Must be a valid Cloud Storage URL, beginning with gs://
.
string
setTempLocation
Required. The Cloud Storage path to use for temporary files.
Must be a valid Cloud Storage URL, beginning with gs://
.
var
string
$this
getBypassTempDirValidation
Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
bool
setBypassTempDirValidation
Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
var
bool
$this
getMachineType
Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
string
setMachineType
Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
var
string
$this
getAdditionalExperiments
Optional. Additional experiment flags for the job, specified with the --experiments
option.
setAdditionalExperiments
Optional. Additional experiment flags for the job, specified with the --experiments
option.
var
string[]
$this
getNetwork
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
string
setNetwork
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
var
string
$this
getSubnetwork
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.
string
setSubnetwork
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.
var
string
$this
getAdditionalUserLabels
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" }.
setAdditionalUserLabels
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" }.
$this
getKmsKeyName
Optional. Name for the Cloud KMS key for the job.
Key format is: projects/
string
setKmsKeyName
Optional. Name for the Cloud KMS key for the job.
Key format is: projects/
var
string
$this
getIpConfiguration
Optional. Configuration for VM IPs.
int
setIpConfiguration
Optional. Configuration for VM IPs.
var
int
$this
getWorkerRegion
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.
string
setWorkerRegion
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.
var
string
$this
getWorkerZone
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.
string
setWorkerZone
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.
var
string
$this
getEnableStreamingEngine
Optional. Whether to enable Streaming Engine for the job.
bool
setEnableStreamingEngine
Optional. Whether to enable Streaming Engine for the job.
var
bool
$this
getDiskSizeGb
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
int
setDiskSizeGb
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
var
int
$this
getStreamingMode
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 .
int
hasStreamingMode
clearStreamingMode
setStreamingMode
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 .
var
int
$this
