@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchEntitiesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SearchEntitiesRequest() |
Modifier and Type | Method and Description |
---|---|
SearchEntitiesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getEntityTypes()
The entity types for which to search.
|
List<EntityFilter> |
getFilters()
Optional filter to apply to the search.
|
Integer |
getMaxResults()
The maximum number of results to return in the response.
|
Long |
getNamespaceVersion()
The version of the user's namespace.
|
String |
getNextToken()
The string that specifies the next page of results.
|
int |
hashCode() |
void |
setEntityTypes(Collection<String> entityTypes)
The entity types for which to search.
|
void |
setFilters(Collection<EntityFilter> filters)
Optional filter to apply to the search.
|
void |
setMaxResults(Integer maxResults)
The maximum number of results to return in the response.
|
void |
setNamespaceVersion(Long namespaceVersion)
The version of the user's namespace.
|
void |
setNextToken(String nextToken)
The string that specifies the next page of results.
|
String |
toString()
Returns a string representation of this object.
|
SearchEntitiesRequest |
withEntityTypes(Collection<String> entityTypes)
The entity types for which to search.
|
SearchEntitiesRequest |
withEntityTypes(EntityType... entityTypes)
The entity types for which to search.
|
SearchEntitiesRequest |
withEntityTypes(String... entityTypes)
The entity types for which to search.
|
SearchEntitiesRequest |
withFilters(Collection<EntityFilter> filters)
Optional filter to apply to the search.
|
SearchEntitiesRequest |
withFilters(EntityFilter... filters)
Optional filter to apply to the search.
|
SearchEntitiesRequest |
withMaxResults(Integer maxResults)
The maximum number of results to return in the response.
|
SearchEntitiesRequest |
withNamespaceVersion(Long namespaceVersion)
The version of the user's namespace.
|
SearchEntitiesRequest |
withNextToken(String nextToken)
The string that specifies the next page of results.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getEntityTypes()
The entity types for which to search.
EntityType
public void setEntityTypes(Collection<String> entityTypes)
The entity types for which to search.
entityTypes
- The entity types for which to search.EntityType
public SearchEntitiesRequest withEntityTypes(String... entityTypes)
The entity types for which to search.
NOTE: This method appends the values to the existing list (if any). Use
setEntityTypes(java.util.Collection)
or withEntityTypes(java.util.Collection)
if you want to
override the existing values.
entityTypes
- The entity types for which to search.EntityType
public SearchEntitiesRequest withEntityTypes(Collection<String> entityTypes)
The entity types for which to search.
entityTypes
- The entity types for which to search.EntityType
public SearchEntitiesRequest withEntityTypes(EntityType... entityTypes)
The entity types for which to search.
entityTypes
- The entity types for which to search.EntityType
public List<EntityFilter> getFilters()
Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters
on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For example, you can filter on the ID
of a property that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
public void setFilters(Collection<EntityFilter> filters)
Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters
on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
filters
- Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For example, you can filter on the ID
of a property that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
public SearchEntitiesRequest withFilters(EntityFilter... filters)
Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters
on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
or withFilters(java.util.Collection)
if you want to override
the existing values.
filters
- Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For example, you can filter on the ID
of a property that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
public SearchEntitiesRequest withFilters(Collection<EntityFilter> filters)
Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters
on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
filters
- Optional filter to apply to the search. Valid filters are NAME
NAMESPACE
,
SEMANTIC_TYPE_PATH
and REFERENCED_ENTITY_ID
. REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For example, you can filter on the ID
of a property that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
public void setNextToken(String nextToken)
The string that specifies the next page of results. Use this when you're paginating results.
nextToken
- The string that specifies the next page of results. Use this when you're paginating results.public String getNextToken()
The string that specifies the next page of results. Use this when you're paginating results.
public SearchEntitiesRequest withNextToken(String nextToken)
The string that specifies the next page of results. Use this when you're paginating results.
nextToken
- The string that specifies the next page of results. Use this when you're paginating results.public void setMaxResults(Integer maxResults)
The maximum number of results to return in the response.
maxResults
- The maximum number of results to return in the response.public Integer getMaxResults()
The maximum number of results to return in the response.
public SearchEntitiesRequest withMaxResults(Integer maxResults)
The maximum number of results to return in the response.
maxResults
- The maximum number of results to return in the response.public void setNamespaceVersion(Long namespaceVersion)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
namespaceVersion
- The version of the user's namespace. Defaults to the latest version of the user's namespace.public Long getNamespaceVersion()
The version of the user's namespace. Defaults to the latest version of the user's namespace.
public SearchEntitiesRequest withNamespaceVersion(Long namespaceVersion)
The version of the user's namespace. Defaults to the latest version of the user's namespace.
namespaceVersion
- The version of the user's namespace. Defaults to the latest version of the user's namespace.public String toString()
toString
in class Object
Object.toString()
public SearchEntitiesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()