com.amazonaws.services.datazone.model

Class SearchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datazone.model.SearchRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchRequest()

Method Summary

Modifier and Type	Method and Description
SearchRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAdditionalAttributes() Specifies additional attributes for the Search action.
String	getDomainIdentifier() The identifier of the Amazon DataZone domain.
FilterClause	getFilters() Specifies the search filters.
Integer	getMaxResults() The maximum number of results to return in a single call to Search.
String	getNextToken() When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.
String	getOwningProjectIdentifier() The identifier of the owning project specified for the search.
List<SearchInItem>	getSearchIn() The details of the search.
String	getSearchScope() The scope of the search.
String	getSearchText() Specifies the text for which to search.
SearchSort	getSort() Specifies the way in which the search results are to be sorted.
int	hashCode()
void	setAdditionalAttributes(Collection<String> additionalAttributes) Specifies additional attributes for the Search action.
void	setDomainIdentifier(String domainIdentifier) The identifier of the Amazon DataZone domain.
void	setFilters(FilterClause filters) Specifies the search filters.
void	setMaxResults(Integer maxResults) The maximum number of results to return in a single call to Search.
void	setNextToken(String nextToken) When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.
void	setOwningProjectIdentifier(String owningProjectIdentifier) The identifier of the owning project specified for the search.
void	setSearchIn(Collection<SearchInItem> searchIn) The details of the search.
void	setSearchScope(String searchScope) The scope of the search.
void	setSearchText(String searchText) Specifies the text for which to search.
void	setSort(SearchSort sort) Specifies the way in which the search results are to be sorted.
String	toString() Returns a string representation of this object.
SearchRequest	withAdditionalAttributes(Collection<String> additionalAttributes) Specifies additional attributes for the Search action.
SearchRequest	withAdditionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes) Specifies additional attributes for the Search action.
SearchRequest	withAdditionalAttributes(String... additionalAttributes) Specifies additional attributes for the Search action.
SearchRequest	withDomainIdentifier(String domainIdentifier) The identifier of the Amazon DataZone domain.
SearchRequest	withFilters(FilterClause filters) Specifies the search filters.
SearchRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a single call to Search.
SearchRequest	withNextToken(String nextToken) When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.
SearchRequest	withOwningProjectIdentifier(String owningProjectIdentifier) The identifier of the owning project specified for the search.
SearchRequest	withSearchIn(Collection<SearchInItem> searchIn) The details of the search.
SearchRequest	withSearchIn(SearchInItem... searchIn) The details of the search.
SearchRequest	withSearchScope(InventorySearchScope searchScope) The scope of the search.
SearchRequest	withSearchScope(String searchScope) The scope of the search.
SearchRequest	withSearchText(String searchText) Specifies the text for which to search.
SearchRequest	withSort(SearchSort sort) Specifies the way in which the search results are to be sorted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchRequest

public SearchRequest()

Method Detail

getAdditionalAttributes

public List<String> getAdditionalAttributes()

Specifies additional attributes for the Search action.

Returns:

Specifies additional attributes for the Search action.

See Also:

SearchOutputAdditionalAttribute

setAdditionalAttributes

