Class Snapshot

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

  • Method Details

    • getBackupPolicyPlan

      public BackupPolicyPlanReference getBackupPolicyPlan()
      Gets the backupPolicyPlan. If present, the backup policy plan which created this snapshot.
      Returns:
      the backupPolicyPlan

    • isBootable

      public Boolean isBootable()
      Gets the bootable. Indicates if a boot volume attachment can be created with a volume created from this snapshot.
      Returns:
      the bootable

    • getCapturedAt

      public Date getCapturedAt()
      Gets the capturedAt. The date and time the data capture for this snapshot was completed. If absent, this snapshot's data has not yet been captured. Additionally, this property may be absent for snapshots created before 1 January 2022.
      Returns:
      the capturedAt

    • getCatalogOffering

      public SnapshotCatalogOffering getCatalogOffering()
      Gets the catalogOffering. The [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user) offering inherited from the snapshot's source. If a virtual server instance is provisioned with a `source_snapshot` specifying this snapshot, the virtual server instance will use this snapshot's catalog offering, including its pricing plan. If absent, this snapshot is not associated with a catalog offering.
      Returns:
      the catalogOffering

    • getClones

      public List<SnapshotClone> getClones()
      Gets the clones. Clones for this snapshot.
      Returns:
      the clones

    • getCopies

      public List<SnapshotCopiesItem> getCopies()
      Gets the copies. The copies of this snapshot.
      Returns:
      the copies

    • getCreatedAt

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

    • getCrn

      public String getCrn()
      Gets the crn. The CRN of this snapshot.
      Returns:
      the crn

    • isDeletable

      @Deprecated public Boolean isDeletable()
      Deprecated.
      this method is deprecated and may be removed in a future release
      Gets the deletable. Indicates whether this snapshot can be deleted. This value will always be `true`.
      Returns:
      the deletable

    • getEncryption

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

    • getEncryptionKey

      public EncryptionKeyReference getEncryptionKey()
      Gets the encryptionKey. The root key used to wrap the data encryption key for the source volume. This property will be present for volumes with an `encryption` type of `user_managed`.
      Returns:
      the encryptionKey

    • getHref

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

    • getId

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

    • getLifecycleState

      public String getLifecycleState()
      Gets the lifecycleState. The lifecycle state of this snapshot.
      Returns:
      the lifecycleState

    • getMinimumCapacity

      public Long getMinimumCapacity()
      Gets the minimumCapacity. The minimum capacity of a volume created from this snapshot. When a snapshot is created, this will be set to the capacity of the `source_volume`.
      Returns:
      the minimumCapacity

    • getName

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

    • getOperatingSystem

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

    • getProgress

      public Long getProgress()
      Gets the progress. Indicates the progress (as a percentage) of storing this snapshot. Only stored snapshots can be used for restoration.
      Returns:
      the progress

    • getResourceGroup

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

    • getResourceType

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

    • getServiceTags

      public List<String> getServiceTags()
      Gets the serviceTags. The [service tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) prefixed with `is.snapshot:` associated with this snapshot.
      Returns:
      the serviceTags

    • getSize

      public Long getSize()
      Gets the size. The size of this snapshot rounded up to the next gigabyte.
      Returns:
      the size

    • getSnapshotConsistencyGroup

      public SnapshotConsistencyGroupReference getSnapshotConsistencyGroup()
      Gets the snapshotConsistencyGroup. If present, the snapshot consistency group which created this snapshot.
      Returns:
      the snapshotConsistencyGroup

    • getSourceImage

      public ImageReference getSourceImage()
      Gets the sourceImage. If present, the image from which the data on this snapshot was most directly provisioned.
      Returns:
      the sourceImage

    • getSourceSnapshot

      public SnapshotSourceSnapshot getSourceSnapshot()
      Gets the sourceSnapshot. If present, the source snapshot this snapshot was created from.
      Returns:
      the sourceSnapshot

    • getSourceVolume

      public VolumeReference getSourceVolume()
      Gets the sourceVolume. The source volume this snapshot was created from (may be [deleted](https://cloud.ibm.com/apidocs/vpc#deleted-resources)).
      Returns:
      the sourceVolume

    • getUserTags

      public List<String> getUserTags()
      Gets the userTags. The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot.
      Returns:
      the userTags