@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FileSystemDescription extends Object implements Serializable, Cloneable, StructuredPojo
A description of the file system.
Constructor and Description |
---|
FileSystemDescription() |
Modifier and Type | Method and Description |
---|---|
FileSystemDescription |
clone() |
boolean |
equals(Object obj) |
String |
getAvailabilityZoneId()
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems.
|
String |
getAvailabilityZoneName()
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for
One Zone file systems.
|
Date |
getCreationTime()
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
|
String |
getCreationToken()
The opaque string specified in the request.
|
Boolean |
getEncrypted()
A Boolean value that, if true, indicates that the file system is encrypted.
|
String |
getFileSystemArn()
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . |
String |
getFileSystemId()
The ID of the file system, assigned by Amazon EFS.
|
FileSystemProtectionDescription |
getFileSystemProtection()
Describes the protection on the file system.
|
String |
getKmsKeyId()
The ID of an KMS key used to protect the encrypted file system.
|
String |
getLifeCycleState()
The lifecycle phase of the file system.
|
String |
getName()
You can add tags to a file system, including a
Name tag. |
Integer |
getNumberOfMountTargets()
The current number of mount targets that the file system has.
|
String |
getOwnerId()
The Amazon Web Services account that created the file system.
|
String |
getPerformanceMode()
The Performance mode of the file system.
|
Double |
getProvisionedThroughputInMibps()
The amount of provisioned throughput, measured in MiBps, for the file system.
|
FileSystemSize |
getSizeInBytes()
The latest known metered size (in bytes) of data stored in the file system, in its
Value field, and
the time at which that size was determined in its Timestamp field. |
List<Tag> |
getTags()
The tags associated with the file system, presented as an array of
Tag objects. |
String |
getThroughputMode()
Displays the file system's throughput mode.
|
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 |
setAvailabilityZoneId(String availabilityZoneId)
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems.
|
void |
setAvailabilityZoneName(String availabilityZoneName)
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for
One Zone file systems.
|
void |
setCreationTime(Date creationTime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
|
void |
setCreationToken(String creationToken)
The opaque string specified in the request.
|
void |
setEncrypted(Boolean encrypted)
A Boolean value that, if true, indicates that the file system is encrypted.
|
void |
setFileSystemArn(String fileSystemArn)
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . |
void |
setFileSystemId(String fileSystemId)
The ID of the file system, assigned by Amazon EFS.
|
void |
setFileSystemProtection(FileSystemProtectionDescription fileSystemProtection)
Describes the protection on the file system.
|
void |
setKmsKeyId(String kmsKeyId)
The ID of an KMS key used to protect the encrypted file system.
|
void |
setLifeCycleState(LifeCycleState lifeCycleState)
The lifecycle phase of the file system.
|
void |
setLifeCycleState(String lifeCycleState)
The 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)
The current number of mount targets that the file system has.
|
void |
setOwnerId(String ownerId)
The Amazon Web Services account that created the file system.
|
void |
setPerformanceMode(PerformanceMode performanceMode)
The Performance mode of the file system.
|
void |
setPerformanceMode(String performanceMode)
The Performance mode of the file system.
|
void |
setProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The amount of provisioned throughput, measured in MiBps, for the file system.
|
void |
setSizeInBytes(FileSystemSize sizeInBytes)
The latest known metered size (in bytes) of data stored in the file system, in its
Value field, and
the time at which that size was determined in its Timestamp field. |
void |
setTags(Collection<Tag> tags)
The tags associated with the file system, presented as an array of
Tag objects. |
void |
setThroughputMode(String throughputMode)
Displays the file system's throughput mode.
|
void |
setThroughputMode(ThroughputMode throughputMode)
Displays the file system's throughput mode.
|
String |
toString()
Returns a string representation of this object.
|
FileSystemDescription |
withAvailabilityZoneId(String availabilityZoneId)
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems.
|
FileSystemDescription |
withAvailabilityZoneName(String availabilityZoneName)
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for
One Zone file systems.
|
FileSystemDescription |
withCreationTime(Date creationTime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
|
FileSystemDescription |
withCreationToken(String creationToken)
The opaque string specified in the request.
|
FileSystemDescription |
withEncrypted(Boolean encrypted)
A Boolean value that, if true, indicates that the file system is encrypted.
|
FileSystemDescription |
withFileSystemArn(String fileSystemArn)
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . |
FileSystemDescription |
withFileSystemId(String fileSystemId)
The ID of the file system, assigned by Amazon EFS.
|
FileSystemDescription |
withFileSystemProtection(FileSystemProtectionDescription fileSystemProtection)
Describes the protection on the file system.
|
FileSystemDescription |
withKmsKeyId(String kmsKeyId)
The ID of an KMS key used to protect the encrypted file system.
|
FileSystemDescription |
withLifeCycleState(LifeCycleState lifeCycleState)
The lifecycle phase of the file system.
|
FileSystemDescription |
withLifeCycleState(String lifeCycleState)
The 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)
The current number of mount targets that the file system has.
|
FileSystemDescription |
withOwnerId(String ownerId)
The Amazon Web Services account that created the file system.
|
FileSystemDescription |
withPerformanceMode(PerformanceMode performanceMode)
The Performance mode of the file system.
|
FileSystemDescription |
withPerformanceMode(String performanceMode)
The Performance mode of the file system.
|
FileSystemDescription |
withProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The amount of provisioned throughput, measured in MiBps, for the file system.
|
FileSystemDescription |
withSizeInBytes(FileSystemSize sizeInBytes)
The latest known metered size (in bytes) of data stored in the file system, in its
Value field, and
the time at which that size was determined in its Timestamp field. |
FileSystemDescription |
withTags(Collection<Tag> tags)
The tags associated with the file system, presented as an array of
Tag objects. |
FileSystemDescription |
withTags(Tag... tags)
The tags associated with the file system, presented as an array of
Tag objects. |
FileSystemDescription |
withThroughputMode(String throughputMode)
Displays the file system's throughput mode.
|
FileSystemDescription |
withThroughputMode(ThroughputMode throughputMode)
Displays the file system's throughput mode.
|
public void setOwnerId(String ownerId)
The Amazon Web Services account that created the file system.
ownerId
- The Amazon Web Services account that created the file system.public String getOwnerId()
The Amazon Web Services account that created the file system.
public FileSystemDescription withOwnerId(String ownerId)
The Amazon Web Services account that created the file system.
ownerId
- The Amazon Web Services account that created the file system.public void setCreationToken(String creationToken)
The opaque string specified in the request.
creationToken
- The opaque string specified in the request.public String getCreationToken()
The opaque string specified in the request.
public FileSystemDescription withCreationToken(String creationToken)
The opaque string specified in the request.
creationToken
- The opaque string specified in the request.public void setFileSystemId(String fileSystemId)
The ID of the file system, assigned by Amazon EFS.
fileSystemId
- The ID of the file system, assigned by Amazon EFS.public String getFileSystemId()
The ID of the file system, assigned by Amazon EFS.
public FileSystemDescription withFileSystemId(String fileSystemId)
The ID of the file system, assigned by Amazon EFS.
fileSystemId
- The ID of the file system, assigned by Amazon EFS.public void setFileSystemArn(String fileSystemArn)
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
fileSystemArn
- The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
public String getFileSystemArn()
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
. Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
public FileSystemDescription withFileSystemArn(String fileSystemArn)
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
fileSystemArn
- The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
public void setCreationTime(Date creationTime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
creationTime
- The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).public Date getCreationTime()
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
public FileSystemDescription withCreationTime(Date creationTime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
creationTime
- The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).public void setLifeCycleState(String lifeCycleState)
The lifecycle phase of the file system.
lifeCycleState
- The lifecycle phase of the file system.LifeCycleState
public String getLifeCycleState()
The lifecycle phase of the file system.
LifeCycleState
public FileSystemDescription withLifeCycleState(String lifeCycleState)
The lifecycle phase of the file system.
lifeCycleState
- The lifecycle phase of the file system.LifeCycleState
public void setLifeCycleState(LifeCycleState lifeCycleState)
The lifecycle phase of the file system.
lifeCycleState
- The lifecycle phase of the file system.LifeCycleState
public FileSystemDescription withLifeCycleState(LifeCycleState lifeCycleState)
The lifecycle phase of the file system.
lifeCycleState
- The lifecycle phase of the file system.LifeCycleState
public void setName(String name)
You can add tags to a file system, including a Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in this
field.
name
- You can add tags to a file system, including a Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in
this field.public String getName()
You can add tags to a file system, including a Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in this
field.
Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in
this field.public FileSystemDescription withName(String name)
You can add tags to a file system, including a Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in this
field.
name
- You can add tags to a file system, including a Name
tag. For more information, see
CreateFileSystem. If the file system has a Name
tag, Amazon EFS returns the value in
this field.public void setNumberOfMountTargets(Integer numberOfMountTargets)
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
numberOfMountTargets
- The current number of mount targets that the file system has. For more information, see
CreateMountTarget.public Integer getNumberOfMountTargets()
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
public FileSystemDescription withNumberOfMountTargets(Integer numberOfMountTargets)
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
numberOfMountTargets
- The current number of mount targets that the file system has. For more information, see
CreateMountTarget.public void setSizeInBytes(FileSystemSize sizeInBytes)
The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes
value doesn't 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, SizeInBytes
represents 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 that the file system was
at any point in time.
sizeInBytes
- The latest known metered size (in bytes) of data stored in the file system, 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. The
SizeInBytes
value doesn't 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, SizeInBytes
represents 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 that the file system was at any point in time.public FileSystemSize getSizeInBytes()
The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes
value doesn't 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, SizeInBytes
represents 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 that the file system was
at any point in time.
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. The
SizeInBytes
value doesn't 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,
SizeInBytes
represents 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 that the file system was at any
point in time.public FileSystemDescription withSizeInBytes(FileSystemSize sizeInBytes)
The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes
value doesn't 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, SizeInBytes
represents 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 that the file system was
at any point in time.
sizeInBytes
- The latest known metered size (in bytes) of data stored in the file system, 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. The
SizeInBytes
value doesn't 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, SizeInBytes
represents 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 that the file system was at any point in time.public void setPerformanceMode(String performanceMode)
The Performance mode of the file system.
performanceMode
- The Performance mode of the file system.PerformanceMode
public String getPerformanceMode()
The Performance mode of the file system.
PerformanceMode
public FileSystemDescription withPerformanceMode(String performanceMode)
The Performance mode of the file system.
performanceMode
- The Performance mode of the file system.PerformanceMode
public void setPerformanceMode(PerformanceMode performanceMode)
The Performance mode of the file system.
performanceMode
- The Performance mode of the file system.PerformanceMode
public FileSystemDescription withPerformanceMode(PerformanceMode performanceMode)
The Performance mode of the file system.
performanceMode
- The Performance mode of the file system.PerformanceMode
public void setEncrypted(Boolean encrypted)
A Boolean value that, if true, indicates that the file system is encrypted.
encrypted
- A Boolean value that, if true, indicates that the file system is encrypted.public Boolean getEncrypted()
A Boolean value that, if true, indicates that the file system is encrypted.
public FileSystemDescription withEncrypted(Boolean encrypted)
A Boolean value that, if true, indicates that the file system is encrypted.
encrypted
- A Boolean value that, if true, indicates that the file system is encrypted.public Boolean isEncrypted()
A Boolean value that, if true, indicates that the file system is encrypted.
public void setKmsKeyId(String kmsKeyId)
The ID of an KMS key used to protect the encrypted file system.
kmsKeyId
- The ID of an KMS key used to protect the encrypted file system.public String getKmsKeyId()
The ID of an KMS key used to protect the encrypted file system.
public FileSystemDescription withKmsKeyId(String kmsKeyId)
The ID of an KMS key used to protect the encrypted file system.
kmsKeyId
- The ID of an KMS key used to protect the encrypted file system.public void setThroughputMode(String throughputMode)
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in
the Amazon EFS User Guide.ThroughputMode
public String getThroughputMode()
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
ThroughputMode
public FileSystemDescription withThroughputMode(String throughputMode)
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in
the Amazon EFS User Guide.ThroughputMode
public void setThroughputMode(ThroughputMode throughputMode)
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in
the Amazon EFS User Guide.ThroughputMode
public FileSystemDescription withThroughputMode(ThroughputMode throughputMode)
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
throughputMode
- Displays the file system's throughput mode. For more information, see Throughput modes in
the Amazon EFS User Guide.ThroughputMode
public void setProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set to provisioned
.
provisionedThroughputInMibps
- The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set to provisioned
.public Double getProvisionedThroughputInMibps()
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set to provisioned
.
ThroughputMode
set to provisioned
.public FileSystemDescription withProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set to provisioned
.
provisionedThroughputInMibps
- The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set to provisioned
.public void setAvailabilityZoneName(String availabilityZoneName)
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
availabilityZoneName
- Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only
for One Zone file systems. For more information, see Using EFS storage classes in the
Amazon EFS User Guide.public String getAvailabilityZoneName()
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
public FileSystemDescription withAvailabilityZoneName(String availabilityZoneName)
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
availabilityZoneName
- Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only
for One Zone file systems. For more information, see Using EFS storage classes in the
Amazon EFS User Guide.public void setAvailabilityZoneId(String availabilityZoneId)
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems. For example, use1-az1
is an Availability Zone ID for the us-east-1
Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
availabilityZoneId
- The unique and consistent identifier of the Availability Zone in which the file system is located, and is
valid only for One Zone file systems. For example, use1-az1
is an Availability Zone ID for
the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services
account.public String getAvailabilityZoneId()
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems. For example, use1-az1
is an Availability Zone ID for the us-east-1
Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
use1-az1
is an Availability Zone ID for
the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services
account.public FileSystemDescription withAvailabilityZoneId(String availabilityZoneId)
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid
only for One Zone file systems. For example, use1-az1
is an Availability Zone ID for the us-east-1
Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
availabilityZoneId
- The unique and consistent identifier of the Availability Zone in which the file system is located, and is
valid only for One Zone file systems. For example, use1-az1
is an Availability Zone ID for
the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services
account.public List<Tag> getTags()
The tags associated with the file system, presented as an array of Tag
objects.
Tag
objects.public void setTags(Collection<Tag> tags)
The tags associated with the file system, presented as an array of Tag
objects.
tags
- The tags associated with the file system, presented as an array of Tag
objects.public FileSystemDescription withTags(Tag... tags)
The tags associated with the file system, presented as an array of Tag
objects.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tags associated with the file system, presented as an array of Tag
objects.public FileSystemDescription withTags(Collection<Tag> tags)
The tags associated with the file system, presented as an array of Tag
objects.
tags
- The tags associated with the file system, presented as an array of Tag
objects.public void setFileSystemProtection(FileSystemProtectionDescription fileSystemProtection)
Describes the protection on the file system.
fileSystemProtection
- Describes the protection on the file system.public FileSystemProtectionDescription getFileSystemProtection()
Describes the protection on the file system.
public FileSystemDescription withFileSystemProtection(FileSystemProtectionDescription fileSystemProtection)
Describes the protection on the file system.
fileSystemProtection
- Describes the protection on the file system.public String toString()
toString
in class Object
Object.toString()
public FileSystemDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.