@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FacetResult extends Object implements Serializable, Cloneable, StructuredPojo
The facet values for the documents in the response.
Constructor and Description |
---|
FacetResult() |
Modifier and Type | Method and Description |
---|---|
FacetResult |
clone() |
boolean |
equals(Object obj) |
String |
getDocumentAttributeKey()
The key for the facet values.
|
List<DocumentAttributeValueCountPair> |
getDocumentAttributeValueCountPairs()
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.
|
String |
getDocumentAttributeValueType()
The data type of the facet value.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDocumentAttributeKey(String documentAttributeKey)
The key for the facet values.
|
void |
setDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> 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.
|
void |
setDocumentAttributeValueType(String documentAttributeValueType)
The data type of the facet value.
|
String |
toString()
Returns a string representation of this object.
|
FacetResult |
withDocumentAttributeKey(String documentAttributeKey)
The key for the facet values.
|
FacetResult |
withDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> 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.
|
FacetResult |
withDocumentAttributeValueCountPairs(DocumentAttributeValueCountPair... 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.
|
FacetResult |
withDocumentAttributeValueType(DocumentAttributeValueType documentAttributeValueType)
The data type of the facet value.
|
FacetResult |
withDocumentAttributeValueType(String documentAttributeValueType)
The data type of the facet value.
|
public void setDocumentAttributeKey(String documentAttributeKey)
The key for the facet values. This is the same as the DocumentAttributeKey
provided in the query.
documentAttributeKey
- The key for the facet values. This is the same as the DocumentAttributeKey
provided in the
query.public String getDocumentAttributeKey()
The key for the facet values. This is the same as the DocumentAttributeKey
provided in the query.
DocumentAttributeKey
provided in the
query.public FacetResult withDocumentAttributeKey(String documentAttributeKey)
The key for the facet values. This is the same as the DocumentAttributeKey
provided in the query.
documentAttributeKey
- The key for the facet values. This is the same as the DocumentAttributeKey
provided in the
query.public void setDocumentAttributeValueType(String documentAttributeValueType)
The data type of the facet value. This is the same as the type defined for the index field when it was created.
documentAttributeValueType
- The data type of the facet value. This is the same as the type defined for the index field when it was
created.DocumentAttributeValueType
public String getDocumentAttributeValueType()
The data type of the facet value. This is the same as the type defined for the index field when it was created.
DocumentAttributeValueType
public FacetResult withDocumentAttributeValueType(String documentAttributeValueType)
The data type of the facet value. This is the same as the type defined for the index field when it was created.
documentAttributeValueType
- The data type of the facet value. This is the same as the type defined for the index field when it was
created.DocumentAttributeValueType
public FacetResult withDocumentAttributeValueType(DocumentAttributeValueType documentAttributeValueType)
The data type of the facet value. This is the same as the type defined for the index field when it was created.
documentAttributeValueType
- The data type of the facet value. This is the same as the type defined for the index field when it was
created.DocumentAttributeValueType
public List<DocumentAttributeValueCountPair> getDocumentAttributeValueCountPairs()
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.
public void setDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> 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.
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.public FacetResult withDocumentAttributeValueCountPairs(DocumentAttributeValueCountPair... 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.
NOTE: This method appends the values to the existing list (if any). Use
setDocumentAttributeValueCountPairs(java.util.Collection)
or
withDocumentAttributeValueCountPairs(java.util.Collection)
if you want to override the existing values.
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.public FacetResult withDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> 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.
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.public String toString()
toString
in class Object
Object.toString()
public FacetResult clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.