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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ num_workers |
int
The initial number of Google Compute Engine instnaces for the job. |
↳ max_workers |
int
The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. |
↳ zone |
string
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
The email address of the service account to run the job as. |
↳ temp_location |
string
The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with |
↳ bypass_temp_dir_validation |
bool
Whether to bypass the safety checks for the job's temporary directory. Use with caution. |
↳ machine_type |
string
The machine type to use for the job. Defaults to the value from the template if not specified. |
↳ additional_experiments |
array
Additional experiment flags for the job, specified with the |
↳ network |
string
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
↳ subnetwork |
string
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
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
Name for the Cloud KMS key for the job. Key format is: projects/
|
↳ ip_configuration |
int
Configuration for VM IPs. |
↳ worker_region |
string
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
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 |
↳ enable_streaming_engine |
bool
Whether to enable Streaming Engine for the job. |
getNumWorkers
The initial number of Google Compute Engine instnaces for the job.
| Returns | |
|---|---|
| Type | Description |
int |
|
setNumWorkers
The initial number of Google Compute Engine instnaces for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxWorkers
The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxWorkers
The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
The Compute Engine availability zone for launching worker instances to run your pipeline.
In the future, worker_zone will take precedence.
| Returns | |
|---|---|
| Type | Description |
string |
|
setZone
The Compute Engine availability zone for launching worker instances to run your pipeline.
In the future, worker_zone will take precedence.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccountEmail
The email address of the service account to run the job as.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceAccountEmail
The email address of the service account to run the job as.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTempLocation
The Cloud Storage path to use for temporary files.
Must be a valid Cloud Storage URL, beginning with gs://.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTempLocation
The Cloud Storage path to use for temporary files.
Must be a valid Cloud Storage URL, beginning with gs://.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBypassTempDirValidation
Whether to bypass the safety checks for the job's temporary directory.
Use with caution.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setBypassTempDirValidation
Whether to bypass the safety checks for the job's temporary directory.
Use with caution.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineType
The machine type to use for the job. Defaults to the value from the template if not specified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMachineType
The machine type to use for the job. Defaults to the value from the template if not specified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdditionalExperiments
Additional experiment flags for the job, specified with the
--experiments option.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAdditionalExperiments
Additional experiment flags for the job, specified with the
--experiments option.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetwork
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetwork
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubnetwork
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 | |
|---|---|
| Type | Description |
string |
|
setSubnetwork
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdditionalUserLabels
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" }.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAdditionalUserLabels
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" }.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKeyName
Name for the Cloud KMS key for the job.
Key format is: projects/
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKeyName
Name for the Cloud KMS key for the job.
Key format is: projects/
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpConfiguration
Configuration for VM IPs.
| Returns | |
|---|---|
| Type | Description |
int |
|
setIpConfiguration
Configuration for VM IPs.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkerRegion
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 | |
|---|---|
| Type | Description |
string |
|
setWorkerRegion
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkerZone
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 | |
|---|---|
| Type | Description |
string |
|
setWorkerZone
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableStreamingEngine
Whether to enable Streaming Engine for the job.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableStreamingEngine
Whether to enable Streaming Engine for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|