software.amazon.awssdk.services.sagemaker.model

Interface SearchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchRequest.Builder,SearchRequest>, SageMakerRequest.Builder, SdkBuilder<SearchRequest.Builder,SearchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchRequest

public static interface SearchRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<SearchRequest.Builder,SearchRequest>

Method Summary

Modifier and Type	Method and Description
SearchRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return in a SearchResponse.
SearchRequest.Builder	nextToken(String nextToken) If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken.
SearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
SearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
SearchRequest.Builder	resource(ResourceType resource) The name of the Amazon SageMaker resource to search for.
SearchRequest.Builder	resource(String resource) The name of the Amazon SageMaker resource to search for.
default SearchRequest.Builder	searchExpression(Consumer<SearchExpression.Builder> searchExpression) A Boolean conditional statement.
SearchRequest.Builder	searchExpression(SearchExpression searchExpression) A Boolean conditional statement.
SearchRequest.Builder	sortBy(String sortBy) The name of the resource property used to sort the SearchResults.
SearchRequest.Builder	sortOrder(SearchSortOrder sortOrder) How SearchResults are ordered.
SearchRequest.Builder	sortOrder(String sortOrder) How SearchResults are ordered.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.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

resource

SearchRequest.Builder resource(String resource)

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Parameters:

resource - The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Returns:

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

See Also:

ResourceType, ResourceType

resource

SearchRequest.Builder resource(ResourceType resource)

The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Parameters:

resource - The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

Returns:

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

See Also:

ResourceType, ResourceType

searchExpression

SearchRequest.Builder searchExpression(SearchExpression searchExpression)

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results.

Parameters:

searchExpression - A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results.

Returns:

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

searchExpression

default SearchRequest.Builder searchExpression(Consumer<SearchExpression.Builder> searchExpression)

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results.

This is a convenience that creates an instance of the SearchExpression.Builder avoiding the need to create one manually via SearchExpression.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchExpression(SearchExpression).

Parameters:

searchExpression - a consumer that will call methods on SearchExpression.Builder

Returns:

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

See Also:

searchExpression(SearchExpression)

sortBy

SearchRequest.Builder sortBy(String sortBy)

The name of the resource property used to sort the SearchResults.

Parameters:

sortBy - The name of the resource property used to sort the SearchResults.

Returns:

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

sortOrder

SearchRequest.Builder sortOrder(String sortOrder)

How SearchResults are ordered. Valid values are Ascending or Descending.

Parameters:

sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending.

Returns:

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

See Also:

SearchSortOrder, SearchSortOrder

sortOrder

SearchRequest.Builder sortOrder(SearchSortOrder sortOrder)

How SearchResults are ordered. Valid values are Ascending or Descending.

Parameters:

sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending.

Returns:

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

See Also:

SearchSortOrder, SearchSortOrder

nextToken

SearchRequest.Builder nextToken(String nextToken)

If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Parameters:

nextToken - If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

Returns:

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

maxResults

SearchRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a SearchResponse.

Parameters:

maxResults - The maximum number of results to return in a SearchResponse.

Returns:

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

overrideConfiguration

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

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