Struct ListClustersRequest

#[non_exhaustive]
pub struct ListClustersRequest {
    pub project_id: String,
    pub region: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    /* private fields */
}

A request to list the clusters in a project.

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.

project_id: String

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

region: String

Required. The Dataproc region in which to handle the request.

filter: String

Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] …

where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

page_size: i32

Optional. The standard List page size.

page_token: String

Optional. The standard List page token.

Implementations

impl ListClustersRequest

pub fn new() -> Self

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

Sets the value of project_id.

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

Sets the value of region.

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

Sets the value of filter.

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

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

Sets the value of page_token.

Trait Implementations

impl Clone for ListClustersRequest

fn clone(&self) -> ListClustersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListClustersRequest

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

Formats the value using the given formatter.

impl Default for ListClustersRequest

fn default() -> ListClustersRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListClustersRequest

where ListClustersRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListClustersRequest

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for ListClustersRequest

fn eq(&self, other: &ListClustersRequest) -> 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 Serialize for ListClustersRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListClustersRequest