software.amazon.awssdk.services.sagemaker.model

Interface DescribeImageVersionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeImageVersionResponse

public static interface DescribeImageVersionResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeImageVersionResponse.Builder,DescribeImageVersionResponse>

Method Summary

Modifier and Type	Method and Description
DescribeImageVersionResponse.Builder	baseImage(String baseImage) The registry path of the container image on which this image version is based.
DescribeImageVersionResponse.Builder	containerImage(String containerImage) The registry path of the container image that contains this image version.
DescribeImageVersionResponse.Builder	creationTime(Instant creationTime) When the version was created.
DescribeImageVersionResponse.Builder	failureReason(String failureReason) When a create or delete operation fails, the reason for the failure.
DescribeImageVersionResponse.Builder	horovod(Boolean horovod) Indicates Horovod compatibility.
DescribeImageVersionResponse.Builder	imageArn(String imageArn) The ARN of the image the version is based on.
DescribeImageVersionResponse.Builder	imageVersionArn(String imageVersionArn) The ARN of the version.
DescribeImageVersionResponse.Builder	imageVersionStatus(ImageVersionStatus imageVersionStatus) The status of the version.
DescribeImageVersionResponse.Builder	imageVersionStatus(String imageVersionStatus) The status of the version.
DescribeImageVersionResponse.Builder	jobType(JobType jobType) Indicates SageMaker job type compatibility.
DescribeImageVersionResponse.Builder	jobType(String jobType) Indicates SageMaker job type compatibility.
DescribeImageVersionResponse.Builder	lastModifiedTime(Instant lastModifiedTime) When the version was last modified.
DescribeImageVersionResponse.Builder	mlFramework(String mlFramework) The machine learning framework vended in the image version.
DescribeImageVersionResponse.Builder	processor(Processor processor) Indicates CPU or GPU compatibility.
DescribeImageVersionResponse.Builder	processor(String processor) Indicates CPU or GPU compatibility.
DescribeImageVersionResponse.Builder	programmingLang(String programmingLang) The supported programming language and its version.
DescribeImageVersionResponse.Builder	releaseNotes(String releaseNotes) The maintainer description of the image version.
DescribeImageVersionResponse.Builder	vendorGuidance(String vendorGuidance) The stability of the image version specified by the maintainer.
DescribeImageVersionResponse.Builder	vendorGuidance(VendorGuidance vendorGuidance) The stability of the image version specified by the maintainer.
DescribeImageVersionResponse.Builder	version(Integer version) The version number.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

baseImage

DescribeImageVersionResponse.Builder baseImage(String baseImage)

The registry path of the container image on which this image version is based.

Parameters:

baseImage - The registry path of the container image on which this image version is based.

Returns:

Returns a reference to this object so that method calls can be chained together.

containerImage

DescribeImageVersionResponse.Builder containerImage(String containerImage)

The registry path of the container image that contains this image version.

Parameters:

containerImage - The registry path of the container image that contains this image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

DescribeImageVersionResponse.Builder creationTime(Instant creationTime)

When the version was created.

Parameters:

creationTime - When the version was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReason

DescribeImageVersionResponse.Builder failureReason(String failureReason)

When a create or delete operation fails, the reason for the failure.

Parameters:

failureReason - When a create or delete operation fails, the reason for the failure.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageArn

DescribeImageVersionResponse.Builder imageArn(String imageArn)

The ARN of the image the version is based on.

Parameters:

imageArn - The ARN of the image the version is based on.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageVersionArn

DescribeImageVersionResponse.Builder imageVersionArn(String imageVersionArn)

The ARN of the version.

Parameters:

imageVersionArn - The ARN of the version.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageVersionStatus

DescribeImageVersionResponse.Builder imageVersionStatus(String imageVersionStatus)

The status of the version.

Parameters:

imageVersionStatus - The status of the version.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageVersionStatus, ImageVersionStatus

imageVersionStatus

DescribeImageVersionResponse.Builder imageVersionStatus(ImageVersionStatus imageVersionStatus)

The status of the version.

Parameters:

imageVersionStatus - The status of the version.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImageVersionStatus, ImageVersionStatus

lastModifiedTime

DescribeImageVersionResponse.Builder lastModifiedTime(Instant lastModifiedTime)

When the version was last modified.

Parameters:

lastModifiedTime - When the version was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

version

DescribeImageVersionResponse.Builder version(Integer version)

The version number.

Parameters:

version - The version number.

Returns:

Returns a reference to this object so that method calls can be chained together.

vendorGuidance

DescribeImageVersionResponse.Builder vendorGuidance(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance, VendorGuidance

vendorGuidance

DescribeImageVersionResponse.Builder vendorGuidance(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance, VendorGuidance

jobType

DescribeImageVersionResponse.Builder jobType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

jobType

DescribeImageVersionResponse.Builder jobType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

mlFramework

DescribeImageVersionResponse.Builder mlFramework(String mlFramework)

The machine learning framework vended in the image version.

Parameters:

mlFramework - The machine learning framework vended in the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.

programmingLang

DescribeImageVersionResponse.Builder programmingLang(String programmingLang)

The supported programming language and its version.

Parameters:

programmingLang - The supported programming language and its version.

Returns:

Returns a reference to this object so that method calls can be chained together.

processor

DescribeImageVersionResponse.Builder processor(String processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Processor, Processor

processor

DescribeImageVersionResponse.Builder processor(Processor processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Processor, Processor

horovod

DescribeImageVersionResponse.Builder horovod(Boolean horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility.

Returns:

Returns a reference to this object so that method calls can be chained together.

releaseNotes

DescribeImageVersionResponse.Builder releaseNotes(String releaseNotes)

The maintainer description of the image version.

Parameters:

releaseNotes - The maintainer description of the image version.

Returns:

Returns a reference to this object so that method calls can be chained together.