software.amazon.awssdk.services.sagemaker.model

Class ListAlgorithmsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAlgorithmsRequest.Builder,ListAlgorithmsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAlgorithmsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListAlgorithmsRequest.Builder	builder()
Instant	creationTimeAfter() A filter that returns only algorithms created after the specified time (timestamp).
Instant	creationTimeBefore() A filter that returns only algorithms 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 algorithms to return in the response.
String	nameContains() A string in the algorithm name.
String	nextToken() If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAlgorithmsRequest.Builder>	serializableBuilderClass()
AlgorithmSortBy	sortBy() The parameter by which to sort the results.
String	sortByAsString() The parameter by which to sort the results.
SortOrder	sortOrder() The sort order for the results.
String	sortOrderAsString() The sort order for the results.
ListAlgorithmsRequest.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

creationTimeAfter

public final Instant creationTimeAfter()

A filter that returns only algorithms created after the specified time (timestamp).

Returns:

A filter that returns only algorithms created after the specified time (timestamp).

creationTimeBefore

public final Instant creationTimeBefore()

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

Returns:

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

maxResults

public final Integer maxResults()

The maximum number of algorithms to return in the response.

Returns:

The maximum number of algorithms to return in the response.

nameContains

public final String nameContains()

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

Returns:

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

nextToken

public final String nextToken()

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

Returns:

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

sortBy

public final AlgorithmSortBy sortBy()

The parameter by which to sort the results. The default is CreationTime.

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

Returns:

The parameter by which to sort the results. The default is CreationTime.

See Also:

AlgorithmSortBy

sortByAsString

public final String sortByAsString()

The parameter by which to sort the results. The default is CreationTime.

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

Returns:

The parameter by which to sort the results. The default is CreationTime.

See Also:

AlgorithmSortBy

sortOrder

public final SortOrder sortOrder()

The sort order for the results. The default is Ascending.

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

Returns:

The sort order for the results. The default is Ascending.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order for the results. The default is Ascending.

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

Returns:

The sort order for the results. The default is Ascending.

See Also:

SortOrder

toBuilder

public ListAlgorithmsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAlgorithmsRequest.Builder,ListAlgorithmsRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListAlgorithmsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListAlgorithmsRequest.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