software.amazon.awssdk.services.machinelearning.model

Interface DescribeBatchPredictionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>, MachineLearningRequest.Builder, SdkBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>, SdkRequest.Builder

Enclosing class:

DescribeBatchPredictionsRequest

public static interface DescribeBatchPredictionsRequest.Builder
extends MachineLearningRequest.Builder, CopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>

Method Summary

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

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

filterVariable

DescribeBatchPredictionsRequest.Builder filterVariable(String filterVariable)

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

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.
• Status - Sets the search criteria to the BatchPrediction status.
• Name - Sets the search criteria to the contents of the BatchPrediction Name.
• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

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

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.
• Status - Sets the search criteria to the BatchPrediction status.
• Name - Sets the search criteria to the contents of the BatchPrediction Name.
• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Returns:

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

See Also:

BatchPredictionFilterVariable, BatchPredictionFilterVariable

filterVariable

DescribeBatchPredictionsRequest.Builder filterVariable(BatchPredictionFilterVariable filterVariable)

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

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.
• Status - Sets the search criteria to the BatchPrediction status.
• Name - Sets the search criteria to the contents of the BatchPrediction Name.
• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

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

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.
• Status - Sets the search criteria to the BatchPrediction status.
• Name - Sets the search criteria to the contents of the BatchPrediction Name.
• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Returns:

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

See Also:

BatchPredictionFilterVariable, BatchPredictionFilterVariable

eq

DescribeBatchPredictionsRequest.Builder eq(String eq)

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

Parameters:

eq - The equal to operator. The BatchPrediction 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

DescribeBatchPredictionsRequest.Builder gt(String gt)

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

Parameters:

gt - The greater than operator. The BatchPrediction 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

DescribeBatchPredictionsRequest.Builder lt(String lt)

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

Parameters:

lt - The less than operator. The BatchPrediction 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

DescribeBatchPredictionsRequest.Builder ge(String ge)

The greater than or equal to operator. The BatchPrediction 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 BatchPrediction 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

DescribeBatchPredictionsRequest.Builder le(String le)

The less than or equal to operator. The BatchPrediction 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 BatchPrediction 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

DescribeBatchPredictionsRequest.Builder ne(String ne)

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

Parameters:

ne - The not equal to operator. The BatchPrediction 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

DescribeBatchPredictionsRequest.Builder prefix(String prefix)

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

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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

DescribeBatchPredictionsRequest.Builder sortOrder(String sortOrder)

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

• 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 MLModels.

• 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

DescribeBatchPredictionsRequest.Builder sortOrder(SortOrder sortOrder)

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

• 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 MLModels.

• 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

DescribeBatchPredictionsRequest.Builder nextToken(String nextToken)

An ID of the page in the paginated results.

Parameters:

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

Returns:

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

limit

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

requestOverrideConfig

DescribeBatchPredictionsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeBatchPredictionsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.