aws-sdk-opensearchserverless 1.102.0

AWS SDK for OpenSearch Service Serverless
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateCollectionInput {
    /// <p>Name of the collection.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The type of collection.</p>
    pub r#type: ::std::option::Option<crate::types::CollectionType>,
    /// <p>Description of the collection.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    /// <p>Indicates whether standby replicas should be used for a collection.</p>
    pub standby_replicas: ::std::option::Option<crate::types::StandbyReplicas>,
    /// <p>Configuration options for vector search capabilities in the collection.</p>
    pub vector_options: ::std::option::Option<crate::types::VectorOptions>,
    /// <p>The name of the collection group to associate with the collection.</p>
    pub collection_group_name: ::std::option::Option<::std::string::String>,
    /// <p>Encryption settings for the collection.</p>
    pub encryption_config: ::std::option::Option<crate::types::EncryptionConfig>,
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl CreateCollectionInput {
    /// <p>Name of the collection.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The type of collection.</p>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::CollectionType> {
        self.r#type.as_ref()
    }
    /// <p>Description of the collection.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
    /// <p>Indicates whether standby replicas should be used for a collection.</p>
    pub fn standby_replicas(&self) -> ::std::option::Option<&crate::types::StandbyReplicas> {
        self.standby_replicas.as_ref()
    }
    /// <p>Configuration options for vector search capabilities in the collection.</p>
    pub fn vector_options(&self) -> ::std::option::Option<&crate::types::VectorOptions> {
        self.vector_options.as_ref()
    }
    /// <p>The name of the collection group to associate with the collection.</p>
    pub fn collection_group_name(&self) -> ::std::option::Option<&str> {
        self.collection_group_name.as_deref()
    }
    /// <p>Encryption settings for the collection.</p>
    pub fn encryption_config(&self) -> ::std::option::Option<&crate::types::EncryptionConfig> {
        self.encryption_config.as_ref()
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl CreateCollectionInput {
    /// Creates a new builder-style object to manufacture [`CreateCollectionInput`](crate::operation::create_collection::CreateCollectionInput).
    pub fn builder() -> crate::operation::create_collection::builders::CreateCollectionInputBuilder {
        crate::operation::create_collection::builders::CreateCollectionInputBuilder::default()
    }
}

/// A builder for [`CreateCollectionInput`](crate::operation::create_collection::CreateCollectionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateCollectionInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) r#type: ::std::option::Option<crate::types::CollectionType>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    pub(crate) standby_replicas: ::std::option::Option<crate::types::StandbyReplicas>,
    pub(crate) vector_options: ::std::option::Option<crate::types::VectorOptions>,
    pub(crate) collection_group_name: ::std::option::Option<::std::string::String>,
    pub(crate) encryption_config: ::std::option::Option<crate::types::EncryptionConfig>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreateCollectionInputBuilder {
    /// <p>Name of the collection.</p>
    /// This field is required.
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Name of the collection.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>Name of the collection.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The type of collection.</p>
    pub fn r#type(mut self, input: crate::types::CollectionType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of collection.</p>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::CollectionType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>The type of collection.</p>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::CollectionType> {
        &self.r#type
    }
    /// <p>Description of the collection.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Description of the collection.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>Description of the collection.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// <p>Indicates whether standby replicas should be used for a collection.</p>
    pub fn standby_replicas(mut self, input: crate::types::StandbyReplicas) -> Self {
        self.standby_replicas = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether standby replicas should be used for a collection.</p>
    pub fn set_standby_replicas(mut self, input: ::std::option::Option<crate::types::StandbyReplicas>) -> Self {
        self.standby_replicas = input;
        self
    }
    /// <p>Indicates whether standby replicas should be used for a collection.</p>
    pub fn get_standby_replicas(&self) -> &::std::option::Option<crate::types::StandbyReplicas> {
        &self.standby_replicas
    }
    /// <p>Configuration options for vector search capabilities in the collection.</p>
    pub fn vector_options(mut self, input: crate::types::VectorOptions) -> Self {
        self.vector_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration options for vector search capabilities in the collection.</p>
    pub fn set_vector_options(mut self, input: ::std::option::Option<crate::types::VectorOptions>) -> Self {
        self.vector_options = input;
        self
    }
    /// <p>Configuration options for vector search capabilities in the collection.</p>
    pub fn get_vector_options(&self) -> &::std::option::Option<crate::types::VectorOptions> {
        &self.vector_options
    }
    /// <p>The name of the collection group to associate with the collection.</p>
    pub fn collection_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.collection_group_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the collection group to associate with the collection.</p>
    pub fn set_collection_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.collection_group_name = input;
        self
    }
    /// <p>The name of the collection group to associate with the collection.</p>
    pub fn get_collection_group_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.collection_group_name
    }
    /// <p>Encryption settings for the collection.</p>
    pub fn encryption_config(mut self, input: crate::types::EncryptionConfig) -> Self {
        self.encryption_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>Encryption settings for the collection.</p>
    pub fn set_encryption_config(mut self, input: ::std::option::Option<crate::types::EncryptionConfig>) -> Self {
        self.encryption_config = input;
        self
    }
    /// <p>Encryption settings for the collection.</p>
    pub fn get_encryption_config(&self) -> &::std::option::Option<crate::types::EncryptionConfig> {
        &self.encryption_config
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`CreateCollectionInput`](crate::operation::create_collection::CreateCollectionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_collection::CreateCollectionInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_collection::CreateCollectionInput {
            name: self.name,
            r#type: self.r#type,
            description: self.description,
            tags: self.tags,
            standby_replicas: self.standby_replicas,
            vector_options: self.vector_options,
            collection_group_name: self.collection_group_name,
            encryption_config: self.encryption_config,
            client_token: self.client_token,
        })
    }
}