Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OpensearchClusterBackupSummary

The summary of information about an OpenSearch cluster backup.

Properties

Optional backupSize

backupSize: undefined | number

The size in GB of the cluster backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

backupType

backupType: string

Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

compartmentId

compartmentId: string

The OCID of the compartment where the cluster backup is located.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional displayName

displayName: undefined | string

The name of the cluster backup. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the cluster backup.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state of the cluster backup.

lifecycleState

lifecycleState: string

The current state of the cluster backup.

Optional sourceClusterDisplayName

sourceClusterDisplayName: undefined | string

The name of the source OpenSearch cluster for the cluster backup.

sourceClusterId

sourceClusterId: string

The OCID of the source OpenSearch cluster for the cluster backup.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

The date and time the cluster backup was created. Format defined by RFC3339.

Optional timeExpired

timeExpired: Date

The date and time the cluster backup expires. Format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

The date and time the cluster backup was updated. Format defined by RFC3339.

Functions

getDeserializedJsonObj

getJsonObj