java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.virtual.disk.Image

```
@ApiType("SoftLayer_Virtual_Disk_Image")
public class Image
extends Entity
```
The virtual disk image data type presents the structure in which a virtual disk image will be presented.

Virtual block devices are assigned to disk images.

See Also:

SoftLayer_Virtual_Disk_Image

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Image.Mask

static interface Image.Service

static interface Image.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected Image`	`billingItem`	The billing item for a virtual disk image.
`protected Long`	`blockDeviceCount`	A count of the block devices that a disk image is attached to.
`protected List<Device>`	`blockDevices`	The block devices that a disk image is attached to.
`protected Boolean`	`bootableVolumeFlag`
`protected Long`	`capacity`	A disk image's size measured in gigabytes.
`protected boolean`	`capacitySpecified`
`protected String`	`checksum`	A disk image's unique md5 checksum.
`protected String`	`checksumAlgorithm`	A column to save the Algorithm being used to store the checksum.
`protected boolean`	`checksumAlgorithmSpecified`
`protected boolean`	`checksumSpecified`
`protected Boolean`	`cloudInitFlag`	Check if cloud-init is enabled.
`protected Long`	`coalescedDiskImageCount`	A count of
`protected List<Image>`	`coalescedDiskImages`
`protected Boolean`	`copyOnWriteFlag`
`protected GregorianCalendar`	`createDate`	The date a disk image was created.
`protected boolean`	`createDateSpecified`
`protected String`	`description`	A brief description of a virtual disk image.
`protected boolean`	`descriptionSpecified`
`protected String`	`diskFileExtension`	Return disk file extension
`protected Group`	`diskImageStorageGroup`
`protected Long`	`id`	A disk image's unique ID.
`protected boolean`	`idSpecified`
`protected String`	`importedDiskType`	Return imported disk type
`protected Boolean`	`isEncrypted`	Return if image is encrypted
`protected Boolean`	`localDiskFlag`
`protected Boolean`	`metadataFlag`	Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.
`protected GregorianCalendar`	`modifyDate`	The date a disk image was last modified.
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	A descriptive name used to identify a disk image to a user.
`protected boolean`	`nameSpecified`
`protected Long`	`parentId`	The ID of the the disk image that this disk image is based on, if applicable.
`protected boolean`	`parentIdSpecified`
`protected Long`	`softwareReferenceCount`	A count of references to the software that resides on a disk image.
`protected List<Software>`	`softwareReferences`	References to the software that resides on a disk image.
`protected Image`	`sourceDiskImage`	The original disk image that the current disk image was cloned from.
`protected Long`	`storageGroupCount`	A count of the storage group for a virtual disk image.
`protected StorageGroupDetails`	`storageGroupDetails`	Return storage group details for symantec disk
`protected List<Group>`	`storageGroups`	The storage group for a virtual disk image.
`protected Repository`	`storageRepository`	The storage repository that a disk image resides in.
`protected Long`	`storageRepositoryId`	The [[SoftLayer_Virtual_Storage_Repository\|storage repository]] that a disk image is in.
`protected boolean`	`storageRepositoryIdSpecified`
`protected Type`	`storageRepositoryType`	The type of storage repository that a disk image resides in.
`protected String`	`supportedHardware`	Return supported hardware component IDs for symantec disk
`protected Template`	`templateBlockDevice`	The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group\|archive]].
`protected Type`	`type`	A virtual disk image's type.
`protected Long`	`typeId`	A disk image's [[SoftLayer_Virtual_Disk_Image_Type\|type]] ID
`protected boolean`	`typeIdSpecified`
`protected String`	`units`	The unit of storage in which the size of the image is measured.
`protected boolean`	`unitsSpecified`
`protected String`	`uuid`	A disk image's unique ID on a virtualization platform.
`protected boolean`	`uuidSpecified`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Image()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Image.Service`	`asService(ApiClient client)`
`Image`	`getBillingItem()`
`Long`	`getBlockDeviceCount()`
`List<Device>`	`getBlockDevices()`
`Boolean`	`getBootableVolumeFlag()`
`Long`	`getCapacity()`
`String`	`getChecksum()`
`String`	`getChecksumAlgorithm()`
`Boolean`	`getCloudInitFlag()`
`Long`	`getCoalescedDiskImageCount()`
`List<Image>`	`getCoalescedDiskImages()`
`Boolean`	`getCopyOnWriteFlag()`
`GregorianCalendar`	`getCreateDate()`
`String`	`getDescription()`
`String`	`getDiskFileExtension()`
`Group`	`getDiskImageStorageGroup()`
`Long`	`getId()`
`String`	`getImportedDiskType()`
`Boolean`	`getIsEncrypted()`
`Boolean`	`getLocalDiskFlag()`
`Boolean`	`getMetadataFlag()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Long`	`getParentId()`
`Long`	`getSoftwareReferenceCount()`
`List<Software>`	`getSoftwareReferences()`
`Image`	`getSourceDiskImage()`
`Long`	`getStorageGroupCount()`
`StorageGroupDetails`	`getStorageGroupDetails()`
`List<Group>`	`getStorageGroups()`
`Repository`	`getStorageRepository()`
`Long`	`getStorageRepositoryId()`
`Type`	`getStorageRepositoryType()`
`String`	`getSupportedHardware()`
`Template`	`getTemplateBlockDevice()`
`Type`	`getType()`
`Long`	`getTypeId()`
`String`	`getUnits()`
`String`	`getUuid()`
`boolean`	`isCapacitySpecified()`
`boolean`	`isChecksumAlgorithmSpecified()`
`boolean`	`isChecksumSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isDescriptionSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isParentIdSpecified()`
`boolean`	`isStorageRepositoryIdSpecified()`
`boolean`	`isTypeIdSpecified()`
`boolean`	`isUnitsSpecified()`
`boolean`	`isUuidSpecified()`
`static Image.Service`	`service(ApiClient client)`
`static Image.Service`	`service(ApiClient client, Long id)`
`void`	`setBillingItem(Image billingItem)`
`void`	`setBlockDeviceCount(Long blockDeviceCount)`
`void`	`setBootableVolumeFlag(Boolean bootableVolumeFlag)`
`void`	`setCapacity(Long capacity)`
`void`	`setChecksum(String checksum)`
`void`	`setChecksumAlgorithm(String checksumAlgorithm)`
`void`	`setCloudInitFlag(Boolean cloudInitFlag)`
`void`	`setCoalescedDiskImageCount(Long coalescedDiskImageCount)`
`void`	`setCopyOnWriteFlag(Boolean copyOnWriteFlag)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDescription(String description)`
`void`	`setDiskFileExtension(String diskFileExtension)`
`void`	`setDiskImageStorageGroup(Group diskImageStorageGroup)`
`void`	`setId(Long id)`
`void`	`setImportedDiskType(String importedDiskType)`
`void`	`setIsEncrypted(Boolean isEncrypted)`
`void`	`setLocalDiskFlag(Boolean localDiskFlag)`
`void`	`setMetadataFlag(Boolean metadataFlag)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setParentId(Long parentId)`
`void`	`setSoftwareReferenceCount(Long softwareReferenceCount)`
`void`	`setSourceDiskImage(Image sourceDiskImage)`
`void`	`setStorageGroupCount(Long storageGroupCount)`
`void`	`setStorageGroupDetails(StorageGroupDetails storageGroupDetails)`
`void`	`setStorageRepository(Repository storageRepository)`
`void`	`setStorageRepositoryId(Long storageRepositoryId)`
`void`	`setStorageRepositoryType(Type storageRepositoryType)`
`void`	`setSupportedHardware(String supportedHardware)`
`void`	`setTemplateBlockDevice(Template templateBlockDevice)`
`void`	`setType(Type type)`
`void`	`setTypeId(Long typeId)`
`void`	`setUnits(String units)`
`void`	`setUuid(String uuid)`
`void`	`unsetCapacity()`
`void`	`unsetChecksum()`
`void`	`unsetChecksumAlgorithm()`
`void`	`unsetCreateDate()`
`void`	`unsetDescription()`
`void`	`unsetId()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetParentId()`
`void`	`unsetStorageRepositoryId()`
`void`	`unsetTypeId()`
`void`	`unsetUnits()`
`void`	`unsetUuid()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

billingItem
```
@ApiProperty
protected Image billingItem
```
The billing item for a virtual disk image.

blockDevices
```
@ApiProperty
protected List<Device> blockDevices
```
The block devices that a disk image is attached to. Block devices connect computing instances to disk images.

bootableVolumeFlag

@ApiProperty
protected Boolean bootableVolumeFlag

cloudInitFlag

@ApiProperty
protected Boolean cloudInitFlag

Check if cloud-init is enabled.

coalescedDiskImages

@ApiProperty
protected List<Image> coalescedDiskImages

copyOnWriteFlag

@ApiProperty
protected Boolean copyOnWriteFlag

diskFileExtension

@ApiProperty
protected String diskFileExtension

Return disk file extension

diskImageStorageGroup

@ApiProperty
protected Group diskImageStorageGroup

importedDiskType

@ApiProperty
protected String importedDiskType

Return imported disk type

isEncrypted

@ApiProperty
protected Boolean isEncrypted

Return if image is encrypted

localDiskFlag

@ApiProperty
protected Boolean localDiskFlag

metadataFlag
```
@ApiProperty
protected Boolean metadataFlag
```
Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.

softwareReferences
```
@ApiProperty
protected List<Software> softwareReferences
```
References to the software that resides on a disk image.

sourceDiskImage
```
@ApiProperty
protected Image sourceDiskImage
```
The original disk image that the current disk image was cloned from.

storageGroupDetails

@ApiProperty
protected StorageGroupDetails storageGroupDetails

Return storage group details for symantec disk

storageGroups
```
@ApiProperty
protected List<Group> storageGroups
```
The storage group for a virtual disk image.

storageRepository
```
@ApiProperty
protected Repository storageRepository
```
The storage repository that a disk image resides in.

storageRepositoryType
```
@ApiProperty
protected Type storageRepositoryType
```
The type of storage repository that a disk image resides in.

supportedHardware
```
@ApiProperty
protected String supportedHardware
```
Return supported hardware component IDs for symantec disk

templateBlockDevice
```
@ApiProperty
protected Template templateBlockDevice
```
The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|archive]].

type
```
@ApiProperty
protected Type type
```
A virtual disk image's type.

capacity

@ApiProperty(canBeNullOrNotSet=true)
protected Long capacity

A disk image's size measured in gigabytes.

capacitySpecified
```
protected boolean capacitySpecified
```

checksum

@ApiProperty(canBeNullOrNotSet=true)
protected String checksum

A disk image's unique md5 checksum.

checksumSpecified
```
protected boolean checksumSpecified
```

checksumAlgorithm
```
@ApiProperty(canBeNullOrNotSet=true)
protected String checksumAlgorithm
```
A column to save the Algorithm being used to store the checksum.

checksumAlgorithmSpecified

protected boolean checksumAlgorithmSpecified

createDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar createDate

The date a disk image was created.

createDateSpecified
```
protected boolean createDateSpecified
```

description

@ApiProperty(canBeNullOrNotSet=true)
protected String description

A brief description of a virtual disk image.

descriptionSpecified
```
protected boolean descriptionSpecified
```

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

A disk image's unique ID.

idSpecified
```
protected boolean idSpecified
```

modifyDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar modifyDate

The date a disk image was last modified.

modifyDateSpecified
```
protected boolean modifyDateSpecified
```

name
```
@ApiProperty(canBeNullOrNotSet=true)
protected String name
```
A descriptive name used to identify a disk image to a user.

nameSpecified
```
protected boolean nameSpecified
```

parentId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long parentId
```
The ID of the the disk image that this disk image is based on, if applicable.

