Struct DeployedIndex 

#[non_exhaustive]
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 dedicated_resources: Option<DedicatedResources>,
    pub enable_access_logging: bool,
    pub enable_datapoint_upsert_logging: bool,
    pub deployed_index_auth_config: Option<DeployedIndexAuthConfig>,
    pub reserved_ip_ranges: Vec<String>,
    pub deployment_group: String,
    pub deployment_tier: DeploymentTier,
    pub psc_automation_configs: Vec<PSCAutomationConfig>,
    /* private fields */
}

Available on crate feature index-endpoint-service only.

A deployment of an Index. IndexEndpoints contain one or more 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.

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 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 these changes. If this timestamp’s value is at least the 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 it does not), one must [list][google.longrunning.Operations.ListOperations] the operations that are running on the original Index. Only the successfully completed Operations with 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 2 (we don’t provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.

dedicated_resources: Option<DedicatedResources>

Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don’t provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.

Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard.

Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard.

Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32.

n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency.

enable_access_logging: bool

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

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

Note that 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.

enable_datapoint_upsert_logging: bool

Optional. If true, logs to Cloud Logging errors relating to datapoint upserts.

Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time.

Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.

deployed_index_auth_config: Option<DeployedIndexAuthConfig>

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

reserved_ip_ranges: Vec<String>

Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.

If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network.

The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: [‘vertex-ai-ip-range’].

For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.

deployment_group: String

Optional. The deployment group can be no longer than 64 characters (eg: ‘test’, ‘prod’). If not set, we will use the ‘default’ deployment group.

Creating deployment_groups with reserved_ip_ranges is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except ‘default’) can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed.

Note: we only support up to 5 deployment groups(not including ‘default’).

deployment_tier: DeploymentTier

Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.

psc_automation_configs: Vec<PSCAutomationConfig>

Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints.

Implementations

impl DeployedIndex

pub fn new() -> Self

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

Sets the value of id.

Example

let x = DeployedIndex::new().set_id("example");

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

Sets the value of index.

Example

let x = DeployedIndex::new().set_index("example");

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

Sets the value of display_name.

Example

let x = DeployedIndex::new().set_display_name("example");

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

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

where T: Into<IndexPrivateEndpoints>,

Sets the value of private_endpoints.

Example

use google_cloud_aiplatform_v1::model::IndexPrivateEndpoints;
let x = DeployedIndex::new().set_private_endpoints(IndexPrivateEndpoints::default()/* use setters */);

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

where T: Into<IndexPrivateEndpoints>,

Sets or clears the value of private_endpoints.

Example

use google_cloud_aiplatform_v1::model::IndexPrivateEndpoints;
let x = DeployedIndex::new().set_or_clear_private_endpoints(Some(IndexPrivateEndpoints::default()/* use setters */));
let x = DeployedIndex::new().set_or_clear_private_endpoints(None::<IndexPrivateEndpoints>);

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

where T: Into<Timestamp>,

Sets the value of index_sync_time.

Example

use wkt::Timestamp;
let x = DeployedIndex::new().set_index_sync_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of index_sync_time.

Example

use wkt::Timestamp;
let x = DeployedIndex::new().set_or_clear_index_sync_time(Some(Timestamp::default()/* use setters */));
let x = DeployedIndex::new().set_or_clear_index_sync_time(None::<Timestamp>);

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

where T: Into<AutomaticResources>,

Sets the value of automatic_resources.

Example

use google_cloud_aiplatform_v1::model::AutomaticResources;
let x = DeployedIndex::new().set_automatic_resources(AutomaticResources::default()/* use setters */);

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

where T: Into<AutomaticResources>,

Sets or clears the value of automatic_resources.

Example

use google_cloud_aiplatform_v1::model::AutomaticResources;
let x = DeployedIndex::new().set_or_clear_automatic_resources(Some(AutomaticResources::default()/* use setters */));
let x = DeployedIndex::new().set_or_clear_automatic_resources(None::<AutomaticResources>);

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

where T: Into<DedicatedResources>,

Sets the value of dedicated_resources.

Example

use google_cloud_aiplatform_v1::model::DedicatedResources;
let x = DeployedIndex::new().set_dedicated_resources(DedicatedResources::default()/* use setters */);

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

where T: Into<DedicatedResources>,

Sets or clears the value of dedicated_resources.

Example

use google_cloud_aiplatform_v1::model::DedicatedResources;
let x = DeployedIndex::new().set_or_clear_dedicated_resources(Some(DedicatedResources::default()/* use setters */));
let x = DeployedIndex::new().set_or_clear_dedicated_resources(None::<DedicatedResources>);

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

Sets the value of enable_access_logging.

Example

let x = DeployedIndex::new().set_enable_access_logging(true);

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

Sets the value of enable_datapoint_upsert_logging.

Example

let x = DeployedIndex::new().set_enable_datapoint_upsert_logging(true);

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

where T: Into<DeployedIndexAuthConfig>,

Sets the value of deployed_index_auth_config.

Example

use google_cloud_aiplatform_v1::model::DeployedIndexAuthConfig;
let x = DeployedIndex::new().set_deployed_index_auth_config(DeployedIndexAuthConfig::default()/* use setters */);

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

where T: Into<DeployedIndexAuthConfig>,

Sets or clears the value of deployed_index_auth_config.

Example

use google_cloud_aiplatform_v1::model::DeployedIndexAuthConfig;
let x = DeployedIndex::new().set_or_clear_deployed_index_auth_config(Some(DeployedIndexAuthConfig::default()/* use setters */));
let x = DeployedIndex::new().set_or_clear_deployed_index_auth_config(None::<DeployedIndexAuthConfig>);

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

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

Sets the value of reserved_ip_ranges.

Example

let x = DeployedIndex::new().set_reserved_ip_ranges(["a", "b", "c"]);

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

Sets the value of deployment_group.

Example

let x = DeployedIndex::new().set_deployment_group("example");

pub fn set_deployment_tier<T: Into<DeploymentTier>>(self, v: T) -> Self

Sets the value of deployment_tier.

Example

use google_cloud_aiplatform_v1::model::deployed_index::DeploymentTier;
let x0 = DeployedIndex::new().set_deployment_tier(DeploymentTier::Storage);

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

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

Sets the value of psc_automation_configs.

Example

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

Trait Implementations

impl Clone for DeployedIndex

fn clone(&self) -> DeployedIndex

Returns a duplicate of the value.

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 typename() -> &'static str

The typename of this message.

impl PartialEq for DeployedIndex

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