Struct google_api_proto::google::cloud::aiplatform::v1::Index

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: BTreeMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub index_stats: Option<IndexStats>,
    pub index_update_method: i32,
    pub encryption_spec: Option<EncryptionSpec>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
}

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

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][google.cloud.aiplatform.v1.Index.metadata_schema_uri].

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: BTreeMap<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: i32

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 index_update_method(&self) -> IndexUpdateMethod

Returns the enum value of index_update_method, or the default if the field is set to an invalid enum value.

pub fn set_index_update_method(&mut self, value: IndexUpdateMethod)

Sets index_update_method to the provided enum value.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for Index

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Index

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Index