Class Image

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.Image
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class Image extends com.ibm.cloud.sdk.core.service.model.GenericModel
Image.

  • Method Details

    • getCatalogOffering

      public ImageCatalogOffering getCatalogOffering()
      Gets the catalogOffering.
      Returns:
      the catalogOffering

    • getCreatedAt

      public Date getCreatedAt()
      Gets the createdAt. The date and time that the image was created.
      Returns:
      the createdAt

    • getCrn

      public String getCrn()
      Gets the crn. The CRN for this image.
      Returns:
      the crn

    • getDeprecationAt

      public Date getDeprecationAt()
      Gets the deprecationAt. The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.
      Returns:
      the deprecationAt

    • getEncryption

      public String getEncryption()
      Gets the encryption. The type of encryption used on the image.
      Returns:
      the encryption

    • getEncryptionKey

      public EncryptionKeyReference getEncryptionKey()
      Gets the encryptionKey. The key that will be used to encrypt volumes created from this image (unless an alternate `encryption_key` is specified at volume creation). This property will be present for images with an `encryption` type of `user_managed`.
      Returns:
      the encryptionKey

    • getFile

      public ImageFile getFile()
      Gets the file. Details for the stored image file.
      Returns:
      the file

    • getHref

      public String getHref()
      Gets the href. The URL for this image.
      Returns:
      the href

    • getId

      public String getId()
      Gets the id. The unique identifier for this image.
      Returns:
      the id

    • getMinimumProvisionedSize

      public Long getMinimumProvisionedSize()
      Gets the minimumProvisionedSize. The minimum size (in gigabytes) of a volume onto which this image may be provisioned. This property may be absent if the image has a `status` of `pending` or `failed`.
      Returns:
      the minimumProvisionedSize

    • getName

      public String getName()
      Gets the name. The name for this image. The name is unique across all images in the region.
      Returns:
      the name

    • getObsolescenceAt

      public Date getObsolescenceAt()
      Gets the obsolescenceAt. The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.
      Returns:
      the obsolescenceAt

    • getOperatingSystem

      public OperatingSystem getOperatingSystem()
      Gets the operatingSystem. The operating system included in this image.
      Returns:
      the operatingSystem

    • getResourceGroup

      public ResourceGroupReference getResourceGroup()
      Gets the resourceGroup. The resource group for this image.
      Returns:
      the resourceGroup

    • getResourceType

      public String getResourceType()
      Gets the resourceType. The resource type.
      Returns:
      the resourceType

    • getSourceVolume

      public VolumeReference getSourceVolume()
      Gets the sourceVolume. The volume used to create this image (this may be [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)). If absent, this image was not created from a volume.
      Returns:
      the sourceVolume

    • getStatus

      public String getStatus()
      Gets the status. The status of this image: - available: image can be used (provisionable) - deleting: image is being deleted, and can no longer be used to provision new resources - deprecated: image is administratively slated to become `obsolete` - failed: image is corrupt or did not pass validation - obsolete: image administratively set to not be used for new resources - pending: image is being imported and is not yet `available` - unusable: image cannot be used (see `status_reasons[]` for possible remediation) The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the status

    • getStatusReasons

      public List<ImageStatusReason> getStatusReasons()
      Gets the statusReasons.
      Returns:
      the statusReasons

    • getUserDataFormat

      public String getUserDataFormat()
      Gets the userDataFormat. The user data format for this image: - `cloud_init`: `user_data` will be interpreted according to the cloud-init standard - `esxi_kickstart`: `user_data` will be interpreted as a VMware ESXi installation script - `ipxe`: `user_data` will be interpreted as a single URL to an iPXE script or as the text of an iPXE script The value for this property is inherited from `operating_system.user_data_format`.
      Returns:
      the userDataFormat

    • getVisibility

      public String getVisibility()
      Gets the visibility. The visibility of this image. - `private`: Visible only to this account - `public`: Visible to all accounts.
      Returns:
      the visibility