@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DocumentAttributeValueCountPair extends Object implements Serializable, Cloneable, StructuredPojo
Provides the count of documents that match a particular document attribute or field when doing a faceted search.
Constructor and Description |
---|
DocumentAttributeValueCountPair() |
Modifier and Type | Method and Description |
---|---|
DocumentAttributeValueCountPair |
clone() |
boolean |
equals(Object obj) |
Integer |
getCount()
The number of documents in the response that have the attribute/field value for the key.
|
DocumentAttributeValue |
getDocumentAttributeValue()
The value of the attribute/field.
|
List<FacetResult> |
getFacetResults()
Contains the results of a document attribute/field that is a nested facet.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCount(Integer count)
The number of documents in the response that have the attribute/field value for the key.
|
void |
setDocumentAttributeValue(DocumentAttributeValue documentAttributeValue)
The value of the attribute/field.
|
void |
setFacetResults(Collection<FacetResult> facetResults)
Contains the results of a document attribute/field that is a nested facet.
|
String |
toString()
Returns a string representation of this object.
|
DocumentAttributeValueCountPair |
withCount(Integer count)
The number of documents in the response that have the attribute/field value for the key.
|
DocumentAttributeValueCountPair |
withDocumentAttributeValue(DocumentAttributeValue documentAttributeValue)
The value of the attribute/field.
|
DocumentAttributeValueCountPair |
withFacetResults(Collection<FacetResult> facetResults)
Contains the results of a document attribute/field that is a nested facet.
|
DocumentAttributeValueCountPair |
withFacetResults(FacetResult... facetResults)
Contains the results of a document attribute/field that is a nested facet.
|
public void setDocumentAttributeValue(DocumentAttributeValue documentAttributeValue)
The value of the attribute/field. For example, "HR".
documentAttributeValue
- The value of the attribute/field. For example, "HR".public DocumentAttributeValue getDocumentAttributeValue()
The value of the attribute/field. For example, "HR".
public DocumentAttributeValueCountPair withDocumentAttributeValue(DocumentAttributeValue documentAttributeValue)
The value of the attribute/field. For example, "HR".
documentAttributeValue
- The value of the attribute/field. For example, "HR".public void setCount(Integer count)
The number of documents in the response that have the attribute/field value for the key.
count
- The number of documents in the response that have the attribute/field value for the key.public Integer getCount()
The number of documents in the response that have the attribute/field value for the key.
public DocumentAttributeValueCountPair withCount(Integer count)
The number of documents in the response that have the attribute/field value for the key.
count
- The number of documents in the response that have the attribute/field value for the key.public List<FacetResult> getFacetResults()
Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains
the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
FacetResult
contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
public void setFacetResults(Collection<FacetResult> facetResults)
Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains
the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
facetResults
- Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
public DocumentAttributeValueCountPair withFacetResults(FacetResult... facetResults)
Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains
the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
NOTE: This method appends the values to the existing list (if any). Use
setFacetResults(java.util.Collection)
or withFacetResults(java.util.Collection)
if you want to
override the existing values.
facetResults
- Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
public DocumentAttributeValueCountPair withFacetResults(Collection<FacetResult> facetResults)
Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains
the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
facetResults
- Contains the results of a document attribute/field that is a nested facet. A FacetResult
contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
public String toString()
toString
in class Object
Object.toString()
public DocumentAttributeValueCountPair clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.