Struct WorkerPool 

#[non_exhaustive]
pub struct WorkerPool {

    pub name: String,
    pub description: String,
    pub uid: String,
    pub generation: i64,
    pub labels: HashMap<String, String>,
    pub annotations: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub expire_time: Option<Timestamp>,
    pub creator: String,
    pub last_modifier: String,
    pub client: String,
    pub client_version: String,
    pub launch_stage: LaunchStage,
    pub binary_authorization: Option<BinaryAuthorization>,
    pub template: Option<WorkerPoolRevisionTemplate>,
    pub instance_splits: Vec<InstanceSplit>,
    pub scaling: Option<WorkerPoolScaling>,
    pub observed_generation: i64,
    pub terminal_condition: Option<Condition>,
    pub conditions: Vec<Condition>,
    pub latest_ready_revision: String,
    pub latest_created_revision: String,
    pub instance_split_statuses: Vec<InstanceSplitStatus>,
    pub threat_detection_enabled: bool,
    pub custom_audiences: Vec<String>,
    pub satisfies_pzs: bool,
    pub reconciling: bool,
    pub etag: String,
    /* private fields */
}

WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.

Format: projects/{project}/locations/{location}/workerPools/{worker_id}

description: String

User-provided description of the WorkerPool. This field currently has a 512-character limit.

uid: String

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

generation: i64

Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

labels: HashMap<String, String>

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google’s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

annotations: HashMap<String, String>

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

create_time: Option<Timestamp>

Output only. The creation time.

update_time: Option<Timestamp>

Output only. The last-modified time.

delete_time: Option<Timestamp>

Output only. The deletion time. It is only populated as a response to a Delete request.

expire_time: Option<Timestamp>

Output only. For a deleted resource, the time after which it will be permamently deleted.

creator: String

Output only. Email address of the authenticated creator.

last_modifier: String

Output only. Email address of the last authenticated modifier.

client: String

Arbitrary identifier for the API client.

client_version: String

Arbitrary version identifier for the API client.

launch_stage: LaunchStage

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

binary_authorization: Option<BinaryAuthorization>

Optional. Settings for the Binary Authorization feature.

template: Option<WorkerPoolRevisionTemplate>

Required. The template used to create revisions for this WorkerPool.

instance_splits: Vec<InstanceSplit>

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

scaling: Option<WorkerPoolScaling>

Optional. Specifies worker-pool-level scaling settings

observed_generation: i64

Output only. The generation of this WorkerPool currently serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

terminal_condition: Option<Condition>

Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

conditions: Vec<Condition>

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

latest_ready_revision: String

Output only. Name of the latest revision that is serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run.

latest_created_revision: String

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

instance_split_statuses: Vec<InstanceSplitStatus>

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

threat_detection_enabled: bool

Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool.

custom_audiences: Vec<String>

Not supported, and ignored by Cloud Run.

satisfies_pzs: bool

Output only. Reserved for future use.

reconciling: bool

Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state.

When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, instance_split_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state.

If reconciliation succeeded, the following fields will match: instance_splits and instance_split_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision.

If reconciliation failed, instance_split_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in terminal_condition and conditions.

etag: String

Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Implementations

impl WorkerPool

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = WorkerPool::new().set_name("example");

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = WorkerPool::new().set_description("example");

pub fn set_uid<T: Into<String>>(self, v: T) -> Self

Sets the value of uid.

Example

let x = WorkerPool::new().set_uid("example");

pub fn set_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of generation.

Example

let x = WorkerPool::new().set_generation(42);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = WorkerPool::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_annotations<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

Example

let x = WorkerPool::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_delete_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of delete_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_delete_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_delete_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of delete_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_delete_time(None::<Timestamp>);

pub fn set_expire_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of expire_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_expire_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_expire_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of expire_time.

Example

