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

Class ListInferenceRecommendationsJobStepsRequest

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

  • Method Details

    • jobName

      public final String jobName()

      The name for the Inference Recommender job.

      Returns:
      The name for the Inference Recommender job.

    • status

      public final RecommendationJobStatus status()

      A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

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

      Returns:
      A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
      See Also:

    • statusAsString

      public final String statusAsString()

      A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

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

      Returns:
      A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
      See Also:

    • stepType

      public final RecommendationStepType stepType()

      A filter to return details about the specified type of subtask.

      BENCHMARK: Evaluate the performance of your model on different instance types.

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

      Returns:
      A filter to return details about the specified type of subtask.

      BENCHMARK: Evaluate the performance of your model on different instance types.

      See Also:

    • stepTypeAsString

      public final String stepTypeAsString()

      A filter to return details about the specified type of subtask.

      BENCHMARK: Evaluate the performance of your model on different instance types.

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

      Returns:
      A filter to return details about the specified type of subtask.

      BENCHMARK: Evaluate the performance of your model on different instance types.

      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • nextToken

      public final String nextToken()

      A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

      Returns:
      A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous request.

    • toBuilder

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

    • builder

      public static ListInferenceRecommendationsJobStepsRequest.Builder builder()

    • serializableBuilderClass

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