Class: DropletKit::Image

Inherits:
BaseModel show all
Defined in:
lib/droplet_kit/models/image.rb

Constant Summary

Constants inherited from BaseModel

BaseModel::DO_NAMESPACE, BaseModel::UNSUPPORTED_COLLECTIONS

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#collection_name, from_identifier, from_urn, #identifier, #inspect, #urn, valid_urn?

Instance Attribute Details

#created_at ⇒ String

Returns A time value given in ISO8601 combined date and time format that represents when the Image was created.

Examples:

‘2014-11-04T22:23:02Z’

Returns:

  • (String) —

    A time value given in ISO8601 combined date and time format that represents when the Image was created.



51
 
# File 'lib/droplet_kit/models/image.rb', line 51

attribute :created_at

#distribution ⇒ String

Returns This attribute describes the base distribution used for this image.

Examples:

‘Ubuntu’

Returns:

  • (String) —

    This attribute describes the base distribution used for this image.



16
 
# File 'lib/droplet_kit/models/image.rb', line 16

attribute :distribution

#id ⇒ Fixnum

Returns A unique number that can be used to identify and reference a specific image.

Examples:

12345

Returns:

  • (Fixnum) —

    A unique number that can be used to identify and reference a specific image.



6
 
# File 'lib/droplet_kit/models/image.rb', line 6

attribute :id

#min_disk_size ⇒ Fixnum

Returns The minimum ‘disk’ required for a size to use this image.

Examples:

‘snapshot’

Returns:

  • (Fixnum) —

    The minimum ‘disk’ required for a size to use this image.



41
 
# File 'lib/droplet_kit/models/image.rb', line 41

attribute :min_disk_size

#name ⇒ String

Returns The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.

Examples:

‘foo’

Returns:

  • (String) —

    The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.



11
 
# File 'lib/droplet_kit/models/image.rb', line 11

attribute :name

#public ⇒ Boolean

Returns This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.

Examples:

false

Returns:

  • (Boolean) —

    This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.



26
 
# File 'lib/droplet_kit/models/image.rb', line 26

attribute :public

#regions ⇒ Array<String>

Returns This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.

Examples:

“nyc2”, “nyc2”

Returns:

  • (Array<String>) —

    This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.



31
 
# File 'lib/droplet_kit/models/image.rb', line 31

attribute :regions

#size_gigabytes ⇒ Fixnum

Returns The size of the image in gigabytes.

Examples:

2.34

Returns:

  • (Fixnum) —

    The size of the image in gigabytes.



46
 
# File 'lib/droplet_kit/models/image.rb', line 46

attribute :size_gigabytes

#slug ⇒ String

Returns A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.

Examples:

‘ubuntu-16-04-x64’

Returns:

  • (String) —

    A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.



21
 
# File 'lib/droplet_kit/models/image.rb', line 21

attribute :slug

#type ⇒ String

Returns The kind of image, describing the duration of how long the image is stored. This is either “snapshot” or “backup”.

Examples:

‘snapshot’

Returns:

  • (String) —

    The kind of image, describing the duration of how long the image is stored. This is either “snapshot” or “backup”.



36
 
# File 'lib/droplet_kit/models/image.rb', line 36

attribute :type