Class DescribeAlgorithmResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeAlgorithmResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAlgorithmResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeAlgorithmResponse.Builder,DescribeAlgorithmResponse>

  • Method Details

    • algorithmName

      public final String algorithmName()

      The name of the algorithm being described.

      Returns:
      The name of the algorithm being described.

    • algorithmArn

      public final String algorithmArn()

      The Amazon Resource Name (ARN) of the algorithm.

      Returns:
      The Amazon Resource Name (ARN) of the algorithm.

    • algorithmDescription

      public final String algorithmDescription()

      A brief summary about the algorithm.

      Returns:
      A brief summary about the algorithm.

    • creationTime

      public final Instant creationTime()

      A timestamp specifying when the algorithm was created.

      Returns:
      A timestamp specifying when the algorithm was created.

    • trainingSpecification

      public final TrainingSpecification trainingSpecification()

      Details about training jobs run by this algorithm.

      Returns:
      Details about training jobs run by this algorithm.

    • inferenceSpecification

      public final InferenceSpecification inferenceSpecification()

      Details about inference jobs that the algorithm runs.

      Returns:
      Details about inference jobs that the algorithm runs.

    • validationSpecification

      public final AlgorithmValidationSpecification validationSpecification()

      Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

      Returns:
      Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

    • algorithmStatus

      public final AlgorithmStatus algorithmStatus()

      The current status of the algorithm.

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

      Returns:
      The current status of the algorithm.
      See Also:

    • algorithmStatusAsString

      public final String algorithmStatusAsString()

      The current status of the algorithm.

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

      Returns:
      The current status of the algorithm.
      See Also:

    • algorithmStatusDetails

      public final AlgorithmStatusDetails algorithmStatusDetails()

      Details about the current status of the algorithm.

      Returns:
      Details about the current status of the algorithm.

    • productId

      public final String productId()

      The product identifier of the algorithm.

      Returns:
      The product identifier of the algorithm.

    • certifyForMarketplace

      public final Boolean certifyForMarketplace()

      Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

      Returns:
      Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

    • toBuilder

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

    • builder

      public static DescribeAlgorithmResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeAlgorithmResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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