Aws::SageMaker::Model::SearchRequest Class Reference

#include <SearchRequest.h>

Inheritance diagram for Aws::SageMaker::Model::SearchRequest:

Public Member Functions
	SearchRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const ResourceType &	GetResource () const
bool	ResourceHasBeenSet () const
void	SetResource (const ResourceType &value)
void	SetResource (ResourceType &&value)
SearchRequest &	WithResource (const ResourceType &value)
SearchRequest &	WithResource (ResourceType &&value)
const SearchExpression &	GetSearchExpression () const
bool	SearchExpressionHasBeenSet () const
void	SetSearchExpression (const SearchExpression &value)
void	SetSearchExpression (SearchExpression &&value)
SearchRequest &	WithSearchExpression (const SearchExpression &value)
SearchRequest &	WithSearchExpression (SearchExpression &&value)
const Aws::String &	GetSortBy () const
bool	SortByHasBeenSet () const
void	SetSortBy (const Aws::String &value)
void	SetSortBy (Aws::String &&value)
void	SetSortBy (const char *value)
SearchRequest &	WithSortBy (const Aws::String &value)
SearchRequest &	WithSortBy (Aws::String &&value)
SearchRequest &	WithSortBy (const char *value)
const SearchSortOrder &	GetSortOrder () const
bool	SortOrderHasBeenSet () const
void	SetSortOrder (const SearchSortOrder &value)
void	SetSortOrder (SearchSortOrder &&value)
SearchRequest &	WithSortOrder (const SearchSortOrder &value)
SearchRequest &	WithSortOrder (SearchSortOrder &&value)
const Aws::String &	GetNextToken () const
bool	NextTokenHasBeenSet () const
void	SetNextToken (const Aws::String &value)
void	SetNextToken (Aws::String &&value)
void	SetNextToken (const char *value)
SearchRequest &	WithNextToken (const Aws::String &value)
SearchRequest &	WithNextToken (Aws::String &&value)
SearchRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
SearchRequest &	WithMaxResults (int value)
Public Member Functions inherited from Aws::SageMaker::SageMakerRequest
virtual	~SageMakerRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 24 of file SearchRequest.h.

Constructor & Destructor Documentation

SearchRequest()

Aws::SageMaker::Model::SearchRequest::SearchRequest

(

)

Member Function Documentation

GetMaxResults()

int Aws::SageMaker::Model::SearchRequest::GetMaxResults ( ) const

inline

The maximum number of results to return.

Definition at line 286 of file SearchRequest.h.

GetNextToken()

const Aws::String& Aws::SageMaker::Model::SearchRequest::GetNextToken ( ) const

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 224 of file SearchRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMaker::Model::SearchRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SageMaker::SageMakerRequest.

GetResource()

const ResourceType& Aws::SageMaker::Model::SearchRequest::GetResource ( ) const

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 43 of file SearchRequest.h.

GetSearchExpression()

const SearchExpression& Aws::SageMaker::Model::SearchRequest::GetSearchExpression ( ) const

inline

A Boolean conditional statement. Resources 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.

Definition at line 78 of file SearchRequest.h.

GetServiceRequestName()

virtual const char* Aws::SageMaker::Model::SearchRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SearchRequest.h.

GetSortBy()

const Aws::String& Aws::SageMaker::Model::SearchRequest::GetSortBy ( ) const

inline

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

Definition at line 130 of file SearchRequest.h.

GetSortOrder()

const SearchSortOrder& Aws::SageMaker::Model::SearchRequest::GetSortOrder ( ) const

inline

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

Definition at line 180 of file SearchRequest.h.

MaxResultsHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::MaxResultsHasBeenSet ( ) const

inline

The maximum number of results to return.

Definition at line 291 of file SearchRequest.h.

NextTokenHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::NextTokenHasBeenSet ( ) const

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 232 of file SearchRequest.h.

ResourceHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::ResourceHasBeenSet ( ) const

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 48 of file SearchRequest.h.

SearchExpressionHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::SearchExpressionHasBeenSet ( ) const

inline

A Boolean conditional statement. Resources 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.

Definition at line 87 of file SearchRequest.h.

SerializePayload()

Aws::String Aws::SageMaker::Model::SearchRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetMaxResults()

void Aws::SageMaker::Model::SearchRequest::SetMaxResults ( int  value )

inline

The maximum number of results to return.

Definition at line 296 of file SearchRequest.h.

SetNextToken() [1/3]

