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

Class ListTrialComponentsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTrialComponentsRequest.Builder,ListTrialComponentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTrialComponentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTrialComponentsRequest.Builder	builder()
Instant	createdAfter()	A filter that returns only components created after the specified time.
Instant	createdBefore()	A filter that returns only components created before the specified time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experimentName()	A filter that returns only components that are part of the specified experiment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of components to return in the response.
String	nextToken()	If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTrialComponentsRequest.Builder>	serializableBuilderClass()
SortTrialComponentsBy	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.
String	sourceArn()	A filter that returns only components that have the specified source Amazon Resource Name (ARN).
ListTrialComponentsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trialName()	A filter that returns only components that are part of the specified trial.

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 components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

Returns:

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

trialName

public final String trialName()

A filter that returns only components that are part of the specified trial. If you specify TrialName , you can't filter by ExperimentName or SourceArn.

Returns:

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

sourceArn

public final String sourceArn()

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

Returns:

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName .

createdAfter

public final Instant createdAfter()

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

Returns:

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

createdBefore

public final Instant createdBefore()

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

Returns:

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

sortBy

public final SortTrialComponentsBy 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 SortTrialComponentsBy.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:

SortTrialComponentsBy

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 SortTrialComponentsBy.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:

SortTrialComponentsBy

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 components to return in the response. The default value is 10.

Returns:

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

nextToken

public final String nextToken()

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

Returns:

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

toBuilder

public ListTrialComponentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTrialComponentsRequest.Builder,ListTrialComponentsRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListTrialComponentsRequest.Builder builder()

serializableBuilderClass

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