Struct google_api_proto::google::dataflow::v1beta3::FlexTemplateRuntimeEnvironment

pub struct FlexTemplateRuntimeEnvironment {

    pub num_workers: i32,
    pub max_workers: i32,
    pub zone: String,
    pub service_account_email: String,
    pub temp_location: String,
    pub machine_type: String,
    pub additional_experiments: Vec<String>,
    pub network: String,
    pub subnetwork: String,
    pub additional_user_labels: BTreeMap<String, String>,
    pub kms_key_name: String,
    pub ip_configuration: i32,
    pub worker_region: String,
    pub worker_zone: String,
    pub enable_streaming_engine: bool,
    pub flexrs_goal: i32,
    pub staging_location: String,
    pub sdk_container_image: String,
    pub disk_size_gb: i32,
    pub autoscaling_algorithm: i32,
    pub dump_heap_on_oom: bool,
    pub save_heap_dumps_to_gcs_path: String,
    pub launcher_machine_type: String,
}

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

Fields

num_workers: i32

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

max_workers: i32

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: Vec<String>

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: BTreeMap<String, String>

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//locations//keyRings//cryptoKeys/

ip_configuration: i32

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: i32

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: i32

Worker disk size, in gigabytes.

autoscaling_algorithm: i32

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.

Implementations

impl FlexTemplateRuntimeEnvironment

pub fn ip_configuration(&self) -> WorkerIpAddressConfiguration

Returns the enum value of ip_configuration, or the default if the field is set to an invalid enum value.

pub fn set_ip_configuration(&mut self, value: WorkerIpAddressConfiguration)

Sets ip_configuration to the provided enum value.

pub fn flexrs_goal(&self) -> FlexResourceSchedulingGoal

Returns the enum value of flexrs_goal, or the default if the field is set to an invalid enum value.

pub fn set_flexrs_goal(&mut self, value: FlexResourceSchedulingGoal)

Sets flexrs_goal to the provided enum value.

pub fn autoscaling_algorithm(&self) -> AutoscalingAlgorithm

Returns the enum value of autoscaling_algorithm, or the default if the field is set to an invalid enum value.

pub fn set_autoscaling_algorithm(&mut self, value: AutoscalingAlgorithm)

Sets autoscaling_algorithm to the provided enum value.

Trait Implementations

impl Clone for FlexTemplateRuntimeEnvironment

fn clone(&self) -> FlexTemplateRuntimeEnvironment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlexTemplateRuntimeEnvironment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FlexTemplateRuntimeEnvironment

fn default() -> Self

Returns the “default value” for a type.

impl Message for FlexTemplateRuntimeEnvironment

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FlexTemplateRuntimeEnvironment

fn eq(&self, other: &FlexTemplateRuntimeEnvironment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FlexTemplateRuntimeEnvironment