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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ListTrialsRequest.Builder,ListTrialsRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.