Struct google_api_proto::google::cloud::visionai::v1::Index

pub struct Index {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub deployed_indexes: Vec<DeployedIndexReference>,
    pub satisfies_pzs: Option<bool>,
    pub satisfies_pzi: Option<bool>,
    pub asset_filter: Option<AssetFilter>,
}

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

Fields

name: String

Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

display_name: String

Optional. Optional user-specified display name of the index.

description: String

Optional. Optional description of the index.

state: i32

Output only. State of the index.

create_time: Option<Timestamp>

Output only. The create timestamp.

update_time: Option<Timestamp>

Output only. The update timestamp.

deployed_indexes: Vec<DeployedIndexReference>

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

satisfies_pzs: Option<bool>

Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn’t.

satisfies_pzi: Option<bool>

Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn’t.

asset_filter: Option<AssetFilter>

Specifies how assets are selected for this index. Default to entire_corpus if unspecified. Behavior in UpdateIndex: if update_mask includes one of the asset_filter field paths, the index will be rebuilt with latest assets, including their analyzed data and annotations.

Implementations

impl Index

pub fn state(&self) -> State

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

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn satisfies_pzs(&self) -> bool

Returns the value of satisfies_pzs, or the default value if satisfies_pzs is unset.

pub fn satisfies_pzi(&self) -> bool

Returns the value of satisfies_pzi, or the default value if satisfies_pzi is unset.

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