parentIdSpecified
```
protected boolean parentIdSpecified
```

storageRepositoryId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long storageRepositoryId
```
The [[SoftLayer_Virtual_Storage_Repository|storage repository]] that a disk image is in.

storageRepositoryIdSpecified

protected boolean storageRepositoryIdSpecified

typeId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long typeId
```
A disk image's [[SoftLayer_Virtual_Disk_Image_Type|type]] ID

typeIdSpecified
```
protected boolean typeIdSpecified
```

units
```
@ApiProperty(canBeNullOrNotSet=true)
protected String units
```
The unit of storage in which the size of the image is measured. Defaults to "GB" for gigabytes.

unitsSpecified
```
protected boolean unitsSpecified
```

uuid

@ApiProperty(canBeNullOrNotSet=true)
protected String uuid

A disk image's unique ID on a virtualization platform.

uuidSpecified
```
protected boolean uuidSpecified
```

blockDeviceCount
```
@ApiProperty
protected Long blockDeviceCount
```
A count of the block devices that a disk image is attached to. Block devices connect computing instances to disk images.

coalescedDiskImageCount

@ApiProperty
protected Long coalescedDiskImageCount

A count of

softwareReferenceCount
```
@ApiProperty
protected Long softwareReferenceCount
```
A count of references to the software that resides on a disk image.

