Struct Cluster 

#[non_exhaustive]
pub struct Cluster {
    pub name: String,
    pub location: String,
    pub state: State,
    pub serve_nodes: i32,
    pub node_scaling_factor: NodeScalingFactor,
    pub default_storage_type: StorageType,
    pub encryption_config: Option<EncryptionConfig>,
    pub config: Option<Config>,
    /* private fields */
}

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

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 unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

location: String

Immutable. The location where this cluster’s nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.

state: State

Output only. The current state of the cluster.

serve_nodes: i32

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

node_scaling_factor: NodeScalingFactor

Immutable. The node scaling factor of this cluster.

default_storage_type: StorageType

Immutable. The type of storage used by this cluster to serve its parent instance’s tables, unless explicitly overridden.

encryption_config: Option<EncryptionConfig>

Immutable. The encryption configuration for CMEK-protected clusters.

config: Option<Config>

Implementations

impl Cluster

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Cluster::new().set_name(format!("projects/{project_id}/instances/{instance_id}/clusters/{cluster_id}"));

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

Sets the value of location.

Example

let x = Cluster::new().set_location("example");

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_bigtable_admin_v2::model::cluster::State;
let x0 = Cluster::new().set_state(State::Ready);
let x1 = Cluster::new().set_state(State::Creating);
let x2 = Cluster::new().set_state(State::Resizing);

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

Sets the value of serve_nodes.

Example

let x = Cluster::new().set_serve_nodes(42);

pub fn set_node_scaling_factor<T: Into<NodeScalingFactor>>(self, v: T) -> Self

Sets the value of node_scaling_factor.

Example

use google_cloud_bigtable_admin_v2::model::cluster::NodeScalingFactor;
let x0 = Cluster::new().set_node_scaling_factor(NodeScalingFactor::NodeScalingFactor1X);
let x1 = Cluster::new().set_node_scaling_factor(NodeScalingFactor::NodeScalingFactor2X);

pub fn set_default_storage_type<T: Into<StorageType>>(self, v: T) -> Self

Sets the value of default_storage_type.

Example

use google_cloud_bigtable_admin_v2::model::StorageType;
let x0 = Cluster::new().set_default_storage_type(StorageType::Ssd);
let x1 = Cluster::new().set_default_storage_type(StorageType::Hdd);

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

where T: Into<EncryptionConfig>,

Sets the value of encryption_config.

Example

use google_cloud_bigtable_admin_v2::model::cluster::EncryptionConfig;
let x = Cluster::new().set_encryption_config(EncryptionConfig::default()/* use setters */);

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

where T: Into<EncryptionConfig>,

Sets or clears the value of encryption_config.

Example

use google_cloud_bigtable_admin_v2::model::cluster::EncryptionConfig;
let x = Cluster::new().set_or_clear_encryption_config(Some(EncryptionConfig::default()/* use setters */));
let x = Cluster::new().set_or_clear_encryption_config(None::<EncryptionConfig>);

pub fn set_config<T: Into<Option<Config>>>(self, v: T) -> Self

Sets the value of config.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::cluster::ClusterConfig;
let x = Cluster::new().set_config(Some(
    google_cloud_bigtable_admin_v2::model::cluster::Config::ClusterConfig(ClusterConfig::default().into())));

pub fn cluster_config(&self) -> Option<&Box<ClusterConfig>>

The value of config if it holds a ClusterConfig, None if the field is not set or holds a different branch.

pub fn set_cluster_config<T: Into<Box<ClusterConfig>>>(self, v: T) -> Self

Sets the value of config to hold a ClusterConfig.

Note that all the setters affecting config are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::cluster::ClusterConfig;
let x = Cluster::new().set_cluster_config(ClusterConfig::default()/* use setters */);
assert!(x.cluster_config().is_some());

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cluster

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

Formats the value using the given formatter.

impl Default for Cluster

fn default() -> Cluster

Returns the “default value” for a type.

impl Message for Cluster

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Cluster

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Cluster