Struct IndexEndpoint 

#[non_exhaustive]
pub struct IndexEndpoint {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub deployed_indexes: Vec<DeployedIndex>,
    pub etag: String,
    pub labels: HashMap<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>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

Available on crate feature index-endpoint-service only.

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

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 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: HashMap<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 and 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 or enable_private_service_connect, can be set.

private_service_connect_config: Option<PrivateServiceConnectConfig>

Optional. Configuration for private service connect.

network and 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 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.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl IndexEndpoint

pub fn new() -> Self

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

Sets the value of name.

Example

let x = IndexEndpoint::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 = IndexEndpoint::new().set_display_name("example");

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

Sets the value of description.

Example

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

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

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

Sets the value of deployed_indexes.

Example

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

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

Sets the value of etag.

Example

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

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

Sets the value of network.

Example

let x = IndexEndpoint::new().set_network("example");

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

👎Deprecated

Sets the value of enable_private_service_connect.

Example

let x = IndexEndpoint::new().set_enable_private_service_connect(true);

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

where T: Into<PrivateServiceConnectConfig>,

Sets the value of private_service_connect_config.

Example

use google_cloud_aiplatform_v1::model::PrivateServiceConnectConfig;
let x = IndexEndpoint::new().set_private_service_connect_config(PrivateServiceConnectConfig::default()/* use setters */);

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

where T: Into<PrivateServiceConnectConfig>,

Sets or clears the value of private_service_connect_config.

Example

use google_cloud_aiplatform_v1::model::PrivateServiceConnectConfig;
let x = IndexEndpoint::new().set_or_clear_private_service_connect_config(Some(PrivateServiceConnectConfig::default()/* use setters */));
let x = IndexEndpoint::new().set_or_clear_private_service_connect_config(None::<PrivateServiceConnectConfig>);

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

Sets the value of public_endpoint_enabled.

Example

let x = IndexEndpoint::new().set_public_endpoint_enabled(true);

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

Sets the value of public_endpoint_domain_name.

Example

let x = IndexEndpoint::new().set_public_endpoint_domain_name("example");

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 = IndexEndpoint::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 = IndexEndpoint::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = IndexEndpoint::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 = IndexEndpoint::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 = IndexEndpoint::new().set_satisfies_pzi(true);

Trait Implementations

impl Clone for IndexEndpoint

fn clone(&self) -> IndexEndpoint

Returns a duplicate 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() -> IndexEndpoint

Returns the “default value” for a type.

impl Message for IndexEndpoint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for IndexEndpoint

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