void Aws::SageMaker::Model::SearchRequest::SetNextToken ( const Aws::String &  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 240 of file SearchRequest.h.

SetNextToken() [2/3]

void Aws::SageMaker::Model::SearchRequest::SetNextToken ( Aws::String &&  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 248 of file SearchRequest.h.

SetNextToken() [3/3]

void Aws::SageMaker::Model::SearchRequest::SetNextToken ( const char *  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 256 of file SearchRequest.h.

SetResource() [1/2]

void Aws::SageMaker::Model::SearchRequest::SetResource ( const ResourceType &  value )

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 53 of file SearchRequest.h.

SetResource() [2/2]

void Aws::SageMaker::Model::SearchRequest::SetResource ( ResourceType &&  value )

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 58 of file SearchRequest.h.

SetSearchExpression() [1/2]

void Aws::SageMaker::Model::SearchRequest::SetSearchExpression ( const SearchExpression &  value )

inline

A Boolean conditional statement. Resources 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.

Definition at line 96 of file SearchRequest.h.

SetSearchExpression() [2/2]

void Aws::SageMaker::Model::SearchRequest::SetSearchExpression ( SearchExpression &&  value )

inline

A Boolean conditional statement. Resources 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.

Definition at line 105 of file SearchRequest.h.

SetSortBy() [1/3]

void Aws::SageMaker::Model::SearchRequest::SetSortBy ( const Aws::String &  value )

inline

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

Definition at line 142 of file SearchRequest.h.

SetSortBy() [2/3]

void Aws::SageMaker::Model::SearchRequest::SetSortBy ( Aws::String &&  value )

inline

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

Definition at line 148 of file SearchRequest.h.

SetSortBy() [3/3]

void Aws::SageMaker::Model::SearchRequest::SetSortBy ( const char *  value )

inline

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

Definition at line 154 of file SearchRequest.h.

SetSortOrder() [1/2]

void Aws::SageMaker::Model::SearchRequest::SetSortOrder ( const SearchSortOrder &  value )

inline

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

Definition at line 194 of file SearchRequest.h.

SetSortOrder() [2/2]

void Aws::SageMaker::Model::SearchRequest::SetSortOrder ( SearchSortOrder &&  value )

inline

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

Definition at line 201 of file SearchRequest.h.

SortByHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::SortByHasBeenSet ( ) const

inline

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

Definition at line 136 of file SearchRequest.h.

SortOrderHasBeenSet()

bool Aws::SageMaker::Model::SearchRequest::SortOrderHasBeenSet ( ) const

inline

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

Definition at line 187 of file SearchRequest.h.

WithMaxResults()

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithMaxResults ( int  value )

inline

The maximum number of results to return.

Definition at line 301 of file SearchRequest.h.

WithNextToken() [1/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithNextToken ( const Aws::String &  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 264 of file SearchRequest.h.

WithNextToken() [2/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithNextToken ( Aws::String &&  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 272 of file SearchRequest.h.

WithNextToken() [3/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithNextToken ( const char *  value )

inline

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

Definition at line 280 of file SearchRequest.h.

WithResource() [1/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithResource ( const ResourceType &  value )

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 63 of file SearchRequest.h.

WithResource() [2/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithResource ( ResourceType &&  value )

inline

The name of the Amazon SageMaker resource to search for.

Definition at line 68 of file SearchRequest.h.

WithSearchExpression() [1/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSearchExpression ( const SearchExpression &  value )

inline

A Boolean conditional statement. Resources 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.

Definition at line 114 of file SearchRequest.h.

WithSearchExpression() [2/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSearchExpression ( SearchExpression &&  value )

inline

A Boolean conditional statement. Resources 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.

Definition at line 123 of file SearchRequest.h.

WithSortBy() [1/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSortBy ( const Aws::String &  value )

inline

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

Definition at line 160 of file SearchRequest.h.

WithSortBy() [2/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSortBy ( Aws::String &&  value )

inline

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

Definition at line 166 of file SearchRequest.h.

WithSortBy() [3/3]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSortBy ( const char *  value )

inline

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

Definition at line 172 of file SearchRequest.h.

WithSortOrder() [1/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSortOrder ( const SearchSortOrder &  value )

inline

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

Definition at line 208 of file SearchRequest.h.

WithSortOrder() [2/2]

SearchRequest& Aws::SageMaker::Model::SearchRequest::WithSortOrder ( SearchSortOrder &&  value )

inline

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

Definition at line 215 of file SearchRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/SearchRequest.h