Class OpensearchClusterBackupSummary

The summary of information about an OpenSearch cluster backup.

Inheritance

object

OpensearchClusterBackupSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OpensearchService.Models

Assembly: OCI.DotNetSDK.Opensearch.dll

Syntax

public class OpensearchClusterBackupSummary

Properties

BackupSize

Declaration

[JsonProperty(PropertyName = "backupSize")]
public double BackupSize { get; set; }

Property Value

Type	Description
double	The size in GB of the cluster backup.

BackupType

Declaration

[Required(ErrorMessage = "BackupType is required.")]
[JsonProperty(PropertyName = "backupType")]
[JsonConverter(typeof(StringEnumConverter))]
public OpensearchClusterBackup.BackupTypeEnum? BackupType { get; set; }

Property Value

Type	Description
OpensearchClusterBackup.BackupTypeEnum?	Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment where the cluster backup is located.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The name of the cluster backup. Avoid entering confidential information.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the cluster backup.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycle state of the cluster backup.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public OpensearchClusterBackup.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OpensearchClusterBackup.LifecycleStateEnum?	The current state of the cluster backup.

Remarks

Required

SourceClusterDisplayName

Declaration

[JsonProperty(PropertyName = "sourceClusterDisplayName")]
public string SourceClusterDisplayName { get; set; }

Property Value

Type	Description
string	The name of the source OpenSearch cluster for the cluster backup.

SourceClusterId

Declaration

[Required(ErrorMessage = "SourceClusterId is required.")]
[JsonProperty(PropertyName = "sourceClusterId")]
public string SourceClusterId { get; set; }

Property Value

Type	Description
string	The OCID of the source OpenSearch cluster for the cluster backup.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the cluster backup was created. Format defined by RFC3339.

TimeExpired

Declaration

[JsonProperty(PropertyName = "timeExpired")]
public DateTime? TimeExpired { get; set; }

Property Value

Type	Description
DateTime?	The date and time the cluster backup expires. Format defined by RFC3339.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the cluster backup was updated. Format defined by RFC3339.