Class ShareSnapshot

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

  • Method Details

    • getBackupPolicyPlan

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

    • getCapturedAt

      public Date getCapturedAt()
      Gets the capturedAt. The date and time the data capture for this share snapshot was completed. If absent, this snapshot's data has not yet been captured.
      Returns:
      the capturedAt

    • getCreatedAt

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

    • getCrn

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

    • getFingerprint

      public String getFingerprint()
      Gets the fingerprint. The fingerprint for this share snapshot. Only snapshots with identical data will have the same fingerprint. This snapshot will also be available as a subdirectory named identically to this fingerprint in the share's `.snapshot` directory.
      Returns:
      the fingerprint

    • getHref

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

    • getId

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

    • getLifecycleReasons

      public List<ShareSnapshotLifecycleReason> getLifecycleReasons()
      Gets the lifecycleReasons. The reasons for the current `lifecycle_state` (if any).
      Returns:
      the lifecycleReasons

    • getLifecycleState

      public String getLifecycleState()
      Gets the lifecycleState. The lifecycle state of this share snapshot - `pending`: The share snapshot is being provisioned and is not yet usable. A snapshot on a replica share will remain `pending` until the next replication sync completes. - `deleting`: The share snapshot is being deleted. - `failed`: The share snapshot is irrecoverably unusable. - `stable`: The share snapshot is stable and ready for use. - `updating`: The share snapshot is being updated. - `suspended`: The share snapshot is not currently usable (see `lifecycle_reasons`).
      Returns:
      the lifecycleState

    • getMinimumSize

      public Long getMinimumSize()
      Gets the minimumSize. The minimum size of a share created from this snapshot. When a snapshot is created, this will be set to the size of the `source_share`.
      Returns:
      the minimumSize

    • getName

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

    • getResourceGroup

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

    • getResourceType

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

    • getStatus

      public String getStatus()
      Gets the status. The status of the share snapshot: - `available`: The share snapshot is available for use. - `failed`: The share snapshot is irrecoverably unusable. - `pending`: The share snapshot is being provisioned and is not yet usable. A snapshot on a replica share will remain `pending` until the next replication sync completes. - `unusable`: The share snapshot is not currently usable (see `status_reasons`) 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<ShareSnapshotStatusReason> getStatusReasons()
      Gets the statusReasons. The reasons for the current status (if any).
      Returns:
      the statusReasons

    • getUserTags

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

    • getZone

      public ZoneReference getZone()
      Gets the zone. The zone this share snapshot resides in.
      Returns:
      the zone