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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, 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. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

Returns:

A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

sortBy

public String sortBy()

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

Returns:

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

sortOrder

public SearchSortOrder sortOrder()

How SearchResults are ordered. Valid values are Ascending or Descending. The default is 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. The default is Descending.

See Also:

SearchSortOrder

sortOrderAsString

public String sortOrderAsString()

How SearchResults are ordered. Valid values are Ascending or Descending. The default is 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. The default is 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchRequest.Builder,SearchRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static SearchRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo