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

Class DescribeAutoMlJobV2Response

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

  • Method Details

    • autoMLJobName

      public final String autoMLJobName()

      Returns the name of the AutoML job V2.

      Returns:
      Returns the name of the AutoML job V2.

    • autoMLJobArn

      public final String autoMLJobArn()

      Returns the Amazon Resource Name (ARN) of the AutoML job V2.

      Returns:
      Returns the Amazon Resource Name (ARN) of the AutoML job V2.

    • hasAutoMLJobInputDataConfig

      public final boolean hasAutoMLJobInputDataConfig()
      For responses, this returns true if the service returned a value for the AutoMLJobInputDataConfig 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.

    • autoMLJobInputDataConfig

      public final List<AutoMLJobChannel> autoMLJobInputDataConfig()

      Returns an array of channel objects describing the input data and their location.

      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 hasAutoMLJobInputDataConfig() method.

      Returns:
      Returns an array of channel objects describing the input data and their location.

    • 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.

    • autoMLProblemTypeConfig

      public final AutoMLProblemTypeConfig autoMLProblemTypeConfig()

      Returns the configuration settings of the problem type set for the AutoML job V2.

      Returns:
      Returns the configuration settings of the problem type set for the AutoML job V2.

    • autoMLProblemTypeConfigName

      public final AutoMLProblemTypeConfigName autoMLProblemTypeConfigName()

      Returns the name of the problem type configuration set for the AutoML job V2.

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

      Returns:
      Returns the name of the problem type configuration set for the AutoML job V2.
      See Also:

    • autoMLProblemTypeConfigNameAsString

      public final String autoMLProblemTypeConfigNameAsString()

      Returns the name of the problem type configuration set for the AutoML job V2.

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

      Returns:
      Returns the name of the problem type configuration set for the AutoML job V2.
      See Also:

    • creationTime

      public final Instant creationTime()

      Returns the creation time of the AutoML job V2.

      Returns:
      Returns the creation time of the AutoML job V2.

    • endTime

      public final Instant endTime()

      Returns the end time of the AutoML job V2.

      Returns:
      Returns the end time of the AutoML job V2.

    • 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 reason for the failure of the AutoML job V2, when applicable.

      Returns:
      Returns the reason for the failure of the AutoML job V2, 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 V2.

      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 V2.

    • bestCandidate

      public final AutoMLCandidate bestCandidate()

      Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

      Returns:
      Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.

    • autoMLJobStatus

      public final AutoMLJobStatus autoMLJobStatus()

      Returns the status of the AutoML job V2.

      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 V2.
      See Also:

    • autoMLJobStatusAsString

      public final String autoMLJobStatusAsString()

      Returns the status of the AutoML job V2.

      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 V2.
      See Also:

    • autoMLJobSecondaryStatus

      public final AutoMLJobSecondaryStatus autoMLJobSecondaryStatus()

      Returns the secondary status of the AutoML job V2.

      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 V2.
      See Also:

    • autoMLJobSecondaryStatusAsString

      public final String autoMLJobSecondaryStatusAsString()

      Returns the secondary status of the AutoML job V2.

      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 V2.
      See Also:

    • autoMLJobArtifacts

      public final AutoMLJobArtifacts autoMLJobArtifacts()
      Returns the value of the AutoMLJobArtifacts property for this object.
      Returns:
      The value of the AutoMLJobArtifacts property for this object.

    • resolvedAttributes

      public final AutoMLResolvedAttributes resolvedAttributes()

      Returns the resolved attributes used by the AutoML job V2.

      Returns:
      Returns the resolved attributes used by the AutoML job V2.

    • 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.

    • dataSplitConfig

      public final AutoMLDataSplitConfig dataSplitConfig()

      Returns the configuration settings of how the data are split into train and validation datasets.

      Returns:
      Returns the configuration settings of how the data are split into train and validation datasets.

    • securityConfig

      public final AutoMLSecurityConfig securityConfig()

      Returns the security configuration for traffic encryption or Amazon VPC settings.

      Returns:
      Returns the security configuration for traffic encryption or Amazon VPC settings.

    • toBuilder

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

    • builder

      public static DescribeAutoMlJobV2Response.Builder builder()

    • serializableBuilderClass

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