Struct Instance 

#[non_exhaustive]
pub struct Instance {
    pub name: String,
    pub display_name: String,
    pub state: State,
    pub type: Type,
    pub edition: Edition,
    pub labels: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub satisfies_pzs: Option<bool>,
    pub satisfies_pzi: Option<bool>,
    pub tags: HashMap<String, String>,
    /* private fields */
}

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the 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 instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].

display_name: String

Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

state: State

Output only. The current state of the instance.

type: Type

The type of the instance. Defaults to PRODUCTION.

edition: Edition

Optional. The edition of the instance. See Edition for details.

labels: HashMap<String, String>

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer’s organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

• Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}.
• Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}.
• No more than 64 labels can be associated with a given resource.
• Keys and values must both be under 128 bytes.

create_time: Option<Timestamp>

Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

satisfies_pzs: Option<bool>

Output only. Reserved for future use.

satisfies_pzi: Option<bool>

Output only. Reserved for future use.

tags: HashMap<String, String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

• “123/environment”: “production”,
• “123/costCenter”: “marketing”

Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.

Implementations

impl Instance

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 = Instance::new().set_name(format!("projects/{project_id}/instances/{instance_id}"));

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

Sets the value of display_name.

Example

let x = Instance::new().set_display_name("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::instance::State;
let x0 = Instance::new().set_state(State::Ready);
let x1 = Instance::new().set_state(State::Creating);

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_bigtable_admin_v2::model::instance::Type;
let x0 = Instance::new().set_type(Type::Production);
let x1 = Instance::new().set_type(Type::Development);

pub fn set_edition<T: Into<Edition>>(self, v: T) -> Self

Sets the value of edition.

Example

use google_cloud_bigtable_admin_v2::model::instance::Edition;
let x0 = Instance::new().set_edition(Edition::Enterprise);
let x1 = Instance::new().set_edition(Edition::EnterprisePlus);

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 = Instance::new().set_labels([
    ("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 = Instance::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 = Instance::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Instance::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<bool>,

Sets the value of satisfies_pzs.

Example

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

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

where T: Into<bool>,

Sets or clears the value of satisfies_pzs.

Example

let x = Instance::new().set_or_clear_satisfies_pzs(Some(false));
let x = Instance::new().set_or_clear_satisfies_pzs(None::<bool>);

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

where T: Into<bool>,

Sets the value of satisfies_pzi.

Example

let x = Instance::new().set_satisfies_pzi(true);

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

where T: Into<bool>,

Sets or clears the value of satisfies_pzi.

Example

let x = Instance::new().set_or_clear_satisfies_pzi(Some(false));
let x = Instance::new().set_or_clear_satisfies_pzi(None::<bool>);

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

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

Sets the value of tags.

Example

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

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Instance

Returns the “default value” for a type.

impl Message for Instance

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Instance

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instance