AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest Class Reference

#include <ListTrainingJobsForHyperParameterTuningJobRequest.h>

+ Inheritance diagram for Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest:

Public Member Functions

 ListTrainingJobsForHyperParameterTuningJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetHyperParameterTuningJobName () const
 
bool HyperParameterTuningJobNameHasBeenSet () const
 
void SetHyperParameterTuningJobName (const Aws::String &value)
 
void SetHyperParameterTuningJobName (Aws::String &&value)
 
void SetHyperParameterTuningJobName (const char *value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithHyperParameterTuningJobName (const Aws::String &value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithHyperParameterTuningJobName (Aws::String &&value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithHyperParameterTuningJobName (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithNextToken (const Aws::String &value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithNextToken (Aws::String &&value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithMaxResults (int value)
 
const TrainingJobStatusGetStatusEquals () const
 
bool StatusEqualsHasBeenSet () const
 
void SetStatusEquals (const TrainingJobStatus &value)
 
void SetStatusEquals (TrainingJobStatus &&value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithStatusEquals (const TrainingJobStatus &value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithStatusEquals (TrainingJobStatus &&value)
 
const TrainingJobSortByOptionsGetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const TrainingJobSortByOptions &value)
 
void SetSortBy (TrainingJobSortByOptions &&value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithSortBy (const TrainingJobSortByOptions &value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithSortBy (TrainingJobSortByOptions &&value)
 
const SortOrderGetSortOrder () const
 
bool SortOrderHasBeenSet () const
 
void SetSortOrder (const SortOrder &value)
 
void SetSortOrder (SortOrder &&value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithSortOrder (const SortOrder &value)
 
ListTrainingJobsForHyperParameterTuningJobRequestWithSortOrder (SortOrder &&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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 ListTrainingJobsForHyperParameterTuningJobRequest.h.

Constructor & Destructor Documentation

◆ ListTrainingJobsForHyperParameterTuningJobRequest()

Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::ListTrainingJobsForHyperParameterTuningJobRequest ( )

Member Function Documentation

◆ GetHyperParameterTuningJobName()

const Aws::String& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetHyperParameterTuningJobName ( ) const
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 43 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ GetMaxResults()

int Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetMaxResults ( ) const
inline

The maximum number of training jobs to return. The default value is 10.

Definition at line 149 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetNextToken ( ) const
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 87 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SageMaker::SageMakerRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSortBy()

const TrainingJobSortByOptions& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetSortBy ( ) const
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 203 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ GetSortOrder()

const SortOrder& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetSortOrder ( ) const
inline

The sort order for results. The default is Ascending.

Definition at line 244 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ GetStatusEquals()

const TrainingJobStatus& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetStatusEquals ( ) const
inline

A filter that returns only training jobs with the specified status.

Definition at line 170 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ HyperParameterTuningJobNameHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::HyperParameterTuningJobNameHasBeenSet ( ) const
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 48 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of training jobs to return. The default value is 10.

Definition at line 154 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::NextTokenHasBeenSet ( ) const
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 95 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SerializePayload()

Aws::String Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetHyperParameterTuningJobName() [1/3]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName ( const Aws::String value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 53 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetHyperParameterTuningJobName() [2/3]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName ( Aws::String &&  value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 58 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetHyperParameterTuningJobName() [3/3]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName ( const char *  value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 63 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetMaxResults()

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetMaxResults ( int  value)
inline

The maximum number of training jobs to return. The default value is 10.

Definition at line 159 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetNextToken() [1/3]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetNextToken ( const Aws::String value)
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 103 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetNextToken() [2/3]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetNextToken ( Aws::String &&  value)
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 111 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetNextToken() [3/3]

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

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 119 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetSortBy() [1/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortBy ( const TrainingJobSortByOptions value)
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 217 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetSortBy() [2/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortBy ( TrainingJobSortByOptions &&  value)
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 224 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetSortOrder() [1/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortOrder ( const SortOrder value)
inline

The sort order for results. The default is Ascending.

Definition at line 254 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetSortOrder() [2/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortOrder ( SortOrder &&  value)
inline

The sort order for results. The default is Ascending.

Definition at line 259 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetStatusEquals() [1/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetStatusEquals ( const TrainingJobStatus value)
inline

A filter that returns only training jobs with the specified status.

Definition at line 180 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SetStatusEquals() [2/2]

void Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetStatusEquals ( TrainingJobStatus &&  value)
inline

A filter that returns only training jobs with the specified status.

Definition at line 185 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SortByHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SortByHasBeenSet ( ) const
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 210 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ SortOrderHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SortOrderHasBeenSet ( ) const
inline

The sort order for results. The default is Ascending.

Definition at line 249 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ StatusEqualsHasBeenSet()

bool Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::StatusEqualsHasBeenSet ( ) const
inline

A filter that returns only training jobs with the specified status.

Definition at line 175 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithHyperParameterTuningJobName() [1/3]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName ( const Aws::String value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 68 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithHyperParameterTuningJobName() [2/3]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName ( Aws::String &&  value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 73 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithHyperParameterTuningJobName() [3/3]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName ( const char *  value)
inline

The name of the tuning job whose training jobs you want to list.

Definition at line 78 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithMaxResults()

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithMaxResults ( int  value)
inline

The maximum number of training jobs to return. The default value is 10.

Definition at line 164 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithNextToken() [1/3]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithNextToken ( const Aws::String value)
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 127 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithNextToken() [2/3]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithNextToken ( Aws::String &&  value)
inline

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 135 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithNextToken() [3/3]

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

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

Definition at line 143 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithSortBy() [1/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortBy ( const TrainingJobSortByOptions value)
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 231 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithSortBy() [2/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortBy ( TrainingJobSortByOptions &&  value)
inline

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

Definition at line 238 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithSortOrder() [1/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortOrder ( const SortOrder value)
inline

The sort order for results. The default is Ascending.

Definition at line 264 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithSortOrder() [2/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortOrder ( SortOrder &&  value)
inline

The sort order for results. The default is Ascending.

Definition at line 269 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithStatusEquals() [1/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithStatusEquals ( const TrainingJobStatus value)
inline

A filter that returns only training jobs with the specified status.

Definition at line 190 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.

◆ WithStatusEquals() [2/2]

ListTrainingJobsForHyperParameterTuningJobRequest& Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithStatusEquals ( TrainingJobStatus &&  value)
inline

A filter that returns only training jobs with the specified status.

Definition at line 195 of file ListTrainingJobsForHyperParameterTuningJobRequest.h.


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