Struct googapis::google::dataflow::v1beta3::WorkerPool [−][src]
pub struct WorkerPool {Show 22 fields
pub kind: String,
pub num_workers: i32,
pub packages: Vec<Package>,
pub default_package_set: i32,
pub machine_type: String,
pub teardown_policy: i32,
pub disk_size_gb: i32,
pub disk_type: String,
pub disk_source_image: String,
pub zone: String,
pub taskrunner_settings: Option<TaskRunnerSettings>,
pub on_host_maintenance: String,
pub data_disks: Vec<Disk>,
pub metadata: HashMap<String, String>,
pub autoscaling_settings: Option<AutoscalingSettings>,
pub pool_args: Option<Any>,
pub network: String,
pub subnetwork: String,
pub worker_harness_container_image: String,
pub num_threads_per_worker: i32,
pub ip_configuration: i32,
pub sdk_harness_container_images: Vec<SdkHarnessContainerImage>,
}
Expand description
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.
Fields
kind: String
The kind of the worker pool; currently only harness
and shuffle
are supported.
num_workers: i32
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.
packages: Vec<Package>
Packages to be installed on workers.
default_package_set: i32
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.
machine_type: String
Machine type (e.g. “n1-standard-1”). If empty or unspecified, the service will attempt to choose a reasonable default.
teardown_policy: i32
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.
disk_size_gb: i32
Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
disk_type: String
Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
disk_source_image: String
Fully qualified source image for disks.
zone: String
Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
taskrunner_settings: Option<TaskRunnerSettings>
Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
on_host_maintenance: String
The action to take on host maintenance, as defined by the Google Compute Engine API.
data_disks: Vec<Disk>
Data disks that are used by a VM in this workflow.
metadata: HashMap<String, String>
Metadata to set on the Google Compute Engine VMs.
autoscaling_settings: Option<AutoscalingSettings>
Settings for autoscaling of this WorkerPool.
pool_args: Option<Any>
Extra arguments for this worker pool.
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. Expected to be of the form “regions/REGION/subnetworks/SUBNETWORK”.
worker_harness_container_image: String
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.
num_threads_per_worker: i32
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).
ip_configuration: i32
Configuration for VM IPs.
sdk_harness_container_images: Vec<SdkHarnessContainerImage>
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.
Implementations
Returns the enum value of default_package_set
, or the default if the field is set to an invalid enum value.
Sets default_package_set
to the provided enum value.
Returns the enum value of teardown_policy
, or the default if the field is set to an invalid enum value.
Sets teardown_policy
to the provided enum value.
Returns the enum value of ip_configuration
, or the default if the field is set to an invalid enum value.
Sets ip_configuration
to the provided enum value.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for WorkerPool
impl Send for WorkerPool
impl Sync for WorkerPool
impl Unpin for WorkerPool
impl UnwindSafe for WorkerPool
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more