Google Cloud Dataflow V1beta3 Client - Class FlexTemplateRuntimeEnvironment (0.6.3)

Version 0.6.3

• 0.6.5 (latest)
• 0.6.4
• 0.5.1
• 0.4.1
• 0.3.10

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class FlexTemplateRuntimeEnvironment.

The environment values to be set at runtime for flex template.

Generated from protobuf message google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ num_workers	int The initial number of Google Compute Engine instances 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 gs://.
↳ 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.
↳ 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 must 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 worker_zone and zone are set, worker_zone takes precedence.
↳ enable_streaming_engine	bool Whether to enable Streaming Engine for the job.
↳ flexrs_goal	int Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
↳ staging_location	string The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with gs://.
↳ sdk_container_image	string Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
↳ disk_size_gb	int Worker disk size, in gigabytes.
↳ autoscaling_algorithm	int The algorithm to use for autoscaling
↳ dump_heap_on_oom	bool If true, save a heap dump before killing a thread or process which is GC thrashing or out of memory. The location of the heap file will either be echoed back to the user, or the user will be given the opportunity to download the heap file.
↳ save_heap_dumps_to_gcs_path	string Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).
↳ launcher_machine_type	string The machine type to use for launching the job. The default is n1-standard-1.

getNumWorkers

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

Returns
Type	Description
int

setNumWorkers

The initial number of Google Compute Engine instances 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

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAdditionalExperiments

Additional experiment flags for the job.

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 must 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 must 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

getFlexrsGoal

Set FlexRS goal for the job.

https://cloud.google.com/dataflow/docs/guides/flexrs

Returns
Type	Description
int

setFlexrsGoal

Set FlexRS goal for the job.

https://cloud.google.com/dataflow/docs/guides/flexrs

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStagingLocation

The Cloud Storage path for staging local files.

Must be a valid Cloud Storage URL, beginning with gs://.

Returns
Type	Description
string

setStagingLocation

The Cloud Storage path for staging local files.

Must be a valid Cloud Storage URL, beginning with gs://.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSdkContainerImage

Docker registry location of container image to use for the 'worker harness.

Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

Returns
Type	Description
string

setSdkContainerImage

Docker registry location of container image to use for the 'worker harness.

Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDiskSizeGb

Worker disk size, in gigabytes.

Returns
Type	Description
int

setDiskSizeGb

Worker disk size, in gigabytes.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAutoscalingAlgorithm

The algorithm to use for autoscaling

Returns
Type	Description
int

setAutoscalingAlgorithm

The algorithm to use for autoscaling

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDumpHeapOnOom

If true, save a heap dump before killing a thread or process which is GC thrashing or out of memory. The location of the heap file will either be echoed back to the user, or the user will be given the opportunity to download the heap file.

Returns
Type	Description
bool

setDumpHeapOnOom

If true, save a heap dump before killing a thread or process which is GC thrashing or out of memory. The location of the heap file will either be echoed back to the user, or the user will be given the opportunity to download the heap file.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSaveHeapDumpsToGcsPath

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

Returns
Type	Description
string

setSaveHeapDumpsToGcsPath

Cloud Storage bucket (directory) to upload heap dumps to the given location. Enabling this implies that heap dumps should be generated on OOM (dump_heap_on_oom is set to true).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLauncherMachineType

The machine type to use for launching the job. The default is n1-standard-1.

Returns
Type	Description
string

setLauncherMachineType

The machine type to use for launching the job. The default is n1-standard-1.

Parameter
Name	Description
var	string

Returns
Type	Description
$this