Struct google_api_proto::google::cloud::aiplatform::v1::IndexEndpoint

pub struct IndexEndpoint {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub deployed_indexes: Vec<DeployedIndex>,
    pub etag: String,
    pub labels: BTreeMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub network: String,
    pub enable_private_service_connect: bool,
    pub private_service_connect_config: Option<PrivateServiceConnectConfig>,
    pub public_endpoint_enabled: bool,
    pub public_endpoint_domain_name: String,
    pub encryption_spec: Option<EncryptionSpec>,
}

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Fields

name: String

Output only. The resource name of the IndexEndpoint.

display_name: String

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

description: String

The description of the IndexEndpoint.

deployed_indexes: Vec<DeployedIndex>

Output only. The indexes deployed in this endpoint.

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 IndexEndpoints.

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 IndexEndpoint was created.

update_time: Option<Timestamp>

Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint’s DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.

network: String

Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.

Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.

[network][google.cloud.aiplatform.v1.IndexEndpoint.network] and [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config] are mutually exclusive.

Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in ‘12345’, and {network} is network name.

enable_private_service_connect: bool

👎Deprecated

Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.

Only one of the fields, [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect], can be set.

private_service_connect_config: Option<PrivateServiceConnectConfig>

Optional. Configuration for private service connect.

[network][google.cloud.aiplatform.v1.IndexEndpoint.network] and [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config] are mutually exclusive.

public_endpoint_enabled: bool

Optional. If true, the deployed index will be accessible through public endpoint.

public_endpoint_domain_name: String

Output only. If [public_endpoint_enabled][google.cloud.aiplatform.v1.IndexEndpoint.public_endpoint_enabled] is true, this field will be populated with the domain name to use for this index endpoint.

encryption_spec: Option<EncryptionSpec>

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

Trait Implementations

impl Clone for IndexEndpoint

fn clone(&self) -> IndexEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEndpoint

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

Formats the value using the given formatter.

impl Default for IndexEndpoint

fn default() -> Self

Returns the “default value” for a type.

impl Message for IndexEndpoint

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for IndexEndpoint

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