@Generated(value="OracleSDKGenerator",
comments="API Version: 20171215")
public final class FileSystem
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An NFS file system. To allow access to a file system, add it to an export set and associate the export set with a mount target. The same file system can be in multiple export sets and associated with multiple mount targets.
To use any of the API operations, you must be authorized in an IAM policy. If you're not
authorized, talk to an administrator. If you're an administrator who needs to write policies to
give users access, see [Getting Started with
Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the FileSystem.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 FileSystem.Builder, which maintain a
set of all explicitly set fields called FileSystem.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
FileSystem.Builder |
static class |
FileSystem.CloneAttachStatus
Specifies whether the file system is attached to its parent file system.
|
static class |
FileSystem.LifecycleState
The current state of the file system.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
FileSystem(String availabilityDomain,
Long meteredBytes,
String compartmentId,
String displayName,
String id,
FileSystem.LifecycleState lifecycleState,
Date timeCreated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
String kmsKeyId,
SourceDetails sourceDetails,
Boolean isCloneParent,
Boolean isHydrated,
Integer cloneCount,
FileSystem.CloneAttachStatus cloneAttachStatus,
List<ResourceLock> locks,
String lifecycleDetails,
Boolean isTargetable,
String replicationTargetId,
String filesystemSnapshotPolicyId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static FileSystem.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAvailabilityDomain()
The availability domain the file system is in.
|
FileSystem.CloneAttachStatus |
getCloneAttachStatus()
Specifies whether the file system is attached to its parent file system.
|
Integer |
getCloneCount()
Specifies the total number of children of a file system.
|
String |
getCompartmentId()
The OCID of the
compartment that contains the file system.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
String |
getFilesystemSnapshotPolicyId()
The OCID of the
associated file system snapshot policy, which controls the frequency of snapshot creation and
retention period of the taken snapshots.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the
file system.
|
Boolean |
getIsCloneParent()
Specifies whether the file system has been cloned.
|
Boolean |
getIsHydrated()
Specifies whether the data has finished copying from the source to the clone.
|
Boolean |
getIsTargetable()
Specifies whether the file system can be used as a target file system for replication.
|
String |
getKmsKeyId()
The OCID of the KMS
key which is the master encryption key for the file system.
|
String |
getLifecycleDetails()
Additional information about the current ‘lifecycleState’.
|
FileSystem.LifecycleState |
getLifecycleState()
The current state of the file system.
|
List<ResourceLock> |
getLocks()
Locks associated with this resource.
|
Long |
getMeteredBytes()
The number of bytes consumed by the file system, including any snapshots.
|
String |
getReplicationTargetId()
The OCID of the
replication target associated with the file system.
|
SourceDetails |
getSourceDetails() |
Date |
getTimeCreated()
The date and time the file system was created, expressed in RFC
3339 timestamp format.
|
int |
hashCode() |
FileSystem.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"availabilityDomain","meteredBytes","compartmentId","displayName","id","lifecycleState","timeCreated","freeformTags","definedTags","kmsKeyId","sourceDetails","isCloneParent","isHydrated","cloneCount","cloneAttachStatus","locks","lifecycleDetails","isTargetable","replicationTargetId","filesystemSnapshotPolicyId"}) public FileSystem(String availabilityDomain, Long meteredBytes, String compartmentId, String displayName, String id, FileSystem.LifecycleState lifecycleState, Date timeCreated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String kmsKeyId, SourceDetails sourceDetails, Boolean isCloneParent, Boolean isHydrated, Integer cloneCount, FileSystem.CloneAttachStatus cloneAttachStatus, List<ResourceLock> locks, String lifecycleDetails, Boolean isTargetable, String replicationTargetId, String filesystemSnapshotPolicyId)
public static FileSystem.Builder builder()
Create a new builder.
public FileSystem.Builder toBuilder()
public String getAvailabilityDomain()
The availability domain the file system is in. May be unset as a blank or NULL value.
Example: Uocm:PHX-AD-1
public Long getMeteredBytes()
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. For more information, see File System Usage and Metering.
public String getCompartmentId()
The OCID of the compartment that contains the file system.
public String getDisplayName()
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: My file system
public FileSystem.LifecycleState getLifecycleState()
The current state of the file system.
public Date getTimeCreated()
The date and time the file system was created, expressed in RFC 3339 timestamp format.
Example: 2016-08-25T21:10:29.600Z
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"}
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"}}
public String getKmsKeyId()
The OCID of the KMS key which is the master encryption key for the file system.
public SourceDetails getSourceDetails()
public Boolean getIsCloneParent()
Specifies whether the file system has been cloned. See Cloning a File System.
public Boolean getIsHydrated()
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.
public Integer getCloneCount()
Specifies the total number of children of a file system.
public FileSystem.CloneAttachStatus getCloneAttachStatus()
Specifies whether the file system is attached to its parent file system.
public List<ResourceLock> getLocks()
Locks associated with this resource.
public String getLifecycleDetails()
Additional information about the current ‘lifecycleState’.
public Boolean getIsTargetable()
Specifies whether the file system can be used as a target file system for replication. The
system sets this value to true if the file system is unexported, hasn’t yet been
specified as a target file system in any replication resource, and has no user snapshots.
After the file system has been specified as a target in a replication, or if the file system
contains user snapshots, the system sets this value to false. For more information,
see Using
Replication.
public String getReplicationTargetId()
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
public String getFilesystemSnapshotPolicyId()
The OCID of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.