ModelDescription (AWS Java SDK :: Services :: Lookout Vision 2.17.267 API)

java.lang.Object
- software.amazon.awssdk.services.lookoutvision.model.ModelDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ModelDescription.Builder,ModelDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModelDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ModelDescription.Builder,ModelDescription>

Describes an Amazon Lookout for Vision model.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModelDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModelDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ModelDescription.Builder`	`builder()`
`Instant`	`creationTimestamp()` The unix timestamp for the date and time that the model was created.
`String`	`description()` The description for the model.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`evaluationEndTimestamp()` The unix timestamp for the date and time that the evaluation ended.
`OutputS3Object`	`evaluationManifest()` The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
`OutputS3Object`	`evaluationResult()` The S3 location where Amazon Lookout for Vision saves the performance metrics.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKeyId()` The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
`Integer`	`maxInferenceUnits()` The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.
`Integer`	`minInferenceUnits()` The minimum number of inference units used by the model.
`String`	`modelArn()` The Amazon Resource Name (ARN) of the model.
`String`	`modelVersion()` The version of the model
`OutputConfig`	`outputConfig()` The S3 location where Amazon Lookout for Vision saves model training files.
`ModelPerformance`	`performance()` Performance metrics for the model.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModelDescription.Builder>`	`serializableBuilderClass()`
`ModelStatus`	`status()` The status of the model.
`String`	`statusAsString()` The status of the model.
`String`	`statusMessage()` The status message for the model.
`ModelDescription.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
  - modelVersion
```
public final String modelVersion()
```
    The version of the model
    
    Returns:
    
    The version of the model
  - modelArn
```
public final String modelArn()
```
    The Amazon Resource Name (ARN) of the model.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model.
  - creationTimestamp
```
public final Instant creationTimestamp()
```
    The unix timestamp for the date and time that the model was created.
    
    Returns:
    
    The unix timestamp for the date and time that the model was created.
  - description
```
public final String description()
```
    The description for the model.
    
    Returns:
    
    The description for the model.
  - status
```
public final ModelStatus status()
```
    The status of the model.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the model.
    
    See Also:
    
    ModelStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the model.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the model.
    
    See Also:
    
    ModelStatus
  - statusMessage
```
public final String statusMessage()
```
    The status message for the model.
    
    Returns:
    
    The status message for the model.
  - performance
```
public final ModelPerformance performance()
```
    Performance metrics for the model. Created during training.
    
    Returns:
    
    Performance metrics for the model. Created during training.
  - outputConfig
```
public final OutputConfig outputConfig()
```
    The S3 location where Amazon Lookout for Vision saves model training files.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves model training files.
  - evaluationManifest
```
public final OutputS3Object evaluationManifest()
```
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
  - evaluationResult
```
public final OutputS3Object evaluationResult()
```
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
    
    Returns:
    
    The S3 location where Amazon Lookout for Vision saves the performance metrics.
  - evaluationEndTimestamp
```
public final Instant evaluationEndTimestamp()
```
    The unix timestamp for the date and time that the evaluation ended.
    
    Returns:
    
    The unix timestamp for the date and time that the evaluation ended.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
    
    Returns:
    
    The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
  - minInferenceUnits
```
public final Integer minInferenceUnits()
```
    The minimum number of inference units used by the model. For more information, see StartModel
    
    Returns:
    
    The minimum number of inference units used by the model. For more information, see StartModel
  - maxInferenceUnits
```
public final Integer maxInferenceUnits()
```
    The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
    
    Returns:
    
    The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
  - toBuilder
```
public ModelDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModelDescription.Builder,ModelDescription>
  - builder
```
public static ModelDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModelDescription.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ModelDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelVersion

modelArn

creationTimestamp

description

status

statusAsString

statusMessage

performance

outputConfig

evaluationManifest

evaluationResult

evaluationEndTimestamp

kmsKeyId

minInferenceUnits

maxInferenceUnits

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields