Struct Index 

#[non_exhaustive]
pub struct Index {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub metadata_schema_uri: String,
    pub metadata: Option<Value>,
    pub deployed_indexes: Vec<DeployedIndexRef>,
    pub etag: String,
    pub labels: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub index_stats: Option<IndexStats>,
    pub index_update_method: IndexUpdateMethod,
    pub encryption_spec: Option<EncryptionSpec>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

Available on crate feature index-service only.

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

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

Output only. The resource name of the Index.

display_name: String

Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description: String

The description of the Index.

metadata_schema_uri: String

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

metadata: Option<Value>

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

deployed_indexes: Vec<DeployedIndexRef>

Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

etag: String

Used to perform consistent read-modify-write updates. If not set, a blind “overwrite” update happens.

labels: HashMap<String, String>

The labels with user-defined metadata to organize your Indexes.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

create_time: Option<Timestamp>

Output only. Timestamp when this Index was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

index_stats: Option<IndexStats>

Output only. Stats of the index resource.

index_update_method: IndexUpdateMethod

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

encryption_spec: Option<EncryptionSpec>

Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl Index

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

Sets the value of display_name.

Example

let x = Index::new().set_display_name("example");

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

Sets the value of description.

Example

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

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

Sets the value of metadata_schema_uri.

Example

let x = Index::new().set_metadata_schema_uri("example");

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

where T: Into<Value>,

Sets the value of metadata.

Example

use wkt::Value;
let x = Index::new().set_metadata(Value::default()/* use setters */);

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

where T: Into<Value>,

Sets or clears the value of metadata.

Example

use wkt::Value;
let x = Index::new().set_or_clear_metadata(Some(Value::default()/* use setters */));
let x = Index::new().set_or_clear_metadata(None::<Value>);

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

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

Sets the value of deployed_indexes.

Example

use google_cloud_aiplatform_v1::model::DeployedIndexRef;
let x = Index::new()
    .set_deployed_indexes([
        DeployedIndexRef::default()/* use setters */,
        DeployedIndexRef::default()/* use (different) setters */,
    ]);

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

Sets the value of etag.

Example

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

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

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

where T: Into<IndexStats>,

Sets the value of index_stats.

Example

use google_cloud_aiplatform_v1::model::IndexStats;
let x = Index::new().set_index_stats(IndexStats::default()/* use setters */);

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

where T: Into<IndexStats>,

Sets or clears the value of index_stats.

Example

use google_cloud_aiplatform_v1::model::IndexStats;
let x = Index::new().set_or_clear_index_stats(Some(IndexStats::default()/* use setters */));
let x = Index::new().set_or_clear_index_stats(None::<IndexStats>);

pub fn set_index_update_method<T: Into<IndexUpdateMethod>>(self, v: T) -> Self

Sets the value of index_update_method.

Example

use google_cloud_aiplatform_v1::model::index::IndexUpdateMethod;
let x0 = Index::new().set_index_update_method(IndexUpdateMethod::BatchUpdate);
let x1 = Index::new().set_index_update_method(IndexUpdateMethod::StreamUpdate);

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

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = Index::new().set_encryption_spec(EncryptionSpec::default()/* use setters */);

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

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = Index::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = Index::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

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

Sets the value of satisfies_pzs.

Example

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

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

Sets the value of satisfies_pzi.

Example

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

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl Message for Index

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Index

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