use wkt::Timestamp;
let x = WorkerPool::new().set_or_clear_expire_time(Some(Timestamp::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_expire_time(None::<Timestamp>);

pub fn set_creator<T: Into<String>>(self, v: T) -> Self

Sets the value of creator.

Example

let x = WorkerPool::new().set_creator("example");

pub fn set_last_modifier<T: Into<String>>(self, v: T) -> Self

Sets the value of last_modifier.

Example

let x = WorkerPool::new().set_last_modifier("example");

pub fn set_client<T: Into<String>>(self, v: T) -> Self

Sets the value of client.

Example

let x = WorkerPool::new().set_client("example");

pub fn set_client_version<T: Into<String>>(self, v: T) -> Self

Sets the value of client_version.

Example

let x = WorkerPool::new().set_client_version("example");

pub fn set_launch_stage<T: Into<LaunchStage>>(self, v: T) -> Self

Sets the value of launch_stage.

Example

use api::model::LaunchStage;
let x0 = WorkerPool::new().set_launch_stage(LaunchStage::Unimplemented);
let x1 = WorkerPool::new().set_launch_stage(LaunchStage::Prelaunch);
let x2 = WorkerPool::new().set_launch_stage(LaunchStage::EarlyAccess);

pub fn set_binary_authorization<T>(self, v: T) -> Self

where T: Into<BinaryAuthorization>,

Sets the value of binary_authorization.

Example

use google_cloud_run_v2::model::BinaryAuthorization;
let x = WorkerPool::new().set_binary_authorization(BinaryAuthorization::default()/* use setters */);

pub fn set_or_clear_binary_authorization<T>(self, v: Option<T>) -> Self

where T: Into<BinaryAuthorization>,

Sets or clears the value of binary_authorization.

Example

use google_cloud_run_v2::model::BinaryAuthorization;
let x = WorkerPool::new().set_or_clear_binary_authorization(Some(BinaryAuthorization::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_binary_authorization(None::<BinaryAuthorization>);

pub fn set_template<T>(self, v: T) -> Self

where T: Into<WorkerPoolRevisionTemplate>,

Sets the value of template.

Example

use google_cloud_run_v2::model::WorkerPoolRevisionTemplate;
let x = WorkerPool::new().set_template(WorkerPoolRevisionTemplate::default()/* use setters */);

pub fn set_or_clear_template<T>(self, v: Option<T>) -> Self

where T: Into<WorkerPoolRevisionTemplate>,

Sets or clears the value of template.

Example

use google_cloud_run_v2::model::WorkerPoolRevisionTemplate;
let x = WorkerPool::new().set_or_clear_template(Some(WorkerPoolRevisionTemplate::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_template(None::<WorkerPoolRevisionTemplate>);

pub fn set_instance_splits<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<InstanceSplit>,

Sets the value of instance_splits.

Example

use google_cloud_run_v2::model::InstanceSplit;
let x = WorkerPool::new()
    .set_instance_splits([
        InstanceSplit::default()/* use setters */,
        InstanceSplit::default()/* use (different) setters */,
    ]);

pub fn set_scaling<T>(self, v: T) -> Self

where T: Into<WorkerPoolScaling>,

Sets the value of scaling.

Example

use google_cloud_run_v2::model::WorkerPoolScaling;
let x = WorkerPool::new().set_scaling(WorkerPoolScaling::default()/* use setters */);

pub fn set_or_clear_scaling<T>(self, v: Option<T>) -> Self

where T: Into<WorkerPoolScaling>,

Sets or clears the value of scaling.

Example

use google_cloud_run_v2::model::WorkerPoolScaling;
let x = WorkerPool::new().set_or_clear_scaling(Some(WorkerPoolScaling::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_scaling(None::<WorkerPoolScaling>);

pub fn set_observed_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of observed_generation.

Example

let x = WorkerPool::new().set_observed_generation(42);

pub fn set_terminal_condition<T>(self, v: T) -> Self

where T: Into<Condition>,

Sets the value of terminal_condition.

Example

use google_cloud_run_v2::model::Condition;
let x = WorkerPool::new().set_terminal_condition(Condition::default()/* use setters */);

pub fn set_or_clear_terminal_condition<T>(self, v: Option<T>) -> Self

where T: Into<Condition>,

Sets or clears the value of terminal_condition.

Example

use google_cloud_run_v2::model::Condition;
let x = WorkerPool::new().set_or_clear_terminal_condition(Some(Condition::default()/* use setters */));
let x = WorkerPool::new().set_or_clear_terminal_condition(None::<Condition>);

pub fn set_conditions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Condition>,

Sets the value of conditions.

Example

use google_cloud_run_v2::model::Condition;
let x = WorkerPool::new()
    .set_conditions([
        Condition::default()/* use setters */,
        Condition::default()/* use (different) setters */,
    ]);

pub fn set_latest_ready_revision<T: Into<String>>(self, v: T) -> Self

Sets the value of latest_ready_revision.

Example

let x = WorkerPool::new().set_latest_ready_revision("example");

pub fn set_latest_created_revision<T: Into<String>>(self, v: T) -> Self

Sets the value of latest_created_revision.

Example

let x = WorkerPool::new().set_latest_created_revision("example");

pub fn set_instance_split_statuses<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<InstanceSplitStatus>,

Sets the value of instance_split_statuses.

Example

use google_cloud_run_v2::model::InstanceSplitStatus;
let x = WorkerPool::new()
    .set_instance_split_statuses([
        InstanceSplitStatus::default()/* use setters */,
        InstanceSplitStatus::default()/* use (different) setters */,
    ]);

pub fn set_threat_detection_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of threat_detection_enabled.

Example

let x = WorkerPool::new().set_threat_detection_enabled(true);

pub fn set_custom_audiences<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of custom_audiences.

Example

let x = WorkerPool::new().set_custom_audiences(["a", "b", "c"]);

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

Example

let x = WorkerPool::new().set_satisfies_pzs(true);

pub fn set_reconciling<T: Into<bool>>(self, v: T) -> Self

Sets the value of reconciling.

Example

let x = WorkerPool::new().set_reconciling(true);

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

Example

let x = WorkerPool::new().set_etag("example");

Trait Implementations

impl Clone for WorkerPool

fn clone(&self) -> WorkerPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerPool

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

Formats the value using the given formatter.

impl Default for WorkerPool

fn default() -> WorkerPool

Returns the “default value” for a type.

impl Message for WorkerPool

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WorkerPool

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for WorkerPool