Class DescribeOptimizationJobResponse

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

  • Method Details

    • optimizationJobArn

      public final String optimizationJobArn()

      The Amazon Resource Name (ARN) of the optimization job.

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

    • optimizationJobStatus

      public final OptimizationJobStatus optimizationJobStatus()

      The current status of the optimization job.

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

      Returns:
      The current status of the optimization job.
      See Also:

    • optimizationJobStatusAsString

      public final String optimizationJobStatusAsString()

      The current status of the optimization job.

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

      Returns:
      The current status of the optimization job.
      See Also:

    • optimizationStartTime

      public final Instant optimizationStartTime()

      The time when the optimization job started.

      Returns:
      The time when the optimization job started.

    • optimizationEndTime

      public final Instant optimizationEndTime()

      The time when the optimization job finished processing.

      Returns:
      The time when the optimization job finished processing.

    • creationTime

      public final Instant creationTime()

      The time when you created the optimization job.

      Returns:
      The time when you created the optimization job.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the optimization job was last updated.

      Returns:
      The time when the optimization job was last updated.

    • failureReason

      public final String failureReason()

      If the optimization job status is FAILED, the reason for the failure.

      Returns:
      If the optimization job status is FAILED, the reason for the failure.

    • optimizationJobName

      public final String optimizationJobName()

      The name that you assigned to the optimization job.

      Returns:
      The name that you assigned to the optimization job.

    • modelSource

      public final OptimizationJobModelSource modelSource()

      The location of the source model to optimize with an optimization job.

      Returns:
      The location of the source model to optimize with an optimization job.

    • hasOptimizationEnvironment

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

    • optimizationEnvironment

      public final Map<String,String> optimizationEnvironment()

      The environment variables to set in the model container.

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

      Returns:
      The environment variables to set in the model container.

    • deploymentInstanceType

      public final OptimizationJobDeploymentInstanceType deploymentInstanceType()

      The type of instance that hosts the optimized model that you create with the optimization job.

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

      Returns:
      The type of instance that hosts the optimized model that you create with the optimization job.
      See Also:

    • deploymentInstanceTypeAsString

      public final String deploymentInstanceTypeAsString()

      The type of instance that hosts the optimized model that you create with the optimization job.

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

      Returns:
      The type of instance that hosts the optimized model that you create with the optimization job.
      See Also:

    • hasOptimizationConfigs

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

    • optimizationConfigs

      public final List<OptimizationConfig> optimizationConfigs()

      Settings for each of the optimization techniques that the job applies.

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

      Returns:
      Settings for each of the optimization techniques that the job applies.

    • outputConfig

      public final OptimizationJobOutputConfig outputConfig()

      Details for where to store the optimized model that you create with the optimization job.

      Returns:
      Details for where to store the optimized model that you create with the optimization job.

    • optimizationOutput

      public final OptimizationOutput optimizationOutput()

      Output values produced by an optimization job.

      Returns:
      Output values produced by an optimization job.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that you assigned to the optimization job.

      Returns:
      The ARN of the IAM role that you assigned to the optimization job.

    • stoppingCondition

      public final StoppingCondition stoppingCondition()
      Returns the value of the StoppingCondition property for this object.
      Returns:
      The value of the StoppingCondition property for this object.

    • vpcConfig

      public final OptimizationVpcConfig vpcConfig()

      A VPC in Amazon VPC that your optimized model has access to.

      Returns:
      A VPC in Amazon VPC that your optimized model has access to.

    • toBuilder

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

    • builder

      public static DescribeOptimizationJobResponse.Builder builder()

    • serializableBuilderClass

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