Class FileSystemSummary

Summary information for a file system.

Inheritance
object
FileSystemSummary
Inherited Members
Namespace: Oci.FilestorageService.Models
Assembly: OCI.DotNetSDK.Filestorage.dll
Syntax
public class FileSystemSummary

Properties

AvailabilityDomain

Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type Description
string

The availability domain the file system is in. May be unset as a blank or NULL value.
Example: Uocm:PHX-AD-1

CloneAttachStatus

Declaration
[JsonProperty(PropertyName = "cloneAttachStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public FileSystemSummary.CloneAttachStatusEnum? CloneAttachStatus { get; set; }
Property Value
Type Description
FileSystemSummary.CloneAttachStatusEnum?

Specifies whether the file system is attached to its parent file system.

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 that contains the file system.
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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: My file system
Remarks

Required

FreeformTags

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

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"}

Id

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

The OCID of the file system.
Remarks

Required

IsCloneParent

Declaration
[JsonProperty(PropertyName = "isCloneParent")]
public bool? IsCloneParent { get; set; }
Property Value
Type Description
bool?

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

IsHydrated

Declaration
[JsonProperty(PropertyName = "isHydrated")]
public bool? IsHydrated { get; set; }
Property Value
Type Description
bool?

Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

KmsKeyId

Declaration
[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }
Property Value
Type Description
string

The OCID of the KMS key used to encrypt the encryption keys associated with this file system.

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Additional information about the current 'lifecycleState'.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public FileSystemSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
FileSystemSummary.LifecycleStateEnum?

The current state of the file system.
Remarks

Required

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

MeteredBytes

Declaration
[Required(ErrorMessage = "MeteredBytes is required.")]
[JsonProperty(PropertyName = "meteredBytes")]
public long? MeteredBytes { get; set; }
Property Value
Type Description
long?

The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system.
Remarks

Required

QuotaEnforcementState

Declaration
[JsonProperty(PropertyName = "quotaEnforcementState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public FileSystemSummary.QuotaEnforcementStateEnum? QuotaEnforcementState { get; set; }
Property Value
Type Description
FileSystemSummary.QuotaEnforcementStateEnum?

Displays the state of enforcement of quota rules on the file system.

ReplicationSourceCount

Declaration
[JsonProperty(PropertyName = "replicationSourceCount")]
public int? ReplicationSourceCount { get; set; }
Property Value
Type Description
int?

Specifies the total number of replications for which this file system is a source.

SourceDetails

Declaration
[JsonProperty(PropertyName = "sourceDetails")]
public SourceDetails SourceDetails { get; set; }
Property Value
Type Description
SourceDetails

SystemTags

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

System tags for this resource. System tags are applied to resources by internal OCI services.

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the file system was created, expressed in RFC 3339 timestamp format.
Example: 2016-08-25T21:10:29.600Z
Remarks

Required