java.lang.Object
- org.openstack4j.openstack.image.v2.domain.GlanceImage

All Implemented Interfaces:

Serializable, Buildable<ImageBuilder>, BasicResource, IdEntity, Image, ModelEntity
```
public class GlanceImage
extends Object
implements Image
```
A glance v2.0-2.3 image model implementation

Author:

emjburns

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GlanceImage.ImageConcreteBuilder

static class GlanceImage.Images

static class GlanceImage.Location
- Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable
  Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>
- Nested classes/interfaces inherited from interface org.openstack4j.model.image.v2.Image
  Image.ImageStatus, Image.ImageVisibility

Constructor Summary

Constructors
Constructor Description

GlanceImage()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ImageBuilder`	`builder()`
`Map<String,String>`	`getAdditionalProperties()`
`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<GlanceImage.Location>`	`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()`
`void`	`setAdditionalProperty(String key, String value)`
`void`	`setId(String id)`	Sets the identifier for this resource.
`void`	`setName(String name)`	Sets the name for this resource
`ImageBuilder`	`toBuilder()`
`String`	`toString()`

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

- Constructor Detail
  - GlanceImage
```
public GlanceImage()
```
- Method Detail
  - builder
```
public static ImageBuilder builder()
```
  - getStatus
```
public Image.ImageStatus getStatus()
```
    Specified by:
    
    getStatus in interface Image
    
    Returns:
    
    image status
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface BasicResource
    
    Specified by:
    
    getName in interface Image
    
    Returns:
    
    image name.
  - setName
```
public void setName(String name)
```
    Sets the name for this resource
    
    Specified by:
    
    setName in interface BasicResource
    
    Parameters:
    
    name - the name to set
  - getTags
```
public List<String> getTags()
```
    Specified by:
    
    getTags in interface Image
    
    Returns:
    
    a list of tag objects
  - getContainerFormat
```
public ContainerFormat getContainerFormat()
```
    Specified by:
    
    getContainerFormat in interface Image
    
    Returns:
    
    the container format of the image
  - getCreatedAt
```
public Date getCreatedAt()
```
    Specified by:
    
    getCreatedAt in interface Image
    
    Returns:
    
    the ISO 8601 date and time when the resource was created
  - getDiskFormat
```
public DiskFormat getDiskFormat()
```
    Specified by:
    
    getDiskFormat in interface Image
    
    Returns:
    
    the disk format of the image
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Specified by:
    
    getUpdatedAt in interface Image
    
    Returns:
    
    the ISO 8601 date and time when the resource was updated
  - getMinDisk
```
public Long getMinDisk()
```
    Specified by:
    
    getMinDisk in interface Image
    
    Returns:
    
    the minimum disk size in GB that is required to boot the image
  - getIsProtected
```
public Boolean getIsProtected()
```
    Specified by:
    
    getIsProtected in interface Image
    
    Returns:
    
    image protection for deletion Default is false
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface IdEntity
    
    Specified by:
    
    getId in interface Image
    
    Returns:
    
    UUID of the image
  - setId
```
public void setId(String id)
```
    Sets the identifier for this resource. Note: creating a new resource should not have the idenfier set since OpenStack will assign one on the create call
    
    Specified by:
    
    setId in interface IdEntity
    
    Parameters:
    
    id - the identifier
  - getMinRam
```
public Long getMinRam()
```
    Specified by:
    
    getMinRam in interface Image
    
    Returns:
    
    the minimum amount of RAM in MB that is required to boot the image
  - getChecksum
```
public String getChecksum()
```
    Specified by:
    
    getChecksum in interface Image
    
    Returns:
    
    hash that is used over the image data (image service uses this value for verification)
  - getOwner
```
public String getOwner()
```
    Specified by:
    
    getOwner in interface Image
    
    Returns:
    
    the id of teh owner, or tenant, of the image
  - getVisibility
```
public Image.ImageVisibility getVisibility()
```
    Specified by:
    
    getVisibility in interface Image
    
    Returns:
    
    image visibility (public or private) Default is private
  - getSize
```
public Long getSize()
```
    Specified by:
    
    getSize in interface Image
    
    Returns:
    
    the size of the image data, in bytes
  - getLocations
```
public List<GlanceImage.Location> getLocations()
```
    Specified by:
    
    getLocations in interface Image
    
    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
```
public String getDirectUrl()
```
    Specified by:
    
    getDirectUrl in interface Image
    
    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
```
public String getSelf()
```
    Specified by:
    
    getSelf in interface Image
    
    Returns:
    
    the URL for the virtual machine image
  - getFile
```
public String getFile()
```
    Specified by:
    
    getFile in interface Image
    
    Returns:
    
    the URL for the virtual machine image file
  - getSchema
```
public String getSchema()
```
    Specified by:
    
    getSchema in interface Image
    
    Returns:
    
    the URL for the schema of teh virtual machine image
  - getRamdiskId
```
public 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}$
    
    Specified by:
    
    getRamdiskId in interface Image
    
    Returns:
    
    ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.
  - getOsDistro
```
public String getOsDistro()
```
    Specified by:
    
    getOsDistro in interface Image
    
    Returns:
    
    Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html
  - getOsVersion
```
public String getOsVersion()
```
    Specified by:
    
    getOsVersion in interface Image
    
    Returns:
    
    Operating system version as specified by the distributor
  - getKernelId
```
public 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}$
    
    Specified by:
    
    getKernelId in interface Image
    
    Returns:
    
    ID of image stored in Glance that should be used as the kernel when booting an AMI-style image
  - getInstanceUuid
```
public String getInstanceUuid()
```
    Specified by:
    
    getInstanceUuid in interface Image
    
    Returns:
    
    ID of instance used to create this image
  - getArchitecture
```
public String getArchitecture()
```
    Specified by:
    
    getArchitecture in interface Image
    
    Returns:
    
    Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html
  - getVirtualSize
```
public Long getVirtualSize()
```
    Specified by:
    
    getVirtualSize in interface Image
    
    Returns:
    
    Virtual size of image in bytes (READ-ONLY)
  - getAdditionalPropertyValue
```
public String getAdditionalPropertyValue(String key)
```
    Specified by:
    
    getAdditionalPropertyValue in interface Image
    
    Returns:
    
    Additional property's value from key https://developer.openstack.org/api-ref/image/v2/index.html#create-an-image
  - getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String key,
                                  String value)
```
  - toBuilder
```
public ImageBuilder toBuilder()
```
    Specified by:
    
    toBuilder in interface Buildable<ImageBuilder>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Modifier and Type	Class	Description
`static class`	`GlanceImage.ImageConcreteBuilder`
`static class`	`GlanceImage.Images`
`static class`	`GlanceImage.Location`

Class GlanceImage

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.openstack4j.model.image.v2.Image

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlanceImage

Method Detail

builder

getStatus

getName

setName

getTags

getContainerFormat

getCreatedAt

getDiskFormat

getUpdatedAt

getMinDisk

getIsProtected

getId

setId

getMinRam

getChecksum

getOwner

getVisibility

getSize

getLocations

getDirectUrl

getSelf

getFile

getSchema

getRamdiskId

getOsDistro

getOsVersion

getKernelId

getInstanceUuid

getArchitecture

getVirtualSize

getAdditionalPropertyValue

getAdditionalProperties

setAdditionalProperty

toBuilder

toString