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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeOptimizationJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeOptimizationJobResponse.Builderbuilder()InstantcreationTime()The time when you created the optimization job.OptimizationJobDeploymentInstanceTypedeploymentInstanceType()The type of instance that hosts the optimized model that you create with the optimization job.StringdeploymentInstanceTypeAsString()The type of instance that hosts the optimized model that you create with the optimization job.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureReason()If the optimization job status isFAILED, the reason for the failure.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOptimizationConfigs()For responses, this returns true if the service returned a value for the OptimizationConfigs property.booleanhasOptimizationEnvironment()For responses, this returns true if the service returned a value for the OptimizationEnvironment property.InstantlastModifiedTime()The time when the optimization job was last updated.OptimizationJobModelSourcemodelSource()The location of the source model to optimize with an optimization job.List<OptimizationConfig>optimizationConfigs()Settings for each of the optimization techniques that the job applies.InstantoptimizationEndTime()The time when the optimization job finished processing.Map<String,String>optimizationEnvironment()The environment variables to set in the model container.StringoptimizationJobArn()The Amazon Resource Name (ARN) of the optimization job.StringoptimizationJobName()The name that you assigned to the optimization job.OptimizationJobStatusoptimizationJobStatus()The current status of the optimization job.StringoptimizationJobStatusAsString()The current status of the optimization job.OptimizationOutputoptimizationOutput()Output values produced by an optimization job.InstantoptimizationStartTime()The time when the optimization job started.OptimizationJobOutputConfigoutputConfig()Details for where to store the optimized model that you create with the optimization job.StringroleArn()The ARN of the IAM role that you assigned to the optimization job.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeOptimizationJobResponse.Builder>serializableBuilderClass()StoppingConditionstoppingCondition()Returns the value of the StoppingCondition property for this object.DescribeOptimizationJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.OptimizationVpcConfigvpcConfig()A VPC in Amazon VPC that your optimized model has access to.-
Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
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,
optimizationJobStatuswill 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,
optimizationJobStatuswill 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.
-
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 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.
-
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,
deploymentInstanceTypewill 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,
deploymentInstanceTypewill 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
-
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 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.
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeOptimizationJobResponse.Builder,DescribeOptimizationJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeOptimizationJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeOptimizationJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-