Struct aws_sdk_cloudsearch::types::builders::LiteralOptionsBuilder

#[non_exhaustive]
pub struct LiteralOptionsBuilder { /* private fields */ }

A builder for LiteralOptions.

Implementations

impl LiteralOptionsBuilder

pub fn default_value(self, input: impl Into<String>) -> Self

A value to use for the field if the field isn’t specified for a document.

pub fn set_default_value(self, input: Option<String>) -> Self

A value to use for the field if the field isn’t specified for a document.

pub fn get_default_value(&self) -> &Option<String>

A value to use for the field if the field isn’t specified for a document.

pub fn source_field(self, input: impl Into<String>) -> Self

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

pub fn set_source_field(self, input: Option<String>) -> Self

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

pub fn get_source_field(&self) -> &Option<String>

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

pub fn facet_enabled(self, input: bool) -> Self

Whether facet information can be returned for the field.

pub fn set_facet_enabled(self, input: Option<bool>) -> Self

Whether facet information can be returned for the field.

pub fn get_facet_enabled(&self) -> &Option<bool>

Whether facet information can be returned for the field.

pub fn search_enabled(self, input: bool) -> Self

Whether the contents of the field are searchable.

pub fn set_search_enabled(self, input: Option<bool>) -> Self

Whether the contents of the field are searchable.

pub fn get_search_enabled(&self) -> &Option<bool>

Whether the contents of the field are searchable.

pub fn return_enabled(self, input: bool) -> Self

Whether the contents of the field can be returned in the search results.

pub fn set_return_enabled(self, input: Option<bool>) -> Self

Whether the contents of the field can be returned in the search results.

pub fn get_return_enabled(&self) -> &Option<bool>

Whether the contents of the field can be returned in the search results.

pub fn sort_enabled(self, input: bool) -> Self

Whether the field can be used to sort the search results.

pub fn set_sort_enabled(self, input: Option<bool>) -> Self

Whether the field can be used to sort the search results.

pub fn get_sort_enabled(&self) -> &Option<bool>

Whether the field can be used to sort the search results.

pub fn build(self) -> LiteralOptions

Consumes the builder and constructs a LiteralOptions.

Trait Implementations

impl Clone for LiteralOptionsBuilder

fn clone(&self) -> LiteralOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiteralOptionsBuilder

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

Formats the value using the given formatter.

impl Default for LiteralOptionsBuilder

fn default() -> LiteralOptionsBuilder

Returns the “default value” for a type.

impl PartialEq for LiteralOptionsBuilder

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LiteralOptionsBuilder