public void setAdditionalAttributes(Collection<String> additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

See Also:

SearchOutputAdditionalAttribute

withAdditionalAttributes

public SearchRequest withAdditionalAttributes(String... additionalAttributes)

Specifies additional attributes for the Search action.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalAttributes(java.util.Collection) or withAdditionalAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchOutputAdditionalAttribute

withAdditionalAttributes

public SearchRequest withAdditionalAttributes(Collection<String> additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchOutputAdditionalAttribute

withAdditionalAttributes

public SearchRequest withAdditionalAttributes(SearchOutputAdditionalAttribute... additionalAttributes)

Specifies additional attributes for the Search action.

Parameters:

additionalAttributes - Specifies additional attributes for the Search action.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SearchOutputAdditionalAttribute

setDomainIdentifier

public void setDomainIdentifier(String domainIdentifier)

The identifier of the Amazon DataZone domain.

Parameters:

domainIdentifier - The identifier of the Amazon DataZone domain.

getDomainIdentifier

public String getDomainIdentifier()

The identifier of the Amazon DataZone domain.

Returns:

The identifier of the Amazon DataZone domain.

withDomainIdentifier

public SearchRequest withDomainIdentifier(String domainIdentifier)

The identifier of the Amazon DataZone domain.

Parameters:

domainIdentifier - The identifier of the Amazon DataZone domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilters

public void setFilters(FilterClause filters)

Specifies the search filters.

Parameters:

filters - Specifies the search filters.

getFilters

public FilterClause getFilters()

Specifies the search filters.

Returns:

Specifies the search filters.

withFilters

public SearchRequest withFilters(FilterClause filters)

Specifies the search filters.

Parameters:

filters - Specifies the search filters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Parameters:

maxResults - The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Returns:

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

withMaxResults

public SearchRequest withMaxResults(Integer maxResults)

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Parameters:

maxResults - The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Parameters:

nextToken - When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

getNextToken

public String getNextToken()

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Returns:

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

withNextToken

public SearchRequest withNextToken(String nextToken)

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Parameters:

nextToken - When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOwningProjectIdentifier

public void setOwningProjectIdentifier(String owningProjectIdentifier)

The identifier of the owning project specified for the search.

Parameters:

owningProjectIdentifier - The identifier of the owning project specified for the search.

getOwningProjectIdentifier

public String getOwningProjectIdentifier()

The identifier of the owning project specified for the search.

Returns:

The identifier of the owning project specified for the search.

withOwningProjectIdentifier

public SearchRequest withOwningProjectIdentifier(String owningProjectIdentifier)

The identifier of the owning project specified for the search.

Parameters:

owningProjectIdentifier - The identifier of the owning project specified for the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSearchIn

public List<SearchInItem> getSearchIn()

The details of the search.

Returns:

The details of the search.

setSearchIn

public void setSearchIn(Collection<SearchInItem> searchIn)

The details of the search.

Parameters:

searchIn - The details of the search.

withSearchIn

public SearchRequest withSearchIn(SearchInItem... searchIn)

The details of the search.

NOTE: This method appends the values to the existing list (if any). Use setSearchIn(java.util.Collection) or withSearchIn(java.util.Collection) if you want to override the existing values.

Parameters:

searchIn - The details of the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSearchIn

public SearchRequest withSearchIn(Collection<SearchInItem> searchIn)

The details of the search.

Parameters:

searchIn - The details of the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSearchScope

public void setSearchScope(String searchScope)

The scope of the search.

Parameters:

searchScope - The scope of the search.

See Also:

InventorySearchScope

getSearchScope

public String getSearchScope()

The scope of the search.

Returns:

The scope of the search.

See Also:

InventorySearchScope

withSearchScope

public SearchRequest withSearchScope(String searchScope)

The scope of the search.

Parameters:

searchScope - The scope of the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InventorySearchScope

withSearchScope

public SearchRequest withSearchScope(InventorySearchScope searchScope)

The scope of the search.

Parameters:

searchScope - The scope of the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InventorySearchScope

setSearchText

public void setSearchText(String searchText)

Specifies the text for which to search.

Parameters:

searchText - Specifies the text for which to search.

getSearchText

public String getSearchText()

Specifies the text for which to search.

Returns:

Specifies the text for which to search.

withSearchText

public SearchRequest withSearchText(String searchText)

Specifies the text for which to search.

Parameters:

searchText - Specifies the text for which to search.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSort

public void setSort(SearchSort sort)

Specifies the way in which the search results are to be sorted.

Parameters:

sort - Specifies the way in which the search results are to be sorted.

getSort

public SearchSort getSort()

Specifies the way in which the search results are to be sorted.

Returns:

Specifies the way in which the search results are to be sorted.

withSort

public SearchRequest withSort(SearchSort sort)

Specifies the way in which the search results are to be sorted.

Parameters:

sort - Specifies the way in which the search results are to be sorted.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()