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

#include <Filter.h>

Public Member Functions

 Filter ()
 
 Filter (Aws::Utils::Json::JsonView jsonValue)
 
Filteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
FilterWithName (const Aws::String &value)
 
FilterWithName (Aws::String &&value)
 
FilterWithName (const char *value)
 
const OperatorGetOperator () const
 
bool OperatorHasBeenSet () const
 
void SetOperator (const Operator &value)
 
void SetOperator (Operator &&value)
 
FilterWithOperator (const Operator &value)
 
FilterWithOperator (Operator &&value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
FilterWithValue (const Aws::String &value)
 
FilterWithValue (Aws::String &&value)
 
FilterWithValue (const char *value)
 

Detailed Description

A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.

If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.&lt;name&gt;", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GreaterThan",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.&lt;name&gt;". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LessThan",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form Tags.<key>.

See Also:

AWS API Reference

Definition at line 55 of file Filter.h.

Constructor & Destructor Documentation

◆ Filter() [1/2]

Aws::SageMaker::Model::Filter::Filter ( )

◆ Filter() [2/2]

Aws::SageMaker::Model::Filter::Filter ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetName()

const Aws::String& Aws::SageMaker::Model::Filter::GetName ( ) const
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 69 of file Filter.h.

◆ GetOperator()

const Operator& Aws::SageMaker::Model::Filter::GetOperator ( ) const
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 159 of file Filter.h.

◆ GetValue()

const Aws::String& Aws::SageMaker::Model::Filter::GetValue ( ) const
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 369 of file Filter.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::Filter::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::SageMaker::Model::Filter::NameHasBeenSet ( ) const
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 76 of file Filter.h.

◆ operator=()

Filter& Aws::SageMaker::Model::Filter::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OperatorHasBeenSet()

bool Aws::SageMaker::Model::Filter::OperatorHasBeenSet ( ) const
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 199 of file Filter.h.

◆ SetName() [1/3]

void Aws::SageMaker::Model::Filter::SetName ( Aws::String &&  value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 90 of file Filter.h.

◆ SetName() [2/3]

void Aws::SageMaker::Model::Filter::SetName ( const Aws::String value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 83 of file Filter.h.

◆ SetName() [3/3]

void Aws::SageMaker::Model::Filter::SetName ( const char *  value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 97 of file Filter.h.

◆ SetOperator() [1/2]

void Aws::SageMaker::Model::Filter::SetOperator ( const Operator value)
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 239 of file Filter.h.

◆ SetOperator() [2/2]

void Aws::SageMaker::Model::Filter::SetOperator ( Operator &&  value)
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 279 of file Filter.h.

◆ SetValue() [1/3]

void Aws::SageMaker::Model::Filter::SetValue ( Aws::String &&  value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 396 of file Filter.h.

◆ SetValue() [2/3]

void Aws::SageMaker::Model::Filter::SetValue ( const Aws::String value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 387 of file Filter.h.

◆ SetValue() [3/3]

void Aws::SageMaker::Model::Filter::SetValue ( const char *  value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 405 of file Filter.h.

◆ ValueHasBeenSet()

bool Aws::SageMaker::Model::Filter::ValueHasBeenSet ( ) const
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 378 of file Filter.h.

◆ WithName() [1/3]

Filter& Aws::SageMaker::Model::Filter::WithName ( Aws::String &&  value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 111 of file Filter.h.

◆ WithName() [2/3]

Filter& Aws::SageMaker::Model::Filter::WithName ( const Aws::String value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 104 of file Filter.h.

◆ WithName() [3/3]

Filter& Aws::SageMaker::Model::Filter::WithName ( const char *  value)
inline

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

Definition at line 118 of file Filter.h.

◆ WithOperator() [1/2]

Filter& Aws::SageMaker::Model::Filter::WithOperator ( const Operator value)
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 319 of file Filter.h.

◆ WithOperator() [2/2]

Filter& Aws::SageMaker::Model::Filter::WithOperator ( Operator &&  value)
inline

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "<code>'CONTAINS' operator usage limit of 1 exceeded.</code>"

Definition at line 359 of file Filter.h.

◆ WithValue() [1/3]

Filter& Aws::SageMaker::Model::Filter::WithValue ( Aws::String &&  value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 423 of file Filter.h.

◆ WithValue() [2/3]

Filter& Aws::SageMaker::Model::Filter::WithValue ( const Aws::String value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 414 of file Filter.h.

◆ WithValue() [3/3]

Filter& Aws::SageMaker::Model::Filter::WithValue ( const char *  value)
inline

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

Definition at line 432 of file Filter.h.


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