Class FacetResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FacetResult.Builder,
FacetResult>
The facet values for the documents in the response.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FacetResult.Builder
builder()
final String
The key for the facet values.An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.The data type of the facet value.final String
The data type of the facet value.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DocumentAttributeValueCountPairs property.final int
hashCode()
static Class
<? extends FacetResult.Builder> 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
-
documentAttributeKey
The key for the facet values. This is the same as the
DocumentAttributeKey
provided in the query.- Returns:
- The key for the facet values. This is the same as the
DocumentAttributeKey
provided in the query.
-
documentAttributeValueType
The data type of the facet value. This is the same as the type defined for the index field when it was created.
If the service returns an enum value that is not available in the current SDK version,
documentAttributeValueType
will returnDocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentAttributeValueTypeAsString()
.- Returns:
- The data type of the facet value. This is the same as the type defined for the index field when it was created.
- See Also:
-
documentAttributeValueTypeAsString
The data type of the facet value. This is the same as the type defined for the index field when it was created.
If the service returns an enum value that is not available in the current SDK version,
documentAttributeValueType
will returnDocumentAttributeValueType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentAttributeValueTypeAsString()
.- Returns:
- The data type of the facet value. This is the same as the type defined for the index field when it was created.
- See Also:
-
hasDocumentAttributeValueCountPairs
public final boolean hasDocumentAttributeValueCountPairs()For responses, this returns true if the service returned a value for the DocumentAttributeValueCountPairs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
documentAttributeValueCountPairs
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDocumentAttributeValueCountPairs()
method.- Returns:
- An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
-
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<FacetResult.Builder,
FacetResult> - 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
-