storageGroupCount
```
@ApiProperty
protected Long storageGroupCount
```
A count of the storage group for a virtual disk image.

Constructor Detail
- Image
```
public Image()
```

Method Detail

getBillingItem
```
public Image getBillingItem()
```

setBillingItem

public void setBillingItem(Image billingItem)

getBlockDevices
```
public List<Device> getBlockDevices()
```

getBootableVolumeFlag

public Boolean getBootableVolumeFlag()

setBootableVolumeFlag

public void setBootableVolumeFlag(Boolean bootableVolumeFlag)

getCloudInitFlag
```
public Boolean getCloudInitFlag()
```

setCloudInitFlag

public void setCloudInitFlag(Boolean cloudInitFlag)

getCoalescedDiskImages

public List<Image> getCoalescedDiskImages()

getCopyOnWriteFlag
```
public Boolean getCopyOnWriteFlag()
```

setCopyOnWriteFlag

public void setCopyOnWriteFlag(Boolean copyOnWriteFlag)

getDiskFileExtension
```
public String getDiskFileExtension()
```

setDiskFileExtension

public void setDiskFileExtension(String diskFileExtension)

getDiskImageStorageGroup

public Group getDiskImageStorageGroup()

setDiskImageStorageGroup

public void setDiskImageStorageGroup(Group diskImageStorageGroup)

