Package software.amazon.awssdk.services.sagemaker.model

Class ListModelsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListModelsRequest.Builder,ListModelsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListModelsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListModelsRequest.Builder	builder()
Instant	creationTimeAfter()	A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
Instant	creationTimeBefore()	A filter that returns only models created before the specified time (timestamp).
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 models to return in the response.
String	nameContains()	A string in the model name.
String	nextToken()	If the response to a previous ListModels request was truncated, the response includes a NextToken.
List<SdkField<?>>	sdkFields()
static Class<? extends ListModelsRequest.Builder>	serializableBuilderClass()
ModelSortKey	sortBy()	Sorts the list of results.
String	sortByAsString()	Sorts the list of results.
OrderKey	sortOrder()	The sort order for results.
String	sortOrderAsString()	The sort order for results.
ListModelsRequest.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

sortBy

public final ModelSortKey sortBy()

Sorts the list of results. The default is CreationTime.

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

Returns:

Sorts the list of results. The default is CreationTime.

See Also:

ModelSortKey

sortByAsString

public final String sortByAsString()

Sorts the list of results. The default is CreationTime.

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

Returns:

Sorts the list of results. The default is CreationTime.

See Also:

ModelSortKey

sortOrder

public final OrderKey sortOrder()

The sort order for results. The default is Descending.

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

Returns:

The sort order for results. The default is Descending.

See Also:

OrderKey

sortOrderAsString

public final String sortOrderAsString()

The sort order for results. The default is Descending.

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

Returns:

The sort order for results. The default is Descending.

See Also:

OrderKey

nextToken

public final String nextToken()

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

Returns:

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

maxResults

public final Integer maxResults()

The maximum number of models to return in the response.

Returns:

The maximum number of models to return in the response.

nameContains

public final String nameContains()

A string in the model name. This filter returns only models whose name contains the specified string.

Returns:

A string in the model name. This filter returns only models whose name contains the specified string.

creationTimeBefore

public final Instant creationTimeBefore()

A filter that returns only models created before the specified time (timestamp).

Returns:

A filter that returns only models created before the specified time (timestamp).

creationTimeAfter

public final Instant creationTimeAfter()

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

Returns:

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

toBuilder

public ListModelsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListModelsRequest.Builder,ListModelsRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListModelsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo