FileSystemDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticfilesystem.model.FileSystemDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FileSystemDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Description of the file system.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FileSystemDescription()

Constructors
Constructor and Description
`FileSystemDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileSystemDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
`String`	`getCreationToken()` Opaque string specified in the request.
`Boolean`	`getEncrypted()` A boolean value that, if true, indicates that the file system is encrypted.
`String`	`getFileSystemId()` ID of the file system, assigned by Amazon EFS.
`String`	`getKmsKeyId()` The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
`String`	`getLifeCycleState()` Lifecycle phase of the file system.
`String`	`getName()` You can add tags to a file system, including a `Name` tag.
`Integer`	`getNumberOfMountTargets()` Current number of mount targets that the file system has.
`String`	`getOwnerId()` AWS account that created the file system.
`String`	`getPerformanceMode()` The `PerformanceMode` of the file system.
`FileSystemSize`	`getSizeInBytes()` Latest known metered size (in bytes) of data stored in the file system, in bytes, in its `Value` field, and the time at which that size was determined in its `Timestamp` field.
`int`	`hashCode()`
`Boolean`	`isEncrypted()` A boolean value that, if true, indicates that the file system is encrypted.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
`void`	`setCreationToken(String creationToken)` Opaque string specified in the request.
`void`	`setEncrypted(Boolean encrypted)` A boolean value that, if true, indicates that the file system is encrypted.
`void`	`setFileSystemId(String fileSystemId)` ID of the file system, assigned by Amazon EFS.
`void`	`setKmsKeyId(String kmsKeyId)` The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
`void`	`setLifeCycleState(LifeCycleState lifeCycleState)` Lifecycle phase of the file system.
`void`	`setLifeCycleState(String lifeCycleState)` Lifecycle phase of the file system.
`void`	`setName(String name)` You can add tags to a file system, including a `Name` tag.
`void`	`setNumberOfMountTargets(Integer numberOfMountTargets)` Current number of mount targets that the file system has.
`void`	`setOwnerId(String ownerId)` AWS account that created the file system.
`void`	`setPerformanceMode(PerformanceMode performanceMode)` The `PerformanceMode` of the file system.
`void`	`setPerformanceMode(String performanceMode)` The `PerformanceMode` of the file system.
`void`	`setSizeInBytes(FileSystemSize sizeInBytes)` Latest known metered size (in bytes) of data stored in the file system, in bytes, in its `Value` field, and the time at which that size was determined in its `Timestamp` field.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`FileSystemDescription`	`withCreationTime(Date creationTime)` Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
`FileSystemDescription`	`withCreationToken(String creationToken)` Opaque string specified in the request.
`FileSystemDescription`	`withEncrypted(Boolean encrypted)` A boolean value that, if true, indicates that the file system is encrypted.
`FileSystemDescription`	`withFileSystemId(String fileSystemId)` ID of the file system, assigned by Amazon EFS.
`FileSystemDescription`	`withKmsKeyId(String kmsKeyId)` The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
`FileSystemDescription`	`withLifeCycleState(LifeCycleState lifeCycleState)` Lifecycle phase of the file system.
`FileSystemDescription`	`withLifeCycleState(String lifeCycleState)` Lifecycle phase of the file system.
`FileSystemDescription`	`withName(String name)` You can add tags to a file system, including a `Name` tag.
`FileSystemDescription`	`withNumberOfMountTargets(Integer numberOfMountTargets)` Current number of mount targets that the file system has.
`FileSystemDescription`	`withOwnerId(String ownerId)` AWS account that created the file system.
`FileSystemDescription`	`withPerformanceMode(PerformanceMode performanceMode)` The `PerformanceMode` of the file system.
`FileSystemDescription`	`withPerformanceMode(String performanceMode)` The `PerformanceMode` of the file system.
`FileSystemDescription`	`withSizeInBytes(FileSystemSize sizeInBytes)` Latest known metered size (in bytes) of data stored in the file system, in bytes, in its `Value` field, and the time at which that size was determined in its `Timestamp` field.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileSystemDescription
```
public FileSystemDescription()
```
- Method Detail
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
    
    Parameters:
    
    ownerId - AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
  - getOwnerId
```
public String getOwnerId()
```
    AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
    
    Returns:
    
    AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
  - withOwnerId
```
public FileSystemDescription withOwnerId(String ownerId)
```
    AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
    
    Parameters:
    
    ownerId - AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationToken
```
public void setCreationToken(String creationToken)
```
    Opaque string specified in the request.
    
    Parameters:
    
    creationToken - Opaque string specified in the request.
  - getCreationToken
```
public String getCreationToken()
```
    Opaque string specified in the request.
    
    Returns:
    
    Opaque string specified in the request.
  - withCreationToken
```
public FileSystemDescription withCreationToken(String creationToken)
```
    Opaque string specified in the request.
    
    Parameters:
    
    creationToken - Opaque string specified in the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSystemId
```
public void setFileSystemId(String fileSystemId)
```
    ID of the file system, assigned by Amazon EFS.
    
    Parameters:
    
    fileSystemId - ID of the file system, assigned by Amazon EFS.
  - getFileSystemId
```
public String getFileSystemId()
```
    ID of the file system, assigned by Amazon EFS.
    
    Returns:
    
    ID of the file system, assigned by Amazon EFS.
  - withFileSystemId
```
public FileSystemDescription withFileSystemId(String fileSystemId)
```
    ID of the file system, assigned by Amazon EFS.
    
    Parameters:
    
    fileSystemId - ID of the file system, assigned by Amazon EFS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
    
    Parameters:
    
    creationTime - Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
  - getCreationTime
```
public Date getCreationTime()
```
    Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
    
    Returns:
    
    Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
  - withCreationTime
```
public FileSystemDescription withCreationTime(Date creationTime)
```
    Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
    
    Parameters:
    
    creationTime - Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifeCycleState
```
public void setLifeCycleState(String lifeCycleState)
```
    Lifecycle phase of the file system.
    
    Parameters:
    
    lifeCycleState - Lifecycle phase of the file system.
    
    See Also:
    
    LifeCycleState
  - getLifeCycleState
```
public String getLifeCycleState()
```
    Lifecycle phase of the file system.
    
    Returns:
    
    Lifecycle phase of the file system.
    
    See Also:
    
    LifeCycleState
  - withLifeCycleState
```
public FileSystemDescription withLifeCycleState(String lifeCycleState)
```
    Lifecycle phase of the file system.
    
    Parameters:
    
    lifeCycleState - Lifecycle phase of the file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LifeCycleState
  - setLifeCycleState
```
public void setLifeCycleState(LifeCycleState lifeCycleState)
```
    Lifecycle phase of the file system.
    
    Parameters:
    
    lifeCycleState - Lifecycle phase of the file system.
    
    See Also:
    
    LifeCycleState
  - withLifeCycleState
```
public FileSystemDescription withLifeCycleState(LifeCycleState lifeCycleState)
```
    Lifecycle phase of the file system.
    
    Parameters:
    
    lifeCycleState - Lifecycle phase of the file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LifeCycleState
  - setName
```
public void setName(String name)
```
    You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
    
    Parameters:
    
    name - You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
  - getName
```
public String getName()
```
    You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
    
    Returns:
    
    You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
  - withName
```
public FileSystemDescription withName(String name)
```
    You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
    
    Parameters:
    
    name - You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfMountTargets
```
public void setNumberOfMountTargets(Integer numberOfMountTargets)
```
    Current number of mount targets that the file system has. For more information, see CreateMountTarget.
    
    Parameters:
    
    numberOfMountTargets - Current number of mount targets that the file system has. For more information, see CreateMountTarget.
  - getNumberOfMountTargets
```
public Integer getNumberOfMountTargets()
```
    Current number of mount targets that the file system has. For more information, see CreateMountTarget.
    
    Returns:
    
    Current number of mount targets that the file system has. For more information, see CreateMountTarget.
  - withNumberOfMountTargets
```
public FileSystemDescription withNumberOfMountTargets(Integer numberOfMountTargets)
```
    Current number of mount targets that the file system has. For more information, see CreateMountTarget.
    
    Parameters:
    
    numberOfMountTargets - Current number of mount targets that the file system has. For more information, see CreateMountTarget.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeInBytes
```
public void setSizeInBytes(FileSystemSize sizeInBytes)
```
    Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
    
    Parameters:
    
    sizeInBytes - Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
  - getSizeInBytes
```
public FileSystemSize getSizeInBytes()
```
    Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
    
    Returns:
    
    Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
  - withSizeInBytes
```
public FileSystemDescription withSizeInBytes(FileSystemSize sizeInBytes)
```
    Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
    
    Parameters:
    
    sizeInBytes - Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPerformanceMode
```
public void setPerformanceMode(String performanceMode)
```
    The PerformanceMode of the file system.
    
    Parameters:
    
    performanceMode - The PerformanceMode of the file system.
    
    See Also:
    
    PerformanceMode
  - getPerformanceMode
```
public String getPerformanceMode()
```
    The PerformanceMode of the file system.
    
    Returns:
    
    The PerformanceMode of the file system.
    
    See Also:
    
    PerformanceMode
  - withPerformanceMode
```
public FileSystemDescription withPerformanceMode(String performanceMode)
```
    The PerformanceMode of the file system.
    
    Parameters:
    
    performanceMode - The PerformanceMode of the file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PerformanceMode
  - setPerformanceMode
```
public void setPerformanceMode(PerformanceMode performanceMode)
```
    The PerformanceMode of the file system.
    
    Parameters:
    
    performanceMode - The PerformanceMode of the file system.
    
    See Also:
    
    PerformanceMode
  - withPerformanceMode
```
public FileSystemDescription withPerformanceMode(PerformanceMode performanceMode)
```
    The PerformanceMode of the file system.
    
    Parameters:
    
    performanceMode - The PerformanceMode of the file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PerformanceMode
  - setEncrypted
```
public void setEncrypted(Boolean encrypted)
```
    A boolean value that, if true, indicates that the file system is encrypted.
    
    Parameters:
    
    encrypted - A boolean value that, if true, indicates that the file system is encrypted.
  - getEncrypted
```
public Boolean getEncrypted()
```
    A boolean value that, if true, indicates that the file system is encrypted.
    
    Returns:
    
    A boolean value that, if true, indicates that the file system is encrypted.
  - withEncrypted
```
public FileSystemDescription withEncrypted(Boolean encrypted)
```
    A boolean value that, if true, indicates that the file system is encrypted.
    
    Parameters:
    
    encrypted - A boolean value that, if true, indicates that the file system is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEncrypted
```
public Boolean isEncrypted()
```
    A boolean value that, if true, indicates that the file system is encrypted.
    
    Returns:
    
    A boolean value that, if true, indicates that the file system is encrypted.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
    
    Parameters:
    
    kmsKeyId - The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
    
    Returns:
    
    The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
  - withKmsKeyId
```
public FileSystemDescription withKmsKeyId(String kmsKeyId)
```
    The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
    
    Parameters:
    
    kmsKeyId - The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FileSystemDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FileSystemDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileSystemDescription

Method Detail

setOwnerId

getOwnerId

withOwnerId

setCreationToken

getCreationToken

withCreationToken

setFileSystemId

getFileSystemId

withFileSystemId

setCreationTime

getCreationTime

withCreationTime

setLifeCycleState

getLifeCycleState

withLifeCycleState

setLifeCycleState

withLifeCycleState

setName

getName

withName

setNumberOfMountTargets

getNumberOfMountTargets

withNumberOfMountTargets

setSizeInBytes

getSizeInBytes

withSizeInBytes

setPerformanceMode

getPerformanceMode

withPerformanceMode

setPerformanceMode

withPerformanceMode

setEncrypted

getEncrypted

withEncrypted

isEncrypted

setKmsKeyId

getKmsKeyId

withKmsKeyId

toString

equals

hashCode

clone

marshall