getImportedDiskType
```
public String getImportedDiskType()
```

setImportedDiskType

public void setImportedDiskType(String importedDiskType)

getIsEncrypted
```
public Boolean getIsEncrypted()
```

setIsEncrypted

public void setIsEncrypted(Boolean isEncrypted)

getLocalDiskFlag
```
public Boolean getLocalDiskFlag()
```

setLocalDiskFlag

public void setLocalDiskFlag(Boolean localDiskFlag)

getMetadataFlag
```
public Boolean getMetadataFlag()
```

setMetadataFlag

public void setMetadataFlag(Boolean metadataFlag)

getSoftwareReferences

public List<Software> getSoftwareReferences()

getSourceDiskImage
```
public Image getSourceDiskImage()
```

setSourceDiskImage

public void setSourceDiskImage(Image sourceDiskImage)

getStorageGroupDetails

public StorageGroupDetails getStorageGroupDetails()

setStorageGroupDetails

public void setStorageGroupDetails(StorageGroupDetails storageGroupDetails)

getStorageGroups
```
public List<Group> getStorageGroups()
```

getStorageRepository

public Repository getStorageRepository()

setStorageRepository

public void setStorageRepository(Repository storageRepository)

getStorageRepositoryType

public Type getStorageRepositoryType()

setStorageRepositoryType

public void setStorageRepositoryType(Type storageRepositoryType)

getSupportedHardware
```
public String getSupportedHardware()
```

setSupportedHardware

public void setSupportedHardware(String supportedHardware)

getTemplateBlockDevice

public Template getTemplateBlockDevice()

setTemplateBlockDevice

public void setTemplateBlockDevice(Template templateBlockDevice)

getType
```
public Type getType()
```

setType
```
public void setType(Type type)
```

getCapacity
```
public Long getCapacity()
```

setCapacity

public void setCapacity(Long capacity)

isCapacitySpecified
```
public boolean isCapacitySpecified()
```

unsetCapacity
```
public void unsetCapacity()
```

getChecksum
```
public String getChecksum()
```

setChecksum

public void setChecksum(String checksum)

isChecksumSpecified
```
public boolean isChecksumSpecified()
```

unsetChecksum
```
public void unsetChecksum()
```

getChecksumAlgorithm
```
public String getChecksumAlgorithm()
```

setChecksumAlgorithm

public void setChecksumAlgorithm(String checksumAlgorithm)

isChecksumAlgorithmSpecified

public boolean isChecksumAlgorithmSpecified()

unsetChecksumAlgorithm
```
public void unsetChecksumAlgorithm()
```

getCreateDate

