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

Class ListTrainingJobsForHyperParameterTuningJobRequest

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.ListTrainingJobsForHyperParameterTuningJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListTrainingJobsForHyperParameterTuningJobRequest extends SageMakerRequest implements ToCopyableBuilder<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>

  • Method Details

    • hyperParameterTuningJobName

      public final String hyperParameterTuningJobName()

      The name of the tuning job whose training jobs you want to list.

      Returns:
      The name of the tuning job whose training jobs you want to list.

    • nextToken

      public final String nextToken()

      If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

      Returns:
      If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    • maxResults

      public final Integer maxResults()

      The maximum number of training jobs to return. The default value is 10.

      Returns:
      The maximum number of training jobs to return. The default value is 10.

    • statusEquals

      public final TrainingJobStatus statusEquals()

      A filter that returns only training jobs with the specified status.

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

      Returns:
      A filter that returns only training jobs with the specified status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      A filter that returns only training jobs with the specified status.

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

      Returns:
      A filter that returns only training jobs with the specified status.
      See Also:

    • sortBy

      public final TrainingJobSortByOptions sortBy()

      The field to sort results by. The default is Name.

      If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

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

      Returns:
      The field to sort results by. The default is Name.

      If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to sort results by. The default is Name.

      If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

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

      Returns:
      The field to sort results by. The default is Name.

      If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The sort order for 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 results. The default is Ascending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for 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 results. The default is Ascending.
      See Also:

    • toBuilder

      public ListTrainingJobsForHyperParameterTuningJobRequest.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<ListTrainingJobsForHyperParameterTuningJobRequest.Builder,ListTrainingJobsForHyperParameterTuningJobRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static ListTrainingJobsForHyperParameterTuningJobRequest.Builder builder()

    • serializableBuilderClass

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