com.amazonaws.services.elasticfilesystem.model

Class FileSystemDescription

java.lang.Object

com.amazonaws.services.elasticfilesystem.model.FileSystemDescription

All Implemented Interfaces:

Serializable, Cloneable

public class FileSystemDescription
extends Object
implements Serializable, Cloneable

This object provides description of a file system.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileSystemDescription()

Method Summary

Methods

Modifier and Type	Method and Description
FileSystemDescription	clone()
boolean	equals(Object obj)
Date	getCreationTime() The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
String	getCreationToken() Opaque string specified in the request.
String	getFileSystemId() The file system ID assigned by Amazon EFS.
String	getLifeCycleState() A predefined string value that indicates the lifecycle phase of the file system.
String	getName() You can add tags to a file system (see CreateTags) including a "Name" tag.
Integer	getNumberOfMountTargets() The current number of mount targets (see CreateMountTarget) the file system has.
String	getOwnerId() The AWS account that created the file system.
FileSystemSize	getSizeInBytes() This object provides the latest known metered size 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()
void	setCreationTime(Date creationTime) The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
void	setCreationToken(String creationToken) Opaque string specified in the request.
void	setFileSystemId(String fileSystemId) The file system ID assigned by Amazon EFS.
void	setLifeCycleState(LifeCycleState lifeCycleState) A predefined string value that indicates the lifecycle phase of the file system.
void	setLifeCycleState(String lifeCycleState) A predefined string value that indicates the lifecycle phase of the file system.
void	setName(String name) You can add tags to a file system (see CreateTags) including a "Name" tag.
void	setNumberOfMountTargets(Integer numberOfMountTargets) The current number of mount targets (see CreateMountTarget) the file system has.
void	setOwnerId(String ownerId) The AWS account that created the file system.
void	setSizeInBytes(FileSystemSize sizeInBytes) This object provides the latest known metered size 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) The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
FileSystemDescription	withCreationToken(String creationToken) Opaque string specified in the request.
FileSystemDescription	withFileSystemId(String fileSystemId) The file system ID assigned by Amazon EFS.
FileSystemDescription	withLifeCycleState(LifeCycleState lifeCycleState) A predefined string value that indicates the lifecycle phase of the file system.
FileSystemDescription	withLifeCycleState(String lifeCycleState) A predefined string value that indicates the lifecycle phase of the file system.
FileSystemDescription	withName(String name) You can add tags to a file system (see CreateTags) including a "Name" tag.
FileSystemDescription	withNumberOfMountTargets(Integer numberOfMountTargets) The current number of mount targets (see CreateMountTarget) the file system has.
FileSystemDescription	withOwnerId(String ownerId) The AWS account that created the file system.
FileSystemDescription	withSizeInBytes(FileSystemSize sizeInBytes) This object provides the latest known metered size 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

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

Constructor Detail

FileSystemDescription

public FileSystemDescription()

Method Detail

getOwnerId

public String getOwnerId()

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

Constraints:
Pattern: [0-9]{12}

Returns:

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

setOwnerId

public void setOwnerId(String ownerId)

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

Constraints:
Pattern: [0-9]{12}

Parameters:

ownerId - The 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)

The 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 a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [0-9]{12}

Parameters:

ownerId - The 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:

A reference to this updated object so that method calls can be chained together.

getCreationToken

public String getCreationToken()

Opaque string specified in the request.

Constraints:
Length: 1 - 64

Returns:

Opaque string specified in the request.

setCreationToken

public void setCreationToken(String creationToken)

Opaque string specified in the request.

Constraints:
Length: 1 - 64

Parameters:

creationToken - Opaque string specified in the request.

withCreationToken

public FileSystemDescription withCreationToken(String creationToken)

Opaque string specified in the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

Parameters:

creationToken - Opaque string specified in the request.

Returns:

A reference to this updated object so that method calls can be chained together.

getFileSystemId

public String getFileSystemId()

The file system ID assigned by Amazon EFS.

Constraints:
Pattern: fs-[0-9a-f]{8}

Returns:

The file system ID assigned by Amazon EFS.

setFileSystemId

public void setFileSystemId(String fileSystemId)

The file system ID assigned by Amazon EFS.

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - The file system ID assigned by Amazon EFS.

withFileSystemId

public FileSystemDescription withFileSystemId(String fileSystemId)

The file system ID assigned by Amazon EFS.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - The file system ID assigned by Amazon EFS.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreationTime

public Date getCreationTime()

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

Returns:

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

setCreationTime

public void setCreationTime(Date creationTime)

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

Parameters:

creationTime - The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

withCreationTime

public FileSystemDescription withCreationTime(Date creationTime)

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

Returns a reference to this object so that method calls can be chained together.

Parameters:

creationTime - The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

Returns:

A reference to this updated object so that method calls can be chained together.

getLifeCycleState

public String getLifeCycleState()

A predefined string value that indicates the lifecycle phase of the file system.

Constraints:
Allowed Values: creating, available, deleting, deleted

Returns:

A predefined string value that indicates the lifecycle phase of the file system.

See Also:

LifeCycleState

setLifeCycleState

public void setLifeCycleState(String lifeCycleState)

A predefined string value that indicates the lifecycle phase of the file system.

Constraints:
Allowed Values: creating, available, deleting, deleted

Parameters:

lifeCycleState - A predefined string value that indicates the lifecycle phase of the file system.

See Also:

LifeCycleState

withLifeCycleState

public FileSystemDescription withLifeCycleState(String lifeCycleState)

A predefined string value that indicates the lifecycle phase of the file system.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: creating, available, deleting, deleted

Parameters:

lifeCycleState - A predefined string value that indicates the lifecycle phase of the file system.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LifeCycleState

setLifeCycleState

public void setLifeCycleState(LifeCycleState lifeCycleState)

A predefined string value that indicates the lifecycle phase of the file system.

Constraints:
Allowed Values: creating, available, deleting, deleted

Parameters:

lifeCycleState - A predefined string value that indicates the lifecycle phase of the file system.

See Also:

LifeCycleState

withLifeCycleState

public FileSystemDescription withLifeCycleState(LifeCycleState lifeCycleState)

A predefined string value that indicates the lifecycle phase of the file system.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: creating, available, deleting, deleted

Parameters:

lifeCycleState - A predefined string value that indicates the lifecycle phase of the file system.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LifeCycleState

getName

public String getName()

You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

Constraints:
Length: 0 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Returns:

You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

setName

public void setName(String name)

You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

Constraints:
Length: 0 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

name - You can add tags to a file system (see CreateTags) including a "Name" tag. 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 (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Parameters:

name - You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.

Returns:

A reference to this updated object so that method calls can be chained together.

getNumberOfMountTargets

public Integer getNumberOfMountTargets()

The current number of mount targets (see CreateMountTarget) the file system has.

Constraints:
Range: 0 -

Returns:

The current number of mount targets (see CreateMountTarget) the file system has.

setNumberOfMountTargets

public void setNumberOfMountTargets(Integer numberOfMountTargets)

The current number of mount targets (see CreateMountTarget) the file system has.

Constraints:
Range: 0 -

Parameters:

numberOfMountTargets - The current number of mount targets (see CreateMountTarget) the file system has.

withNumberOfMountTargets

public FileSystemDescription withNumberOfMountTargets(Integer numberOfMountTargets)

The current number of mount targets (see CreateMountTarget) the file system has.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

numberOfMountTargets - The current number of mount targets (see CreateMountTarget) the file system has.

Returns:

A reference to this updated object so that method calls can be chained together.

getSizeInBytes

public FileSystemSize getSizeInBytes()

This object provides the latest known metered size 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:

This object provides the latest known metered size 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.

setSizeInBytes

public void setSizeInBytes(FileSystemSize sizeInBytes)

This object provides the latest known metered size 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 - This object provides the latest known metered size 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)

This object provides the latest known metered size 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 a reference to this object so that method calls can be chained together.

Parameters:

sizeInBytes - This object provides the latest known metered size 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:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public FileSystemDescription clone()

Overrides:

clone in class Object