dataflow
v1b3
|
#include <worker_pool.h>
Public Member Functions | |
WorkerPool (const Json::Value &storage) | |
WorkerPool (Json::Value *storage) | |
virtual | ~WorkerPool () |
const StringPiece | GetTypeName () const |
bool | has_autoscaling_settings () const |
void | clear_autoscaling_settings () |
const AutoscalingSettings | get_autoscaling_settings () const |
AutoscalingSettings | mutable_autoscalingSettings () |
bool | has_data_disks () const |
void | clear_data_disks () |
const client::JsonCppArray< Disk > | get_data_disks () const |
client::JsonCppArray< Disk > | mutable_dataDisks () |
bool | has_default_package_set () const |
void | clear_default_package_set () |
const StringPiece | get_default_package_set () const |
void | set_default_package_set (const StringPiece &value) |
bool | has_disk_size_gb () const |
void | clear_disk_size_gb () |
int32 | get_disk_size_gb () const |
void | set_disk_size_gb (int32 value) |
bool | has_disk_source_image () const |
void | clear_disk_source_image () |
const StringPiece | get_disk_source_image () const |
void | set_disk_source_image (const StringPiece &value) |
bool | has_disk_type () const |
void | clear_disk_type () |
const StringPiece | get_disk_type () const |
void | set_disk_type (const StringPiece &value) |
bool | has_ip_configuration () const |
void | clear_ip_configuration () |
const StringPiece | get_ip_configuration () const |
void | set_ip_configuration (const StringPiece &value) |
bool | has_kind () const |
void | clear_kind () |
const StringPiece | get_kind () const |
void | set_kind (const StringPiece &value) |
bool | has_machine_type () const |
void | clear_machine_type () |
const StringPiece | get_machine_type () const |
void | set_machine_type (const StringPiece &value) |
bool | has_metadata () const |
void | clear_metadata () |
const client::JsonCppAssociativeArray< string > | get_metadata () const |
client::JsonCppAssociativeArray< string > | mutable_metadata () |
bool | has_network () const |
void | clear_network () |
const StringPiece | get_network () const |
void | set_network (const StringPiece &value) |
bool | has_num_threads_per_worker () const |
void | clear_num_threads_per_worker () |
int32 | get_num_threads_per_worker () const |
void | set_num_threads_per_worker (int32 value) |
bool | has_num_workers () const |
void | clear_num_workers () |
int32 | get_num_workers () const |
void | set_num_workers (int32 value) |
bool | has_on_host_maintenance () const |
void | clear_on_host_maintenance () |
const StringPiece | get_on_host_maintenance () const |
void | set_on_host_maintenance (const StringPiece &value) |
bool | has_packages () const |
void | clear_packages () |
const client::JsonCppArray< Package > | get_packages () const |
client::JsonCppArray< Package > | mutable_packages () |
bool | has_pool_args () const |
void | clear_pool_args () |
const client::JsonCppAssociativeArray< client::JsonCppData > | get_pool_args () const |
client::JsonCppAssociativeArray< client::JsonCppData > | mutable_poolArgs () |
bool | has_sdk_harness_container_images () const |
void | clear_sdk_harness_container_images () |
const client::JsonCppArray< SdkHarnessContainerImage > | get_sdk_harness_container_images () const |
client::JsonCppArray< SdkHarnessContainerImage > | mutable_sdkHarnessContainerImages () |
bool | has_subnetwork () const |
void | clear_subnetwork () |
const StringPiece | get_subnetwork () const |
void | set_subnetwork (const StringPiece &value) |
bool | has_taskrunner_settings () const |
void | clear_taskrunner_settings () |
const TaskRunnerSettings | get_taskrunner_settings () const |
TaskRunnerSettings | mutable_taskrunnerSettings () |
bool | has_teardown_policy () const |
void | clear_teardown_policy () |
const StringPiece | get_teardown_policy () const |
void | set_teardown_policy (const StringPiece &value) |
bool | has_worker_harness_container_image () const |
void | clear_worker_harness_container_image () |
const StringPiece | get_worker_harness_container_image () const |
void | set_worker_harness_container_image (const StringPiece &value) |
bool | has_zone () const |
void | clear_zone () |
const StringPiece | get_zone () const |
void | set_zone (const StringPiece &value) |
Static Public Member Functions | |
static WorkerPool * | New () |
Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
|
explicit |
Standard constructor for an immutable data object instance.
[in] | storage | The underlying data storage for this instance. |
|
explicit |
Standard constructor for a mutable data object instance.
[in] | storage | The underlying data storage for this instance. |
|
virtual |
Standard destructor.
|
inline |
Clears the 'autoscalingSettings
' attribute.
|
inline |
Clears the 'dataDisks
' attribute.
|
inline |
Clears the 'defaultPackageSet
' attribute.
|
inline |
Clears the 'diskSizeGb
' attribute.
|
inline |
Clears the 'diskSourceImage
' attribute.
|
inline |
Clears the 'diskType
' attribute.
|
inline |
Clears the 'ipConfiguration
' attribute.
|
inline |
Clears the 'kind
' attribute.
|
inline |
Clears the 'machineType
' attribute.
|
inline |
Clears the 'metadata
' attribute.
|
inline |
Clears the 'network
' attribute.
|
inline |
Clears the 'numThreadsPerWorker
' attribute.
|
inline |
Clears the 'numWorkers
' attribute.
|
inline |
Clears the 'onHostMaintenance
' attribute.
|
inline |
Clears the 'packages
' attribute.
|
inline |
Clears the 'poolArgs
' attribute.
|
inline |
Clears the 'sdkHarnessContainerImages
' attribute.
|
inline |
Clears the 'subnetwork
' attribute.
|
inline |
Clears the 'taskrunnerSettings
' attribute.
|
inline |
Clears the 'teardownPolicy
' attribute.
|
inline |
Clears the 'workerHarnessContainerImage
' attribute.
|
inline |
Clears the 'zone
' attribute.
const AutoscalingSettings google_dataflow_api::WorkerPool::get_autoscaling_settings | ( | ) | const |
Get a reference to the value of the 'autoscalingSettings
' attribute.
const client::JsonCppArray<Disk > google_dataflow_api::WorkerPool::get_data_disks | ( | ) | const |
Get a reference to the value of the 'dataDisks
' attribute.
|
inline |
Get the value of the 'defaultPackageSet
' attribute.
|
inline |
Get the value of the 'diskSizeGb
' attribute.
|
inline |
Get the value of the 'diskSourceImage
' attribute.
|
inline |
Get the value of the 'diskType
' attribute.
|
inline |
Get the value of the 'ipConfiguration
' attribute.
|
inline |
Get the value of the 'kind
' attribute.
|
inline |
Get the value of the 'machineType
' attribute.
|
inline |
Get a reference to the value of the 'metadata
' attribute.
|
inline |
Get the value of the 'network
' attribute.
|
inline |
Get the value of the 'numThreadsPerWorker
' attribute.
|
inline |
Get the value of the 'numWorkers
' attribute.
|
inline |
Get the value of the 'onHostMaintenance
' attribute.
const client::JsonCppArray<Package > google_dataflow_api::WorkerPool::get_packages | ( | ) | const |
Get a reference to the value of the 'packages
' attribute.
|
inline |
Get a reference to the value of the 'poolArgs
' attribute.
const client::JsonCppArray<SdkHarnessContainerImage > google_dataflow_api::WorkerPool::get_sdk_harness_container_images | ( | ) | const |
Get a reference to the value of the 'sdkHarnessContainerImages
' attribute.
|
inline |
Get the value of the 'subnetwork
' attribute.
const TaskRunnerSettings google_dataflow_api::WorkerPool::get_taskrunner_settings | ( | ) | const |
Get a reference to the value of the 'taskrunnerSettings
' attribute.
|
inline |
Get the value of the 'teardownPolicy
' attribute.
|
inline |
Get the value of the 'workerHarnessContainerImage
' attribute.
|
inline |
Get the value of the 'zone
' attribute.
|
inline |
Returns a string denoting the type of this data object.
|
inline |
Determine if the 'autoscalingSettings
' attribute was set.
autoscalingSettings
' attribute was set.
|
inline |
Determine if the 'dataDisks
' attribute was set.
dataDisks
' attribute was set.
|
inline |
Determine if the 'defaultPackageSet
' attribute was set.
defaultPackageSet
' attribute was set.
|
inline |
Determine if the 'diskSizeGb
' attribute was set.
diskSizeGb
' attribute was set.
|
inline |
Determine if the 'diskSourceImage
' attribute was set.
diskSourceImage
' attribute was set.
|
inline |
Determine if the 'diskType
' attribute was set.
diskType
' attribute was set.
|
inline |
Determine if the 'ipConfiguration
' attribute was set.
ipConfiguration
' attribute was set.
|
inline |
Determine if the 'kind
' attribute was set.
kind
' attribute was set.
|
inline |
Determine if the 'machineType
' attribute was set.
machineType
' attribute was set.
|
inline |
Determine if the 'metadata
' attribute was set.
metadata
' attribute was set.
|
inline |
Determine if the 'network
' attribute was set.
network
' attribute was set.
|
inline |
Determine if the 'numThreadsPerWorker
' attribute was set.
numThreadsPerWorker
' attribute was set.
|
inline |
Determine if the 'numWorkers
' attribute was set.
numWorkers
' attribute was set.
|
inline |
Determine if the 'onHostMaintenance
' attribute was set.
onHostMaintenance
' attribute was set.
|
inline |
Determine if the 'packages
' attribute was set.
packages
' attribute was set.
|
inline |
Determine if the 'poolArgs
' attribute was set.
poolArgs
' attribute was set.
|
inline |
Determine if the 'sdkHarnessContainerImages
' attribute was set.
sdkHarnessContainerImages
' attribute was set.
|
inline |
Determine if the 'subnetwork
' attribute was set.
subnetwork
' attribute was set.
|
inline |
Determine if the 'taskrunnerSettings
' attribute was set.
taskrunnerSettings
' attribute was set.
|
inline |
Determine if the 'teardownPolicy
' attribute was set.
teardownPolicy
' attribute was set.
|
inline |
Determine if the 'workerHarnessContainerImage
' attribute was set.
workerHarnessContainerImage
' attribute was set.
|
inline |
Determine if the 'zone
' attribute was set.
zone
' attribute was set. AutoscalingSettings google_dataflow_api::WorkerPool::mutable_autoscalingSettings | ( | ) |
Gets a reference to a mutable value of the 'autoscalingSettings
' property.
Settings for autoscaling of this WorkerPool.
client::JsonCppArray<Disk > google_dataflow_api::WorkerPool::mutable_dataDisks | ( | ) |
Gets a reference to a mutable value of the 'dataDisks
' property.
Data disks that are used by a VM in this workflow.
|
inline |
Gets a reference to a mutable value of the 'metadata
' property.
Metadata to set on the Google Compute Engine VMs.
client::JsonCppArray<Package > google_dataflow_api::WorkerPool::mutable_packages | ( | ) |
Gets a reference to a mutable value of the 'packages
' property.
Packages to be installed on workers.
|
inline |
Gets a reference to a mutable value of the 'poolArgs
' property.
Extra arguments for this worker pool.
client::JsonCppArray<SdkHarnessContainerImage > google_dataflow_api::WorkerPool::mutable_sdkHarnessContainerImages | ( | ) |
Gets a reference to a mutable value of the 'sdkHarnessContainerImages
' property.
Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.
TaskRunnerSettings google_dataflow_api::WorkerPool::mutable_taskrunnerSettings | ( | ) |
Gets a reference to a mutable value of the 'taskrunnerSettings
' property.
Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
|
static |
Creates a new default instance.
|
inline |
Change the 'defaultPackageSet
' attribute.
The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
[in] | value | The new value. |
|
inline |
Change the 'diskSizeGb
' attribute.
Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |
|
inline |
Change the 'diskSourceImage
' attribute.
Fully qualified source image for disks.
[in] | value | The new value. |
|
inline |
Change the 'diskType
' attribute.
Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |
|
inline |
Change the 'ipConfiguration
' attribute.
Configuration for VM IPs.
[in] | value | The new value. |
|
inline |
Change the 'kind
' attribute.
The kind of the worker pool; currently only harness
and shuffle
are supported.
[in] | value | The new value. |
|
inline |
Change the 'machineType
' attribute.
Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |
|
inline |
Change the 'network
' attribute.
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
[in] | value | The new value. |
|
inline |
Change the 'numThreadsPerWorker
' attribute.
The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
[in] | value | The new value. |
|
inline |
Change the 'numWorkers
' attribute.
Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |
|
inline |
Change the 'onHostMaintenance
' attribute.
The action to take on host maintenance, as defined by the Google Compute Engine API.
[in] | value | The new value. |
|
inline |
Change the 'subnetwork
' attribute.
Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
[in] | value | The new value. |
|
inline |
Change the 'teardownPolicy
' attribute.
Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS
, TEARDOWN_ON_SUCCESS
, and TEARDOWN_NEVER
. TEARDOWN_ALWAYS
means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS
means workers are torn down if the job succeeds. TEARDOWN_NEVER
means the workers are never torn down.
If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS
policy except for small, manually supervised test jobs.
If unknown or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |
|
inline |
Change the 'workerHarnessContainerImage
' attribute.
Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.
Deprecated for the Fn API path. Use sdk_harness_container_images instead.
[in] | value | The new value. |
|
inline |
Change the 'zone
' attribute.
Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
[in] | value | The new value. |