Struct aws_sdk_cloudsearch::types::DateOptions
source · #[non_exhaustive]pub struct DateOptions {
pub default_value: Option<String>,
pub source_field: Option<String>,
pub facet_enabled: Option<bool>,
pub search_enabled: Option<bool>,
pub return_enabled: Option<bool>,
pub sort_enabled: Option<bool>,
}
Expand description
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType
specifies the field is of type date
. All options are enabled by default.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.default_value: Option<String>
A value to use for the field if the field isn’t specified for a document.
source_field: 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
.
facet_enabled: Option<bool>
Whether facet information can be returned for the field.
search_enabled: Option<bool>
Whether the contents of the field are searchable.
return_enabled: Option<bool>
Whether the contents of the field can be returned in the search results.
sort_enabled: Option<bool>
Whether the field can be used to sort the search results.
Implementations§
source§impl DateOptions
impl DateOptions
sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
A value to use for the field if the field isn’t specified for a document.
sourcepub fn source_field(&self) -> Option<&str>
pub fn source_field(&self) -> Option<&str>
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
.
sourcepub fn facet_enabled(&self) -> Option<bool>
pub fn facet_enabled(&self) -> Option<bool>
Whether facet information can be returned for the field.
sourcepub fn search_enabled(&self) -> Option<bool>
pub fn search_enabled(&self) -> Option<bool>
Whether the contents of the field are searchable.
sourcepub fn return_enabled(&self) -> Option<bool>
pub fn return_enabled(&self) -> Option<bool>
Whether the contents of the field can be returned in the search results.
sourcepub fn sort_enabled(&self) -> Option<bool>
pub fn sort_enabled(&self) -> Option<bool>
Whether the field can be used to sort the search results.
source§impl DateOptions
impl DateOptions
sourcepub fn builder() -> DateOptionsBuilder
pub fn builder() -> DateOptionsBuilder
Creates a new builder-style object to manufacture DateOptions
.
Trait Implementations§
source§impl Clone for DateOptions
impl Clone for DateOptions
source§fn clone(&self) -> DateOptions
fn clone(&self) -> DateOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DateOptions
impl Debug for DateOptions
source§impl PartialEq for DateOptions
impl PartialEq for DateOptions
source§fn eq(&self, other: &DateOptions) -> bool
fn eq(&self, other: &DateOptions) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DateOptions
Auto Trait Implementations§
impl Freeze for DateOptions
impl RefUnwindSafe for DateOptions
impl Send for DateOptions
impl Sync for DateOptions
impl Unpin for DateOptions
impl UnwindSafe for DateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more