Package com.ibm.cloud.is.vpc.v1.model
Class ImageExportJob
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.is.vpc.v1.model.ImageExportJob
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class ImageExportJob extends com.ibm.cloud.sdk.core.service.model.GenericModel
ImageExportJob.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ImageExportJob.Format
The format of the exported image.static interface
ImageExportJob.ResourceType
The resource type.static interface
ImageExportJob.Status
The status of this image export job: - `deleting`: Export job is being deleted - `failed`: Export job could not be completed successfully - `queued`: Export job is queued - `running`: Export job is in progress - `succeeded`: Export job was completed successfully The exported image object is automatically deleted for `failed` jobs.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Date
getCompletedAt()
Gets the completedAt.Date
getCreatedAt()
Gets the createdAt.byte[]
getEncryptedDataKey()
Gets the encryptedDataKey.String
getFormat()
Gets the format.String
getHref()
Gets the href.String
getId()
Gets the id.String
getName()
Gets the name.String
getResourceType()
Gets the resourceType.Date
getStartedAt()
Gets the startedAt.String
getStatus()
Gets the status.List<ImageExportJobStatusReason>
getStatusReasons()
Gets the statusReasons.CloudObjectStorageBucketReference
getStorageBucket()
Gets the storageBucket.String
getStorageHref()
Gets the storageHref.CloudObjectStorageObjectReference
getStorageObject()
Gets the storageObject.
-
-
-
Method Detail
-
getCompletedAt
public Date getCompletedAt()
Gets the completedAt. The date and time that the image export job was completed. If absent, the export job has not yet completed.- Returns:
- the completedAt
-
getCreatedAt
public Date getCreatedAt()
Gets the createdAt. The date and time that the image export job was created.- Returns:
- the createdAt
-
getEncryptedDataKey
public byte[] getEncryptedDataKey()
Gets the encryptedDataKey. A base64-encoded, encrypted representation of the key that was used to encrypt the data for the exported image. This key can be unwrapped with the image's `encryption_key` root key using either Key Protect or Hyper Protect Crypto Services. If absent, the export job is for an unencrypted image.- Returns:
- the encryptedDataKey
-
getFormat
public String getFormat()
Gets the format. The format of the exported image.- Returns:
- the format
-
getHref
public String getHref()
Gets the href. The URL for this image export job.- Returns:
- the href
-
getId
public String getId()
Gets the id. The unique identifier for this image export job.- Returns:
- the id
-
getName
public String getName()
Gets the name. The name for this image export job. The name must not be used by another export job for the image. Changing the name will not affect the exported image name, `storage_object.name`, or `storage_href` values.- Returns:
- the name
-
getResourceType
public String getResourceType()
Gets the resourceType. The resource type.- Returns:
- the resourceType
-
getStartedAt
public Date getStartedAt()
Gets the startedAt. The date and time that the image export job started running. If absent, the export job has not yet started.- Returns:
- the startedAt
-
getStatus
public String getStatus()
Gets the status. The status of this image export job: - `deleting`: Export job is being deleted - `failed`: Export job could not be completed successfully - `queued`: Export job is queued - `running`: Export job is in progress - `succeeded`: Export job was completed successfully The exported image object is automatically deleted for `failed` jobs. 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<ImageExportJobStatusReason> getStatusReasons()
Gets the statusReasons. The reasons for the current status (if any).- Returns:
- the statusReasons
-
getStorageBucket
public CloudObjectStorageBucketReference getStorageBucket()
Gets the storageBucket. The Cloud Object Storage bucket of the exported image object.- Returns:
- the storageBucket
-
getStorageHref
public String getStorageHref()
Gets the storageHref. The Cloud Object Storage location of the exported image object. The object at this location will not exist until the job completes successfully. The exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the storage bucket.- Returns:
- the storageHref
-
getStorageObject
public CloudObjectStorageObjectReference getStorageObject()
Gets the storageObject. The Cloud Object Storage object for the exported image. This object will not exist until the job completes successfully. The exported image object is not managed by the IBM VPC service, and may be removed or replaced with a different object by any user or service with IAM authorization to the storage bucket.- Returns:
- the storageObject
-
-