1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
// 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 UpdateIndexInput {
/// <p>The identifier of the Amazon Q application connected to the index.</p>
pub application_id: ::std::option::Option<::std::string::String>,
/// <p>The identifier of the Amazon Q index.</p>
pub index_id: ::std::option::Option<::std::string::String>,
/// <p>The name of the Amazon Q index.</p>
pub display_name: ::std::option::Option<::std::string::String>,
/// <p>The description of the Amazon Q index.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.</p>
pub capacity_configuration: ::std::option::Option<crate::types::IndexCapacityConfiguration>,
/// <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
pub document_attribute_configurations: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttributeConfiguration>>,
}
impl UpdateIndexInput {
/// <p>The identifier of the Amazon Q application connected to the index.</p>
pub fn application_id(&self) -> ::std::option::Option<&str> {
self.application_id.as_deref()
}
/// <p>The identifier of the Amazon Q index.</p>
pub fn index_id(&self) -> ::std::option::Option<&str> {
self.index_id.as_deref()
}
/// <p>The name of the Amazon Q index.</p>
pub fn display_name(&self) -> ::std::option::Option<&str> {
self.display_name.as_deref()
}
/// <p>The description of the Amazon Q index.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.</p>
pub fn capacity_configuration(&self) -> ::std::option::Option<&crate::types::IndexCapacityConfiguration> {
self.capacity_configuration.as_ref()
}
/// <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</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 `.document_attribute_configurations.is_none()`.
pub fn document_attribute_configurations(&self) -> &[crate::types::DocumentAttributeConfiguration] {
self.document_attribute_configurations.as_deref().unwrap_or_default()
}
}
impl UpdateIndexInput {
/// Creates a new builder-style object to manufacture [`UpdateIndexInput`](crate::operation::update_index::UpdateIndexInput).
pub fn builder() -> crate::operation::update_index::builders::UpdateIndexInputBuilder {
crate::operation::update_index::builders::UpdateIndexInputBuilder::default()
}
}
/// A builder for [`UpdateIndexInput`](crate::operation::update_index::UpdateIndexInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateIndexInputBuilder {
pub(crate) application_id: ::std::option::Option<::std::string::String>,
pub(crate) index_id: ::std::option::Option<::std::string::String>,
pub(crate) display_name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) capacity_configuration: ::std::option::Option<crate::types::IndexCapacityConfiguration>,
pub(crate) document_attribute_configurations: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttributeConfiguration>>,
}
impl UpdateIndexInputBuilder {
/// <p>The identifier of the Amazon Q application connected to the index.</p>
/// This field is required.
pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.application_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the Amazon Q application connected to the index.</p>
pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.application_id = input;
self
}
/// <p>The identifier of the Amazon Q application connected to the index.</p>
pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
&self.application_id
}
/// <p>The identifier of the Amazon Q index.</p>
/// This field is required.
pub fn index_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.index_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the Amazon Q index.</p>
pub fn set_index_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.index_id = input;
self
}
/// <p>The identifier of the Amazon Q index.</p>
pub fn get_index_id(&self) -> &::std::option::Option<::std::string::String> {
&self.index_id
}
/// <p>The name of the Amazon Q index.</p>
pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.display_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the Amazon Q index.</p>
pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.display_name = input;
self
}
/// <p>The name of the Amazon Q index.</p>
pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
&self.display_name
}
/// <p>The description of the Amazon Q index.</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>The description of the Amazon Q index.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the Amazon Q index.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.</p>
pub fn capacity_configuration(mut self, input: crate::types::IndexCapacityConfiguration) -> Self {
self.capacity_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.</p>
pub fn set_capacity_configuration(mut self, input: ::std::option::Option<crate::types::IndexCapacityConfiguration>) -> Self {
self.capacity_configuration = input;
self
}
/// <p>The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.</p>
pub fn get_capacity_configuration(&self) -> &::std::option::Option<crate::types::IndexCapacityConfiguration> {
&self.capacity_configuration
}
/// Appends an item to `document_attribute_configurations`.
///
/// To override the contents of this collection use [`set_document_attribute_configurations`](Self::set_document_attribute_configurations).
///
/// <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
pub fn document_attribute_configurations(mut self, input: crate::types::DocumentAttributeConfiguration) -> Self {
let mut v = self.document_attribute_configurations.unwrap_or_default();
v.push(input);
self.document_attribute_configurations = ::std::option::Option::Some(v);
self
}
/// <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
pub fn set_document_attribute_configurations(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttributeConfiguration>>,
) -> Self {
self.document_attribute_configurations = input;
self
}
/// <p>Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes">Understanding document attributes</a>.</p>
pub fn get_document_attribute_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentAttributeConfiguration>> {
&self.document_attribute_configurations
}
/// Consumes the builder and constructs a [`UpdateIndexInput`](crate::operation::update_index::UpdateIndexInput).
pub fn build(self) -> ::std::result::Result<crate::operation::update_index::UpdateIndexInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_index::UpdateIndexInput {
application_id: self.application_id,
index_id: self.index_id,
display_name: self.display_name,
description: self.description,
capacity_configuration: self.capacity_configuration,
document_attribute_configurations: self.document_attribute_configurations,
})
}
}