Struct CollectionDetail

#[non_exhaustive]
pub struct CollectionDetail {

    pub id: Option<String>,
    pub name: Option<String>,
    pub status: Option<CollectionStatus>,
    pub type: Option<CollectionType>,
    pub description: Option<String>,
    pub arn: Option<String>,
    pub kms_key_arn: Option<String>,
    pub standby_replicas: Option<StandbyReplicas>,
    pub created_date: Option<i64>,
    pub last_modified_date: Option<i64>,
    pub collection_endpoint: Option<String>,
    pub dashboard_endpoint: Option<String>,
    pub failure_code: Option<String>,
    pub failure_message: Option<String>,
}

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

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: Option<String>

A unique identifier for the collection.

name: Option<String>

The name of the collection.

status: Option<CollectionStatus>

The current status of the collection.

type: Option<CollectionType>

The type of collection.

description: Option<String>

A description of the collection.

arn: Option<String>

The Amazon Resource Name (ARN) of the collection.

kms_key_arn: Option<String>

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

standby_replicas: Option<StandbyReplicas>

Details about an OpenSearch Serverless collection.

created_date: Option<i64>

The Epoch time when the collection was created.

last_modified_date: Option<i64>

The date and time when the collection was last modified.

collection_endpoint: Option<String>

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

dashboard_endpoint: Option<String>

Collection-specific endpoint used to access OpenSearch Dashboards.

failure_code: Option<String>

A failure code associated with the request.

failure_message: Option<String>

A message associated with the failure code.

Implementations

impl CollectionDetail

pub fn id(&self) -> Option<&str>

A unique identifier for the collection.

pub fn name(&self) -> Option<&str>

The name of the collection.

pub fn status(&self) -> Option<&CollectionStatus>

The current status of the collection.

pub fn type(&self) -> Option<&CollectionType>

The type of collection.

pub fn description(&self) -> Option<&str>

A description of the collection.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the collection.

pub fn kms_key_arn(&self) -> Option<&str>

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

pub fn standby_replicas(&self) -> Option<&StandbyReplicas>

Details about an OpenSearch Serverless collection.

pub fn created_date(&self) -> Option<i64>

The Epoch time when the collection was created.

pub fn last_modified_date(&self) -> Option<i64>

The date and time when the collection was last modified.

pub fn collection_endpoint(&self) -> Option<&str>

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

pub fn dashboard_endpoint(&self) -> Option<&str>

Collection-specific endpoint used to access OpenSearch Dashboards.

pub fn failure_code(&self) -> Option<&str>

A failure code associated with the request.

pub fn failure_message(&self) -> Option<&str>

A message associated with the failure code.

impl CollectionDetail

pub fn builder() -> CollectionDetailBuilder

Creates a new builder-style object to manufacture CollectionDetail.

Trait Implementations

impl Clone for CollectionDetail

fn clone(&self) -> CollectionDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionDetail

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

Formats the value using the given formatter.

impl PartialEq for CollectionDetail

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

Tests for self and other values to be equal, and is used by ==.

const 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 CollectionDetail