org.openstack4j.model.image.v2

Interface Image

All Superinterfaces:

BasicResource, Buildable<ImageBuilder>, IdEntity, ModelEntity, Serializable

All Known Implementing Classes:

GlanceImage

public interface Image
extends BasicResource, Buildable<ImageBuilder>

A Glance v2.0-2.3 Image

Author:

emjburns

See Also:

http://developer.openstack.org/api-ref-image-v2.html#showImage-v2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Image.ImageStatus
static class	Image.ImageVisibility

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
String	getAdditionalPropertyValue(String key)
String	getArchitecture()
String	getChecksum()
ContainerFormat	getContainerFormat()
Date	getCreatedAt()
String	getDirectUrl()
DiskFormat	getDiskFormat()
String	getFile()
String	getId()
String	getInstanceUuid()
Boolean	getIsProtected()
String	getKernelId() Pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$
List<String>	getLocations()
Long	getMinDisk()
Long	getMinRam()
String	getName()
String	getOsDistro()
String	getOsVersion()
String	getOwner()
String	getRamdiskId() Pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$
String	getSchema()
String	getSelf()
Long	getSize()
Image.ImageStatus	getStatus()
List<String>	getTags()
Date	getUpdatedAt()
Long	getVirtualSize()
Image.ImageVisibility	getVisibility()

Methods inherited from interface org.openstack4j.model.common.BasicResource

setName

Methods inherited from interface org.openstack4j.model.common.IdEntity

setId

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getStatus

Image.ImageStatus getStatus()

Returns:

image status

getName

String getName()

Specified by:

getName in interface BasicResource

Returns:

image name.

getTags

List<String> getTags()

Returns:

a list of tag objects

getContainerFormat

ContainerFormat getContainerFormat()

Returns:

the container format of the image

getCreatedAt

Date getCreatedAt()

Returns:

the ISO 8601 date and time when the resource was created

getDiskFormat

DiskFormat getDiskFormat()

Returns:

the disk format of the image

getUpdatedAt

Date getUpdatedAt()

Returns:

the ISO 8601 date and time when the resource was updated

getMinDisk

Long getMinDisk()

Returns:

the minimum disk size in GB that is required to boot the image

getIsProtected

Boolean getIsProtected()

Returns:

image protection for deletion Default is false

getId

String getId()

Specified by:

getId in interface IdEntity

Returns:

UUID of the image

getMinRam

Long getMinRam()

Returns:

the minimum amount of RAM in MB that is required to boot the image

getChecksum

String getChecksum()

Returns:

hash that is used over the image data (image service uses this value for verification)

getOwner

String getOwner()

Returns:

the id of teh owner, or tenant, of the image

getVisibility

Image.ImageVisibility getVisibility()

Returns:

image visibility (public or private) Default is private

getSize

Long getSize()

Returns:

the size of the image data, in bytes

getLocations

List<String> getLocations()

Returns:

A list of URLs to access the image file in external store. This list appears if the show_multiple_locations option is set to true in the Image service's configuration file.

getDirectUrl

String getDirectUrl()

Returns:

the URL to access the image file kept in external store This value appears when you set show_image_direct_url option to true in the image service's configuration file

getSelf

String getSelf()

Returns:

the URL for the virtual machine image

getFile

String getFile()

Returns:

the URL for the virtual machine image file

getSchema

String getSchema()

Returns:

the URL for the schema of teh virtual machine image

getRamdiskId

String getRamdiskId()

Pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$

Returns:

ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.

getOsDistro

String getOsDistro()

Returns:

Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html

getOsVersion

String getOsVersion()

Returns:

Operating system version as specified by the distributor

getKernelId

String getKernelId()

Pattern: ^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$

Returns:

ID of image stored in Glance that should be used as the kernel when booting an AMI-style image

getInstanceUuid

String getInstanceUuid()

Returns:

ID of instance used to create this image

getArchitecture

String getArchitecture()

Returns:

Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html

getVirtualSize

Long getVirtualSize()

Returns:

Virtual size of image in bytes (READ-ONLY)

getAdditionalPropertyValue

String getAdditionalPropertyValue(String key)

Returns:

Additional property's value from key https://developer.openstack.org/api-ref/image/v2/index.html#create-an-image