com.oracle.bmc.filestorage.model

Class FileSystem

java.lang.Object

com.oracle.bmc.filestorage.model.FileSystem

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class FileSystem
extends Object

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).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystem.Builder
static class	FileSystem.LifecycleState The current state of the file system.

Constructor Summary

Constructors

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) Deprecated.

Method Summary

Modifier and Type	Method and Description
static FileSystem.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getAvailabilityDomain() The availability domain the file system is in.
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.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the file system.
String	getKmsKeyId() The OCID of the KMS key which is the master encryption key for the file system.
FileSystem.LifecycleState	getLifecycleState() The current state of the file system.
Long	getMeteredBytes() The number of bytes consumed by the file system, including any snapshots.
Date	getTimeCreated() The date and time the file system was created, expressed in RFC 3339 timestamp format.
int	hashCode()
FileSystem.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileSystem

@ConstructorProperties(value={"availabilityDomain","meteredBytes","compartmentId","displayName","id","lifecycleState","timeCreated","freeformTags","definedTags","kmsKeyId"})
 @Deprecated
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)

Deprecated.

Method Detail

builder

public static FileSystem.Builder builder()

Create a new builder.

toBuilder

public FileSystem.Builder toBuilder()

getAvailabilityDomain

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`

getMeteredBytes

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.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the file system.

getDisplayName

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`

getId

public String getId()

The OCID of the file system.

getLifecycleState

public FileSystem.LifecycleState getLifecycleState()

The current state of the file system.

getTimeCreated

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`

getFreeformTags

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

getDefinedTags

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

getKmsKeyId

public String getKmsKeyId()

The OCID of the KMS key which is the master encryption key for the file system.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object