Class OptimizationJobSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.OptimizationJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OptimizationJobSummary.Builder,OptimizationJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class OptimizationJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OptimizationJobSummary.Builder,OptimizationJobSummary>

Summarizes an optimization job by providing some of its key properties.

See Also:

  • Method Details

    • optimizationJobName

      public final String optimizationJobName()

      The name that you assigned to the optimization job.

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

    • optimizationJobArn

      public final String optimizationJobArn()

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

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

    • creationTime

      public final Instant creationTime()

      The time when you created the optimization job.

      Returns:
      The time when you created 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.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the optimization job was last updated.

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

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

    • hasOptimizationTypes

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

    • optimizationTypes

      public final List<String> optimizationTypes()

      The optimization techniques that are applied by the optimization 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 hasOptimizationTypes() method.

      Returns:
      The optimization techniques that are applied by the optimization job.

    • toBuilder

      public OptimizationJobSummary.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<OptimizationJobSummary.Builder,OptimizationJobSummary>
      Returns:
      a builder for type T

    • builder

      public static OptimizationJobSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.