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

Class DescribeAutoMlJobResponse

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

  • Method Details

    • autoMLJobName

      public final String autoMLJobName()

      Returns the name of the AutoML job.

      Returns:
      Returns the name of the AutoML job.

    • autoMLJobArn

      public final String autoMLJobArn()

      Returns the ARN of the AutoML job.

      Returns:
      Returns the ARN of the AutoML job.

    • hasInputDataConfig

      public final boolean hasInputDataConfig()
      For responses, this returns true if the service returned a value for the InputDataConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • inputDataConfig

      public final List<AutoMLChannel> inputDataConfig()

      Returns the input data configuration for the AutoML job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputDataConfig() method.

      Returns:
      Returns the input data configuration for the AutoML job.

    • outputDataConfig

      public final AutoMLOutputDataConfig outputDataConfig()

      Returns the job's output data config.

      Returns:
      Returns the job's output data config.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

      Returns:
      The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.

    • autoMLJobObjective

      public final AutoMLJobObjective autoMLJobObjective()

      Returns the job's objective.

      Returns:
      Returns the job's objective.

    • problemType

      public final ProblemType problemType()

      Returns the job's problem type.

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

      Returns:
      Returns the job's problem type.
      See Also:

    • problemTypeAsString

      public final String problemTypeAsString()

      Returns the job's problem type.

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

      Returns:
      Returns the job's problem type.
      See Also:

    • autoMLJobConfig

      public final AutoMLJobConfig autoMLJobConfig()

      Returns the configuration for the AutoML job.

      Returns:
      Returns the configuration for the AutoML job.

    • creationTime

      public final Instant creationTime()

      Returns the creation time of the AutoML job.

      Returns:
      Returns the creation time of the AutoML job.

    • endTime

      public final Instant endTime()

      Returns the end time of the AutoML job.

      Returns:
      Returns the end time of the AutoML job.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      Returns the job's last modified time.

      Returns:
      Returns the job's last modified time.

    • failureReason

      public final String failureReason()

      Returns the failure reason for an AutoML job, when applicable.

      Returns:
      Returns the failure reason for an AutoML job, when applicable.

    • hasPartialFailureReasons

      public final boolean hasPartialFailureReasons()
      For responses, this returns true if the service returned a value for the PartialFailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • partialFailureReasons

      public final List<AutoMLPartialFailureReason> partialFailureReasons()

      Returns a list of reasons for partial failures within an AutoML job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartialFailureReasons() method.

      Returns:
      Returns a list of reasons for partial failures within an AutoML job.

    • bestCandidate

      public final AutoMLCandidate bestCandidate()

      The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

      Returns:
      The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

    • autoMLJobStatus

      public final AutoMLJobStatus autoMLJobStatus()

      Returns the status of the AutoML job.

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

      Returns:
      Returns the status of the AutoML job.
      See Also:

    • autoMLJobStatusAsString

      public final String autoMLJobStatusAsString()

      Returns the status of the AutoML job.

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

      Returns:
      Returns the status of the AutoML job.
      See Also:

    • autoMLJobSecondaryStatus

      public final AutoMLJobSecondaryStatus autoMLJobSecondaryStatus()

      Returns the secondary status of the AutoML job.

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

      Returns:
      Returns the secondary status of the AutoML job.
      See Also:

    • autoMLJobSecondaryStatusAsString

      public final String autoMLJobSecondaryStatusAsString()

      Returns the secondary status of the AutoML job.

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

      Returns:
      Returns the secondary status of the AutoML job.
      See Also:

    • generateCandidateDefinitionsOnly

      public final Boolean generateCandidateDefinitionsOnly()

      Indicates whether the output for an AutoML job generates candidate definitions only.

      Returns:
      Indicates whether the output for an AutoML job generates candidate definitions only.

    • autoMLJobArtifacts

      public final AutoMLJobArtifacts autoMLJobArtifacts()

      Returns information on the job's artifacts found in AutoMLJobArtifacts.

      Returns:
      Returns information on the job's artifacts found in AutoMLJobArtifacts.

    • resolvedAttributes

      public final ResolvedAttributes resolvedAttributes()

      Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

      Returns:
      Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

    • modelDeployConfig

      public final ModelDeployConfig modelDeployConfig()

      Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

      Returns:
      Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

    • modelDeployResult

      public final ModelDeployResult modelDeployResult()

      Provides information about endpoint for the model deployment.

      Returns:
      Provides information about endpoint for the model deployment.

    • toBuilder

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

    • builder

      public static DescribeAutoMlJobResponse.Builder builder()

    • serializableBuilderClass

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