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

Class ListCandidatesForAutoMlJobRequest

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

  • Method Details

    • autoMLJobName

      public final String autoMLJobName()

      List the candidates created for the job by providing the job's name.

      Returns:
      List the candidates created for the job by providing the job's name.

    • statusEquals

      public final CandidateStatus statusEquals()

      List the candidates for the job and filter by status.

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

      Returns:
      List the candidates for the job and filter by status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      List the candidates for the job and filter by status.

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

      Returns:
      List the candidates for the job and filter by status.
      See Also:

    • candidateNameEquals

      public final String candidateNameEquals()

      List the candidates for the job and filter by candidate name.

      Returns:
      List the candidates for the job and filter by candidate name.

    • sortOrder

      public final AutoMLSortOrder sortOrder()

      The sort order for the results. The default is Ascending.

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

      Returns:
      The sort order for the results. The default is Ascending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for the results. The default is Ascending.

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

      Returns:
      The sort order for the results. The default is Ascending.
      See Also:

    • sortBy

      public final CandidateSortBy sortBy()

      The parameter by which to sort the results. The default is Descending.

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

      Returns:
      The parameter by which to sort the results. The default is Descending.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The parameter by which to sort the results. The default is Descending.

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

      Returns:
      The parameter by which to sort the results. The default is Descending.
      See Also:

    • maxResults

      public final Integer maxResults()

      List the job's candidates up to a specified limit.

      Returns:
      List the job's candidates up to a specified limit.

    • nextToken

      public final String nextToken()

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

      Returns:
      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    • toBuilder

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

    • builder

      public static ListCandidatesForAutoMlJobRequest.Builder builder()

    • serializableBuilderClass

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