DescribeImageVersionResponse (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeImageVersionResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeImageVersionResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`baseImage()` The registry path of the container image on which this image version is based.
`static DescribeImageVersionResponse.Builder`	`builder()`
`String`	`containerImage()` The registry path of the container image that contains this image version.
`Instant`	`creationTime()` When the version was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` When a create or delete operation fails, the reason for the failure.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`horovod()` Indicates Horovod compatibility.
`String`	`imageArn()` The ARN of the image the version is based on.
`String`	`imageVersionArn()` The ARN of the version.
`ImageVersionStatus`	`imageVersionStatus()` The status of the version.
`String`	`imageVersionStatusAsString()` The status of the version.
`JobType`	`jobType()` Indicates SageMaker job type compatibility.
`String`	`jobTypeAsString()` Indicates SageMaker job type compatibility.
`Instant`	`lastModifiedTime()` When the version was last modified.
`String`	`mlFramework()` The machine learning framework vended in the image version.
`Processor`	`processor()` Indicates CPU or GPU compatibility.
`String`	`processorAsString()` Indicates CPU or GPU compatibility.
`String`	`programmingLang()` The supported programming language and its version.
`String`	`releaseNotes()` The maintainer description of the image version.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeImageVersionResponse.Builder>`	`serializableBuilderClass()`
`DescribeImageVersionResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VendorGuidance`	`vendorGuidance()` The stability of the image version specified by the maintainer.
`String`	`vendorGuidanceAsString()` The stability of the image version specified by the maintainer.
`Integer`	`version()` The version number.

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
  - baseImage
```
public final String baseImage()
```
    The registry path of the container image on which this image version is based.
    
    Returns:
    
    The registry path of the container image on which this image version is based.
  - containerImage
```
public final String containerImage()
```
    The registry path of the container image that contains this image version.
    
    Returns:
    
    The registry path of the container image that contains this image version.
  - creationTime
```
public final Instant creationTime()
```
    When the version was created.
    
    Returns:
    
    When the version was created.
  - failureReason
```
public final String failureReason()
```
    When a create or delete operation fails, the reason for the failure.
    
    Returns:
    
    When a create or delete operation fails, the reason for the failure.
  - imageArn
```
public final String imageArn()
```
    The ARN of the image the version is based on.
    
    Returns:
    
    The ARN of the image the version is based on.
  - imageVersionArn
```
public final String imageVersionArn()
```
    The ARN of the version.
    
    Returns:
    
    The ARN of the version.
  - imageVersionStatus
```
public final ImageVersionStatus imageVersionStatus()
```
    The status of the version.
    
    If the service returns an enum value that is not available in the current SDK version, imageVersionStatus will return ImageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageVersionStatusAsString().
    
    Returns:
    
    The status of the version.
    
    See Also:
    
    ImageVersionStatus
  - imageVersionStatusAsString
```
public final String imageVersionStatusAsString()
```
    The status of the version.
    
    If the service returns an enum value that is not available in the current SDK version, imageVersionStatus will return ImageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageVersionStatusAsString().
    
    Returns:
    
    The status of the version.
    
    See Also:
    
    ImageVersionStatus
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    When the version was last modified.
    
    Returns:
    
    When the version was last modified.
  - version
```
public final Integer version()
```
    The version number.
    
    Returns:
    
    The version number.
  - vendorGuidance
```
public final VendorGuidance vendorGuidance()
```
    The stability of the image version specified by the maintainer.
    - NOT_PROVIDED: The maintainers did not provide a status for image version stability.
    - STABLE: The image version is stable.
    - TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    - ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
    If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().
    Returns:
    The stability of the image version specified by the maintainer.
    
    NOT_PROVIDED: The maintainers did not provide a status for image version stability.
    
    STABLE: The image version is stable.
    
    TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    
    ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
    See Also:
    
    VendorGuidance
  - vendorGuidanceAsString
```
public final String vendorGuidanceAsString()
```
    The stability of the image version specified by the maintainer.
    - NOT_PROVIDED: The maintainers did not provide a status for image version stability.
    - STABLE: The image version is stable.
    - TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    - ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
    If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().
    Returns:
    The stability of the image version specified by the maintainer.
    
    NOT_PROVIDED: The maintainers did not provide a status for image version stability.
    
    STABLE: The image version is stable.
    
    TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    
    ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
    See Also:
    
    VendorGuidance
  - jobType
```
public final JobType jobType()
```
    Indicates SageMaker job type compatibility.
    - TRAINING: The image version is compatible with SageMaker training jobs.
    - INFERENCE: The image version is compatible with SageMaker inference jobs.
    - NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
    If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    Returns:
    Indicates SageMaker job type compatibility.
    
    TRAINING: The image version is compatible with SageMaker training jobs.
    
    INFERENCE: The image version is compatible with SageMaker inference jobs.
    
    NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
    See Also:
    
    JobType
  - jobTypeAsString
```
public final String jobTypeAsString()
```
    Indicates SageMaker job type compatibility.
    - TRAINING: The image version is compatible with SageMaker training jobs.
    - INFERENCE: The image version is compatible with SageMaker inference jobs.
    - NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
    If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    Returns:
    Indicates SageMaker job type compatibility.
    
    TRAINING: The image version is compatible with SageMaker training jobs.
    
    INFERENCE: The image version is compatible with SageMaker inference jobs.
    
    NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
    See Also:
    
    JobType
  - mlFramework
```
public final String mlFramework()
```
    The machine learning framework vended in the image version.
    
    Returns:
    
    The machine learning framework vended in the image version.
  - programmingLang
```
public final String programmingLang()
```
    The supported programming language and its version.
    
    Returns:
    
    The supported programming language and its version.
  - processor
```
public final Processor processor()
```
    Indicates CPU or GPU compatibility.
    - CPU: The image version is compatible with CPU.
    - GPU: The image version is compatible with GPU.
    If the service returns an enum value that is not available in the current SDK version, processor will return Processor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from processorAsString().
    Returns:
    Indicates CPU or GPU compatibility.
    
    CPU: The image version is compatible with CPU.
    
    GPU: The image version is compatible with GPU.
    See Also:
    
    Processor
  - processorAsString
```
public final String processorAsString()
```
    Indicates CPU or GPU compatibility.
    - CPU: The image version is compatible with CPU.
    - GPU: The image version is compatible with GPU.
    If the service returns an enum value that is not available in the current SDK version, processor will return Processor.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from processorAsString().
    Returns:
    Indicates CPU or GPU compatibility.
    
    CPU: The image version is compatible with CPU.
    
    GPU: The image version is compatible with GPU.
    See Also:
    
    Processor
  - horovod
```
public final Boolean horovod()
```
    Indicates Horovod compatibility.
    
    Returns:
    
    Indicates Horovod compatibility.
  - releaseNotes
```
public final String releaseNotes()
```
    The maintainer description of the image version.
    
    Returns:
    
    The maintainer description of the image version.
  - toBuilder
```
public DescribeImageVersionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeImageVersionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeImageVersionResponse.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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeImageVersionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

baseImage

containerImage

creationTime

failureReason

imageArn

imageVersionArn

imageVersionStatus

imageVersionStatusAsString

lastModifiedTime

version

vendorGuidance

vendorGuidanceAsString

jobType

jobTypeAsString

mlFramework

programmingLang

processor

processorAsString

horovod

releaseNotes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields