software.amazon.awssdk.services.machinelearning.model

Interface DescribeMlModelsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeMlModelsRequest.Builder,DescribeMlModelsRequest>, MachineLearningRequest.Builder, SdkBuilder<DescribeMlModelsRequest.Builder,DescribeMlModelsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeMlModelsRequest

public static interface DescribeMlModelsRequest.Builder
extends MachineLearningRequest.Builder, SdkPojo, CopyableBuilder<DescribeMlModelsRequest.Builder,DescribeMlModelsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeMlModelsRequest.Builder	eq(String eq) The equal to operator.
DescribeMlModelsRequest.Builder	filterVariable(MLModelFilterVariable filterVariable) Use one of the following variables to filter a list of MLModel:
DescribeMlModelsRequest.Builder	filterVariable(String filterVariable) Use one of the following variables to filter a list of MLModel:
DescribeMlModelsRequest.Builder	ge(String ge) The greater than or equal to operator.
DescribeMlModelsRequest.Builder	gt(String gt) The greater than operator.
DescribeMlModelsRequest.Builder	le(String le) The less than or equal to operator.
DescribeMlModelsRequest.Builder	limit(Integer limit) The number of pages of information to include in the result.
DescribeMlModelsRequest.Builder	lt(String lt) The less than operator.
DescribeMlModelsRequest.Builder	ne(String ne) The not equal to operator.
DescribeMlModelsRequest.Builder	nextToken(String nextToken) The ID of the page in the paginated results.
DescribeMlModelsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeMlModelsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DescribeMlModelsRequest.Builder	prefix(String prefix) A string that is found at the beginning of a variable, such as Name or Id.
DescribeMlModelsRequest.Builder	sortOrder(SortOrder sortOrder) A two-value parameter that determines the sequence of the resulting list of MLModel.
DescribeMlModelsRequest.Builder	sortOrder(String sortOrder) A two-value parameter that determines the sequence of the resulting list of MLModel.

Methods inherited from interface software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filterVariable

DescribeMlModelsRequest.Builder filterVariable(String filterVariable)

Use one of the following variables to filter a list of MLModel:

• CreatedAt - Sets the search criteria to MLModel creation date.
• Status - Sets the search criteria to MLModel status.
• Name - Sets the search criteria to the contents of MLModel Name.
• IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
• TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
• RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
• MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
• Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
• TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variables to filter a list of MLModel:

• CreatedAt - Sets the search criteria to MLModel creation date.
• Status - Sets the search criteria to MLModel status.
• Name - Sets the search criteria to the contents of MLModel Name.
• IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
• TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
• RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
• MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
• Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
• TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

Returns:

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

See Also:

MLModelFilterVariable, MLModelFilterVariable

filterVariable

DescribeMlModelsRequest.Builder filterVariable(MLModelFilterVariable filterVariable)

Use one of the following variables to filter a list of MLModel:

• CreatedAt - Sets the search criteria to MLModel creation date.
• Status - Sets the search criteria to MLModel status.
• Name - Sets the search criteria to the contents of MLModel Name.
• IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
• TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
• RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
• MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
• Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
• TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variables to filter a list of MLModel:

• CreatedAt - Sets the search criteria to MLModel creation date.
• Status - Sets the search criteria to MLModel status.
• Name - Sets the search criteria to the contents of MLModel Name.
• IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
• TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
• RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
• MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
• Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
• TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

Returns:

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

See Also:

MLModelFilterVariable, MLModelFilterVariable

eq

DescribeMlModelsRequest.Builder eq(String eq)

The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

Parameters:

eq - The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

Returns:

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

gt

DescribeMlModelsRequest.Builder gt(String gt)

The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

Parameters:

gt - The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

Returns:

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

lt

DescribeMlModelsRequest.Builder lt(String lt)

The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

Parameters:

lt - The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

Returns:

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

ge

DescribeMlModelsRequest.Builder ge(String ge)

The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

Parameters:

ge - The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

Returns:

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

le

DescribeMlModelsRequest.Builder le(String le)

The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

Parameters:

le - The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

Returns:

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

ne

DescribeMlModelsRequest.Builder ne(String ne)

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

Parameters:

ne - The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

Returns:

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

prefix

DescribeMlModelsRequest.Builder prefix(String prefix)

A string that is found at the beginning of a variable, such as Name or Id.

For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Parameters:

prefix - A string that is found at the beginning of a variable, such as Name or Id .

For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Returns:

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

sortOrder

DescribeMlModelsRequest.Builder sortOrder(String sortOrder)

A two-value parameter that determines the sequence of the resulting list of MLModel.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of MLModel.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Returns:

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

See Also:

SortOrder, SortOrder

sortOrder

DescribeMlModelsRequest.Builder sortOrder(SortOrder sortOrder)

A two-value parameter that determines the sequence of the resulting list of MLModel.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of MLModel.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Returns:

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

See Also:

SortOrder, SortOrder

nextToken

DescribeMlModelsRequest.Builder nextToken(String nextToken)

The ID of the page in the paginated results.

Parameters:

nextToken - The ID of the page in the paginated results.

Returns:

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

limit

DescribeMlModelsRequest.Builder limit(Integer limit)

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

Parameters:

limit - The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

Returns:

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

overrideConfiguration

DescribeMlModelsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeMlModelsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.