software.amazon.awssdk.services.sagemaker.model

Class SearchRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.SearchRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchRequest.Builder,SearchRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchRequest
extends SageMakerRequest
implements ToCopyableBuilder<SearchRequest.Builder,SearchRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results to return in a SearchResponse.
String	nextToken() If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken.
ResourceType	resource() The name of the Amazon SageMaker resource to search for.
String	resourceAsString() The name of the Amazon SageMaker resource to search for.
List<SdkField<?>>	sdkFields()
SearchExpression	searchExpression() A Boolean conditional statement.
static Class<? extends SearchRequest.Builder>	serializableBuilderClass()
String	sortBy() The name of the resource property used to sort the SearchResults.
SearchSortOrder	sortOrder() How SearchResults are ordered.
String	sortOrderAsString() How SearchResults are ordered.
SearchRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

resource

public ResourceType resource()

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

If the service returns an enum value that is not available in the current SDK version, resource will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceAsString().

Returns:

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

See Also:

ResourceType

resourceAsString

public String resourceAsString()

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

If the service returns an enum value that is not available in the current SDK version, resource will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceAsString().

Returns:

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

See Also:

ResourceType

searchExpression

public SearchExpression searchExpression()

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

Returns:

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

sortBy

public String sortBy()

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

Returns:

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

sortOrder

public SearchSortOrder sortOrder()

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

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SearchSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

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

See Also:

SearchSortOrder

sortOrderAsString

public String sortOrderAsString()

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

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SearchSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

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

See Also:

SearchSortOrder

nextToken

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

Returns:

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.

maxResults

public Integer maxResults()

The maximum number of results to return in a SearchResponse.

Returns:

The maximum number of results to return in a SearchResponse.

toBuilder

public SearchRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SearchRequest.Builder,SearchRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static SearchRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.