Image (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class Image

java.lang.Object
- com.amazonaws.services.sagemaker.model.Image

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Image
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Image ()

Constructors
Constructor and Description
`Image ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`Image`	`clone ()`
`boolean`	`equals (Object obj)`
`Date`	`getCreationTime ()` When the image was created.
`String`	`getDescription ()` The description of the image.
`String`	`getDisplayName ()` The name of the image as displayed.
`String`	`getFailureReason ()` When a create, update, or delete operation fails, the reason for the failure.
`String`	`getImageArn ()` The ARN of the image.
`String`	`getImageName ()` The name of the image.
`String`	`getImageStatus ()` The status of the image.
`Date`	`getLastModifiedTime ()` When the image was last modified.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime (Date creationTime)` When the image was created.
`void`	`setDescription (String description)` The description of the image.
`void`	`setDisplayName (String displayName)` The name of the image as displayed.
`void`	`setFailureReason (String failureReason)` When a create, update, or delete operation fails, the reason for the failure.
`void`	`setImageArn (String imageArn)` The ARN of the image.
`void`	`setImageName (String imageName)` The name of the image.
`void`	`setImageStatus (String imageStatus)` The status of the image.
`void`	`setLastModifiedTime (Date lastModifiedTime)` When the image was last modified.
`String`	`toString ()` Returns a string representation of this object.
`Image`	`withCreationTime (Date creationTime)` When the image was created.
`Image`	`withDescription (String description)` The description of the image.
`Image`	`withDisplayName (String displayName)` The name of the image as displayed.
`Image`	`withFailureReason (String failureReason)` When a create, update, or delete operation fails, the reason for the failure.
`Image`	`withImageArn (String imageArn)` The ARN of the image.
`Image`	`withImageName (String imageName)` The name of the image.
`Image`	`withImageStatus (ImageStatus imageStatus)` The status of the image.
`Image`	`withImageStatus (String imageStatus)` The status of the image.
`Image`	`withLastModifiedTime (Date lastModifiedTime)` When the image was last modified.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Image
```
public Image()
```
- Method Detail
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    When the image was created.
    
    Parameters:
    
    creationTime - When the image was created.
  - getCreationTime
```
public Date getCreationTime()
```
    When the image was created.
    
    Returns:
    
    When the image was created.
  - withCreationTime
```
public Image withCreationTime(Date creationTime)
```
    When the image was created.
    
    Parameters:
    
    creationTime - When the image was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the image.
    
    Parameters:
    
    description - The description of the image.
  - getDescription
```
public String getDescription()
```
    The description of the image.
    
    Returns:
    
    The description of the image.
  - withDescription
```
public Image withDescription(String description)
```
    The description of the image.
    
    Parameters:
    
    description - The description of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The name of the image as displayed.
    
    Parameters:
    
    displayName - The name of the image as displayed.
  - getDisplayName
```
public String getDisplayName()
```
    The name of the image as displayed.
    
    Returns:
    
    The name of the image as displayed.
  - withDisplayName
```
public Image withDisplayName(String displayName)
```
    The name of the image as displayed.
    
    Parameters:
    
    displayName - The name of the image as displayed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    When a create, update, or delete operation fails, the reason for the failure.
    
    Parameters:
    
    failureReason - When a create, update, or delete operation fails, the reason for the failure.
  - getFailureReason
```
public String getFailureReason()
```
    When a create, update, or delete operation fails, the reason for the failure.
    
    Returns:
    
    When a create, update, or delete operation fails, the reason for the failure.
  - withFailureReason
```
public Image withFailureReason(String failureReason)
```
    When a create, update, or delete operation fails, the reason for the failure.
    
    Parameters:
    
    failureReason - When a create, update, or delete operation fails, the reason for the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageArn
```
public void setImageArn(String imageArn)
```
    The ARN of the image.
    
    Parameters:
    
    imageArn - The ARN of the image.
  - getImageArn
```
public String getImageArn()
```
    The ARN of the image.
    
    Returns:
    
    The ARN of the image.
  - withImageArn
```
public Image withImageArn(String imageArn)
```
    The ARN of the image.
    
    Parameters:
    
    imageArn - The ARN of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageName
```
public void setImageName(String imageName)
```
    The name of the image.
    
    Parameters:
    
    imageName - The name of the image.
  - getImageName
```
public String getImageName()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - withImageName
```
public Image withImageName(String imageName)
```
    The name of the image.
    
    Parameters:
    
    imageName - The name of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageStatus
```
public void setImageStatus(String imageStatus)
```
    The status of the image.
    
    Parameters:
    
    imageStatus - The status of the image.
    
    See Also:
    
    ImageStatus
  - getImageStatus
```
public String getImageStatus()
```
    The status of the image.
    
    Returns:
    
    The status of the image.
    
    See Also:
    
    ImageStatus
  - withImageStatus
```
public Image withImageStatus(String imageStatus)
```
    The status of the image.
    
    Parameters:
    
    imageStatus - The status of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageStatus
  - withImageStatus
```
public Image withImageStatus(ImageStatus imageStatus)
```
    The status of the image.
    
    Parameters:
    
    imageStatus - The status of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageStatus
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    When the image was last modified.
    
    Parameters:
    
    lastModifiedTime - When the image was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    When the image was last modified.
    
    Returns:
    
    When the image was last modified.
  - withLastModifiedTime
```
public Image withLastModifiedTime(Date lastModifiedTime)
```
    When the image was last modified.
    
    Parameters:
    
    lastModifiedTime - When the image was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Image clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class Image

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Image

Method Detail

setCreationTime

getCreationTime

withCreationTime

setDescription

getDescription

withDescription

setDisplayName

getDisplayName

withDisplayName

setFailureReason

getFailureReason

withFailureReason

setImageArn

getImageArn

withImageArn

setImageName

getImageName

withImageName

setImageStatus

getImageStatus

withImageStatus

withImageStatus

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

toString

equals

hashCode

clone

marshall