Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Snapshot

A point-in-time snapshot of a specified file system.

Properties

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional expirationTime

expirationTime: Date

The time when this snapshot will be deleted.

fileSystemId

fileSystemId: string

The OCID of the file system from which the snapshot was created.

Optional filesystemSnapshotPolicyId

filesystemSnapshotPolicyId: undefined | string

The OCID of the file system snapshot policy that created this snapshot.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the snapshot.

Optional isCloneSource

isCloneSource: undefined | false | true

Specifies whether the snapshot has been cloned. See Cloning a File System.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current {@code lifecycleState}.

lifecycleState

lifecycleState: LifecycleState

The current state of the snapshot.

name

name: string

Name of the snapshot. This value is immutable.

Avoid entering confidential information.

Example: {@code Sunday}

Optional provenanceId

provenanceId: undefined | string

An OCID identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the {@code provenanceId} is the same as the snapshot {@code id} value. If this snapshot was cloned, then the {@code provenanceId} value is the parent's {@code provenanceId}. See Cloning a File System.

Optional snapshotTime

snapshotTime: Date

The date and time the snapshot was taken, expressed in RFC 3339 timestamp format. This value might be the same or different from {@code 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: {@code 2020-08-25T21:10:29.600Z}

Optional snapshotType

snapshotType: SnapshotType

Specifies generation type of the snapshot.

timeCreated

timeCreated: Date

The date and time the snapshot was created, expressed in RFC 3339 timestamp format.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Snapshot): object

getJsonObj