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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
OptimizationJobSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OptimizationJobSummary.Builder
builder()
Instant
creationTime()
The time when you created the optimization job.OptimizationJobDeploymentInstanceType
deploymentInstanceType()
The type of instance that hosts the optimized model that you create with the optimization job.String
deploymentInstanceTypeAsString()
The type of instance that hosts the optimized model that you create with the optimization job.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasOptimizationTypes()
For responses, this returns true if the service returned a value for the OptimizationTypes property.Instant
lastModifiedTime()
The time when the optimization job was last updated.Instant
optimizationEndTime()
The time when the optimization job finished processing.String
optimizationJobArn()
The Amazon Resource Name (ARN) of the optimization job.String
optimizationJobName()
The name that you assigned to the optimization job.OptimizationJobStatus
optimizationJobStatus()
The current status of the optimization job.String
optimizationJobStatusAsString()
The current status of the optimization job.Instant
optimizationStartTime()
The time when the optimization job started.List<String>
optimizationTypes()
The optimization techniques that are applied by the optimization job.List<SdkField<?>>
sdkFields()
static Class<? extends OptimizationJobSummary.Builder>
serializableBuilderClass()
OptimizationJobSummary.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnOptimizationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptimizationJobStatusAsString()
.- Returns:
- The current status of the optimization job.
- See Also:
OptimizationJobStatus
-
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 returnOptimizationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptimizationJobStatusAsString()
.- Returns:
- The current status of the optimization job.
- See Also:
OptimizationJobStatus
-
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 returnOptimizationJobDeploymentInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentInstanceTypeAsString()
.- Returns:
- The type of instance that hosts the optimized model that you create with the optimization job.
- See Also:
OptimizationJobDeploymentInstanceType
-
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 returnOptimizationJobDeploymentInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentInstanceTypeAsString()
.- Returns:
- The type of instance that hosts the optimized model that you create with the optimization job.
- See Also:
OptimizationJobDeploymentInstanceType
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<OptimizationJobSummary.Builder,OptimizationJobSummary>
-
builder
public static OptimizationJobSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends OptimizationJobSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-