Class ListTrialsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTrialsRequest.Builder,
ListTrialsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListTrialsRequest.Builder
builder()
final Instant
A filter that returns only trials created after the specified time.final Instant
A filter that returns only trials created before the specified time.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A filter that returns only trials that are part of the specified experiment.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of trials to return in the response.final String
If the previous call toListTrials
didn't return the full set of trials, the call returns a token for getting the next set of trials.static Class
<? extends ListTrialsRequest.Builder> final SortTrialsBy
sortBy()
The property used to sort results.final String
The property used to sort results.final SortOrder
The sort order.final String
The sort order.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
A filter that returns only trials created after the specified time.
- Returns:
- A filter that returns only trials created after the specified time.
-
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
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 returnSortTrialsBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The property used to sort results. The default value is
CreationTime
. - See Also:
-
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 returnSortTrialsBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The property used to sort results. The default value is
CreationTime
. - See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order. The default value is
Descending
. - See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order. The default value is
Descending
. - See Also:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTrialsRequest.Builder,
ListTrialsRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-