com.amazonaws.services.sagemaker.model

Class SearchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.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)
Integer	getMaxResults() The maximum number of results to return in a SearchResponse.
String	getNextToken() If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken.
String	getResource() The name of the Amazon SageMaker resource to search for.
SearchExpression	getSearchExpression() A Boolean conditional statement.
String	getSortBy() The name of the resource property used to sort the SearchResults.
String	getSortOrder() How SearchResults are ordered.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of results to return in a SearchResponse.
void	setNextToken(String nextToken) If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken.
void	setResource(String resource) The name of the Amazon SageMaker resource to search for.
void	setSearchExpression(SearchExpression searchExpression) A Boolean conditional statement.
void	setSortBy(String sortBy) The name of the resource property used to sort the SearchResults.
void	setSortOrder(String sortOrder) How SearchResults are ordered.
String	toString() Returns a string representation of this object.
SearchRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a SearchResponse.
SearchRequest	withNextToken(String nextToken) If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken.
SearchRequest	withResource(ResourceType resource) The name of the Amazon SageMaker resource to search for.
SearchRequest	withResource(String resource) The name of the Amazon SageMaker resource to search for.
SearchRequest	withSearchExpression(SearchExpression searchExpression) A Boolean conditional statement.
SearchRequest	withSortBy(String sortBy) The name of the resource property used to sort the SearchResults.
SearchRequest	withSortOrder(SearchSortOrder sortOrder) How SearchResults are ordered.
SearchRequest	withSortOrder(String sortOrder) How SearchResults are ordered.

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

setResource

public void setResource(String resource)

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Parameters:

resource - The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

See Also:

ResourceType

getResource

public String getResource()

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Returns:

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

See Also:

ResourceType

withResource

public SearchRequest withResource(String resource)

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Parameters:

resource - The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Returns:

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

See Also:

ResourceType

withResource

public SearchRequest withResource(ResourceType resource)

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Parameters:

resource - The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Returns:

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

See Also:

ResourceType

setSearchExpression

public void setSearchExpression(SearchExpression searchExpression)

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

Parameters:

searchExpression - A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

getSearchExpression

public SearchExpression getSearchExpression()

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

Returns:

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

withSearchExpression

public SearchRequest withSearchExpression(SearchExpression searchExpression)

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

Parameters:

searchExpression - A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

Returns:

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

setSortBy

public void setSortBy(String sortBy)

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Parameters:

sortBy - The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

getSortBy

public String getSortBy()

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Returns:

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

withSortBy

public SearchRequest withSortBy(String sortBy)

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Parameters:

sortBy - The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Parameters:

sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

See Also:

SearchSortOrder

getSortOrder

public String getSortOrder()

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Returns:

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

See Also:

SearchSortOrder

withSortOrder

public SearchRequest withSortOrder(String sortOrder)

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Parameters:

sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Returns:

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

See Also:

SearchSortOrder

withSortOrder

public SearchRequest withSortOrder(SearchSortOrder sortOrder)

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Parameters:

sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Returns:

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

See Also:

SearchSortOrder

setNextToken

public void setNextToken(String nextToken)

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Parameters:

nextToken - If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

getNextToken

public String getNextToken()

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Returns:

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

withNextToken

public SearchRequest withNextToken(String nextToken)

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Parameters:

nextToken - If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

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 SearchResponse.

Parameters:

maxResults - The maximum number of results to return in a SearchResponse.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in a SearchResponse.

Returns:

The maximum number of results to return in a SearchResponse.

withMaxResults

public SearchRequest withMaxResults(Integer maxResults)

The maximum number of results to return in a SearchResponse.

Parameters:

maxResults - The maximum number of results to return in a SearchResponse.

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()