public GregorianCalendar getCreateDate()

setCreateDate

public void setCreateDate(GregorianCalendar createDate)

isCreateDateSpecified

public boolean isCreateDateSpecified()

unsetCreateDate
```
public void unsetCreateDate()
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

isDescriptionSpecified

public boolean isDescriptionSpecified()

unsetDescription
```
public void unsetDescription()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getModifyDate

public GregorianCalendar getModifyDate()

setModifyDate

public void setModifyDate(GregorianCalendar modifyDate)

isModifyDateSpecified

public boolean isModifyDateSpecified()

unsetModifyDate
```
public void unsetModifyDate()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getParentId
```
public Long getParentId()
```

setParentId

public void setParentId(Long parentId)

isParentIdSpecified
```
public boolean isParentIdSpecified()
```

unsetParentId
```
public void unsetParentId()
```

getStorageRepositoryId
```
public Long getStorageRepositoryId()
```

setStorageRepositoryId

public void setStorageRepositoryId(Long storageRepositoryId)

isStorageRepositoryIdSpecified

public boolean isStorageRepositoryIdSpecified()

unsetStorageRepositoryId

public void unsetStorageRepositoryId()

getTypeId
```
public Long getTypeId()
```

setTypeId

public void setTypeId(Long typeId)

isTypeIdSpecified
```
public boolean isTypeIdSpecified()
```

unsetTypeId
```
public void unsetTypeId()
```

getUnits
```
public String getUnits()
```

setUnits

public void setUnits(String units)

isUnitsSpecified
```
public boolean isUnitsSpecified()
```

unsetUnits
```
public void unsetUnits()
```

getUuid
```
public String getUuid()
```

setUuid
```
public void setUuid(String uuid)
```

isUuidSpecified
```
public boolean isUuidSpecified()
```

unsetUuid
```
public void unsetUuid()
```

getBlockDeviceCount
```
public Long getBlockDeviceCount()
```

setBlockDeviceCount

public void setBlockDeviceCount(Long blockDeviceCount)

getCoalescedDiskImageCount

public Long getCoalescedDiskImageCount()

setCoalescedDiskImageCount

public void setCoalescedDiskImageCount(Long coalescedDiskImageCount)

getSoftwareReferenceCount

public Long getSoftwareReferenceCount()

setSoftwareReferenceCount

public void setSoftwareReferenceCount(Long softwareReferenceCount)

getStorageGroupCount
```
public Long getStorageGroupCount()
```

setStorageGroupCount

public void setStorageGroupCount(Long storageGroupCount)

asService

public Image.Service asService(ApiClient client)

service

public static Image.Service service(ApiClient client)

service

public static Image.Service service(ApiClient client,
                                    Long id)

Modifier and Type	Class	Description
`static class`	`Image.Mask`
`static interface`	`Image.Service`
`static interface`	`Image.ServiceAsync`

Class Image

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

billingItem

blockDevices

bootableVolumeFlag

cloudInitFlag

coalescedDiskImages

copyOnWriteFlag

diskFileExtension

diskImageStorageGroup

importedDiskType

isEncrypted

localDiskFlag

metadataFlag

softwareReferences

sourceDiskImage

storageGroupDetails

storageGroups

storageRepository

storageRepositoryType

supportedHardware

templateBlockDevice

type

capacity

capacitySpecified

checksum

checksumSpecified

checksumAlgorithm

checksumAlgorithmSpecified

createDate

createDateSpecified

description

descriptionSpecified

id

idSpecified

modifyDate

modifyDateSpecified

name

nameSpecified

parentId

parentIdSpecified

storageRepositoryId

storageRepositoryIdSpecified

typeId

typeIdSpecified

units

unitsSpecified

uuid

uuidSpecified

blockDeviceCount

coalescedDiskImageCount

softwareReferenceCount

storageGroupCount

Constructor Detail

Image

Method Detail

getBillingItem

setBillingItem

getBlockDevices

getBootableVolumeFlag

setBootableVolumeFlag

getCloudInitFlag

setCloudInitFlag

getCoalescedDiskImages

getCopyOnWriteFlag

setCopyOnWriteFlag

getDiskFileExtension

setDiskFileExtension

getDiskImageStorageGroup

setDiskImageStorageGroup

getImportedDiskType

setImportedDiskType

getIsEncrypted