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

Class ListTrialsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTrialsRequest.Builder,ListTrialsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTrialsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTrialsRequest.Builder	builder()
Instant	createdAfter()	A filter that returns only trials created after the specified time.
Instant	createdBefore()	A filter that returns only trials created before the specified time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experimentName()	A filter that returns only trials that are part of the specified experiment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of trials to return in the response.
String	nextToken()	If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTrialsRequest.Builder>	serializableBuilderClass()
SortTrialsBy	sortBy()	The property used to sort results.
String	sortByAsString()	The property used to sort results.
SortOrder	sortOrder()	The sort order.
String	sortOrderAsString()	The sort order.
ListTrialsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trialComponentName()	A filter that returns only trials that are associated with the specified trial component.

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

experimentName

public final String experimentName()

A filter that returns only trials that are part of the specified experiment.

Returns:

A filter that returns only trials that are part of the specified experiment.

trialComponentName

public final String trialComponentName()

A filter that returns only trials that are associated with the specified trial component.

Returns:

A filter that returns only trials that are associated with the specified trial component.

createdAfter

public final Instant createdAfter()

A filter that returns only trials created after the specified time.

Returns:

A filter that returns only trials created after the specified time.

createdBefore

public final Instant createdBefore()

A filter that returns only trials created before the specified time.

Returns:

A filter that returns only trials created before the specified time.

sortBy

public final SortTrialsBy sortBy()

The property used to sort results. The default value is CreationTime.

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

Returns:

The property used to sort results. The default value is CreationTime.

See Also:

SortTrialsBy

sortByAsString

public final String sortByAsString()

The property used to sort results. The default value is CreationTime.

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

Returns:

The property used to sort results. The default value is CreationTime.

See Also:

SortTrialsBy

sortOrder

public final SortOrder sortOrder()

The sort order. The default value is Descending.

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. The default value is Descending.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order. The default value is Descending.

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. The default value is Descending.

See Also:

SortOrder

maxResults

public final Integer maxResults()

The maximum number of trials to return in the response. The default value is 10.

Returns:

The maximum number of trials to return in the response. The default value is 10.

nextToken

public final String nextToken()

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

Returns:

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

toBuilder

public ListTrialsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTrialsRequest.Builder,ListTrialsRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListTrialsRequest.Builder builder()

serializableBuilderClass

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