@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AttributeSuggestionsGetConfig extends Object implements Serializable, Cloneable, StructuredPojo
Provides the configuration information for the document fields/attributes that you want to base query suggestions on.
Constructor and Description |
---|
AttributeSuggestionsGetConfig() |
Modifier and Type | Method and Description |
---|---|
AttributeSuggestionsGetConfig |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAdditionalResponseAttributes()
The list of additional document field/attribute keys or field names to include in the response.
|
AttributeFilter |
getAttributeFilter()
Filters the search results based on document fields/attributes.
|
List<String> |
getSuggestionAttributes()
The list of document field/attribute keys or field names to use for query suggestions.
|
UserContext |
getUserContext()
Applies user context filtering so that only users who are given access to certain documents see these document in
their search results.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalResponseAttributes(Collection<String> additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response.
|
void |
setAttributeFilter(AttributeFilter attributeFilter)
Filters the search results based on document fields/attributes.
|
void |
setSuggestionAttributes(Collection<String> suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions.
|
void |
setUserContext(UserContext userContext)
Applies user context filtering so that only users who are given access to certain documents see these document in
their search results.
|
String |
toString()
Returns a string representation of this object.
|
AttributeSuggestionsGetConfig |
withAdditionalResponseAttributes(Collection<String> additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response.
|
AttributeSuggestionsGetConfig |
withAdditionalResponseAttributes(String... additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response.
|
AttributeSuggestionsGetConfig |
withAttributeFilter(AttributeFilter attributeFilter)
Filters the search results based on document fields/attributes.
|
AttributeSuggestionsGetConfig |
withSuggestionAttributes(Collection<String> suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions.
|
AttributeSuggestionsGetConfig |
withSuggestionAttributes(String... suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions.
|
AttributeSuggestionsGetConfig |
withUserContext(UserContext userContext)
Applies user context filtering so that only users who are given access to certain documents see these document in
their search results.
|
public List<String> getSuggestionAttributes()
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
public void setSuggestionAttributes(Collection<String> suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
suggestionAttributes
- The list of document field/attribute keys or field names to use for query suggestions. If the content
within any of the fields match what your user starts typing as their query, then the field content is
returned as a query suggestion.public AttributeSuggestionsGetConfig withSuggestionAttributes(String... suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
NOTE: This method appends the values to the existing list (if any). Use
setSuggestionAttributes(java.util.Collection)
or withSuggestionAttributes(java.util.Collection)
if you want to override the existing values.
suggestionAttributes
- The list of document field/attribute keys or field names to use for query suggestions. If the content
within any of the fields match what your user starts typing as their query, then the field content is
returned as a query suggestion.public AttributeSuggestionsGetConfig withSuggestionAttributes(Collection<String> suggestionAttributes)
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
suggestionAttributes
- The list of document field/attribute keys or field names to use for query suggestions. If the content
within any of the fields match what your user starts typing as their query, then the field content is
returned as a query suggestion.public List<String> getAdditionalResponseAttributes()
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
public void setAdditionalResponseAttributes(Collection<String> additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
additionalResponseAttributes
- The list of additional document field/attribute keys or field names to include in the response. You can
use additional fields to provide extra information in the response. Additional fields are not used to
based suggestions on.public AttributeSuggestionsGetConfig withAdditionalResponseAttributes(String... additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
NOTE: This method appends the values to the existing list (if any). Use
setAdditionalResponseAttributes(java.util.Collection)
or
withAdditionalResponseAttributes(java.util.Collection)
if you want to override the existing values.
additionalResponseAttributes
- The list of additional document field/attribute keys or field names to include in the response. You can
use additional fields to provide extra information in the response. Additional fields are not used to
based suggestions on.public AttributeSuggestionsGetConfig withAdditionalResponseAttributes(Collection<String> additionalResponseAttributes)
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
additionalResponseAttributes
- The list of additional document field/attribute keys or field names to include in the response. You can
use additional fields to provide extra information in the response. Additional fields are not used to
based suggestions on.public void setAttributeFilter(AttributeFilter attributeFilter)
Filters the search results based on document fields/attributes.
attributeFilter
- Filters the search results based on document fields/attributes.public AttributeFilter getAttributeFilter()
Filters the search results based on document fields/attributes.
public AttributeSuggestionsGetConfig withAttributeFilter(AttributeFilter attributeFilter)
Filters the search results based on document fields/attributes.
attributeFilter
- Filters the search results based on document fields/attributes.public void setUserContext(UserContext userContext)
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
userContext
- Applies user context filtering so that only users who are given access to certain documents see these
document in their search results.public UserContext getUserContext()
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
public AttributeSuggestionsGetConfig withUserContext(UserContext userContext)
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
userContext
- Applies user context filtering so that only users who are given access to certain documents see these
document in their search results.public String toString()
toString
in class Object
Object.toString()
public AttributeSuggestionsGetConfig clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.