Class DateOptions
java.lang.Object
software.amazon.awssdk.services.cloudsearch.model.DateOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DateOptions.Builder,
DateOptions>
@Generated("software.amazon.awssdk:codegen")
public final class DateOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DateOptions.Builder,DateOptions>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DateOptions.Builder
builder()
final String
A value to use for the field if the field isn't specified for a document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Whether facet information can be returned for the field.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
Whether the contents of the field can be returned in the search results.final Boolean
Whether the contents of the field are searchable.static Class
<? extends DateOptions.Builder> final Boolean
Whether the field can be used to sort the search results.final String
Returns the value of the SourceField property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
defaultValue
A value to use for the field if the field isn't specified for a document.- Returns:
- A value to use for the field if the field isn't specified for a document.
-
sourceField
Returns the value of the SourceField property for this object.- Returns:
- The value of the SourceField property for this object.
-
facetEnabled
Whether facet information can be returned for the field.
- Returns:
- Whether facet information can be returned for the field.
-
searchEnabled
Whether the contents of the field are searchable.
- Returns:
- Whether the contents of the field are searchable.
-
returnEnabled
Whether the contents of the field can be returned in the search results.
- Returns:
- Whether the contents of the field can be returned in the search results.
-
sortEnabled
Whether the field can be used to sort the search results.
- Returns:
- Whether the field can be used to sort the search results.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DateOptions.Builder,
DateOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-