Package com.oracle.bmc.filestorage.model

Class Snapshot

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class Snapshot
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A point-in-time snapshot of a specified file system.
    Note: Objects should always be created or deserialized using the Snapshot.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Snapshot.Builder, which maintain a set of all explicitly set fields called Snapshot.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getFileSystemId

        public String getFileSystemId()
        The OCID of the file system from which the snapshot was created.
        Returns:
        the value

      • getId

        public String getId()
        The OCID of the snapshot.
        Returns:
        the value

      • getLifecycleState

        public Snapshot.LifecycleState getLifecycleState()
        The current state of the snapshot.
        Returns:
        the value

      • getName

        public String getName()
        Name of the snapshot.

        This value is immutable.

        Avoid entering confidential information.

        Example: Sunday

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the snapshot was created, expressed in RFC 3339 timestamp format.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getSnapshotType

        public Snapshot.SnapshotType getSnapshotType()
        Specifies generation type of the snapshot.
        Returns:
        the value

      • getSnapshotTime

        public Date getSnapshotTime()
        The date and time the snapshot was taken, expressed in RFC 3339 timestamp format.

        This value might be the same or different from timeCreated depending on the following factors: - If the snapshot is created in the original file system directory. - If the snapshot is cloned from a file system. - If the snapshot is replicated from a file system.

        Example: 2020-08-25T21:10:29.600Z

        Returns:
        the value

      • getProvenanceId

        public String getProvenanceId()
        An OCID identifying the parent from which this snapshot was cloned.

        If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent’s provenanceId. See Cloning a File System.

        Returns:
        the value

      • getIsCloneSource

        public Boolean getIsCloneSource()
        Specifies whether the snapshot has been cloned.

        See Cloning a File System.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycleState.
        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        System tags are applied to resources by internal OCI services.

        Returns:
        the value

      • getExpirationTime

        public Date getExpirationTime()
        The time when this snapshot will be deleted.
        Returns:
        the value

      • getFilesystemSnapshotPolicyId

        public String getFilesystemSnapshotPolicyId()
        The OCID of the file system snapshot policy that created this snapshot.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel