Struct gapi_grpc::google::cloud::aiplatform::v1beta1::DeployedIndex

pub struct DeployedIndex {
    pub id: String,
    pub index: String,
    pub display_name: String,
    pub create_time: Option<Timestamp>,
    pub private_endpoints: Option<IndexPrivateEndpoints>,
    pub index_sync_time: Option<Timestamp>,
    pub automatic_resources: Option<AutomaticResources>,
    pub enable_access_logging: bool,
    pub deployed_index_auth_config: Option<DeployedIndexAuthConfig>,
}

A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.

Fields

id: String

Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.

index: String

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex’s “original” Index.

display_name: String

The display name of the DeployedIndex. If not provided upon creation, the Index’s display_name is used.

create_time: Option<Timestamp>

Output only. Timestamp when the DeployedIndex was created.

private_endpoints: Option<IndexPrivateEndpoints>

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is configured.

index_sync_time: Option<Timestamp>

Output only. The DeployedIndex may depend on various data on its original Index. Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect this changes. If this timestamp’s value is at least the [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which not), one must [list][Operations.ListOperations] [Operations][Operation] [working][Operation.name] on the original Index. Only the successfully completed Operations with [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] equal or before this sync time are contained in this DeployedIndex.

automatic_resources: Option<AutomaticResources>

Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.

The user is billed for the resources (at least their minimal amount) even if the DeployedIndex receives no traffic.

enable_access_logging: bool

Optional. If true, private endpoint’s access logs are sent to StackDriver Logging.

These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest.

Note that Stackdriver logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.

deployed_index_auth_config: Option<DeployedIndexAuthConfig>

Optional. If set, the authentication is enabled for the private endpoint.

Trait Implementations

impl Clone for DeployedIndex

fn clone(&self) -> DeployedIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeployedIndex

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

Formats the value using the given formatter.

impl Default for DeployedIndex

fn default() -> DeployedIndex

Returns the “default value” for a type.

impl Message for DeployedIndex

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<DeployedIndex> for DeployedIndex

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

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

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

This method tests for !=.

impl StructuralPartialEq for DeployedIndex