FileSystemDescription (AWS Java SDK :: Services :: Amazon Elastic File System 2.21.17 API)

java.lang.Object
- software.amazon.awssdk.services.efs.model.FileSystemDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class FileSystemDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>

A description of the file system.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FileSystemDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FileSystemDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZoneId()` The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist.
`String`	`availabilityZoneName()` Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes.
`static FileSystemDescription.Builder`	`builder()`
`Instant`	`creationTime()` The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
`String`	`creationToken()` The opaque string specified in the request.
`Boolean`	`encrypted()` A Boolean value that, if true, indicates that the file system is encrypted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`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` .
`String`	`fileSystemId()` The ID of the file system, assigned by Amazon EFS.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()` The ID of an KMS key used to protect the encrypted file system.
`LifeCycleState`	`lifeCycleState()` The lifecycle phase of the file system.
`String`	`lifeCycleStateAsString()` The lifecycle phase of the file system.
`String`	`name()` You can add tags to a file system, including a `Name` tag.
`Integer`	`numberOfMountTargets()` The current number of mount targets that the file system has.
`String`	`ownerId()` The Amazon Web Services account that created the file system.
`PerformanceMode`	`performanceMode()` The performance mode of the file system.
`String`	`performanceModeAsString()` The performance mode of the file system.
`Double`	`provisionedThroughputInMibps()` The amount of provisioned throughput, measured in MiBps, for the file system.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FileSystemDescription.Builder>`	`serializableBuilderClass()`
`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.
`List<Tag>`	`tags()` The tags associated with the file system, presented as an array of `Tag` objects.
`ThroughputMode`	`throughputMode()` Displays the file system's throughput mode.
`String`	`throughputModeAsString()` Displays the file system's throughput mode.
`FileSystemDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ownerId
```
public final String ownerId()
```
    The Amazon Web Services account that created the file system.
    
    Returns:
    
    The Amazon Web Services account that created the file system.
  - creationToken
```
public final String creationToken()
```
    The opaque string specified in the request.
    
    Returns:
    
    The opaque string specified in the request.
  - fileSystemId
```
public final String fileSystemId()
```
    The ID of the file system, assigned by Amazon EFS.
    
    Returns:
    
    The ID of the file system, assigned by Amazon EFS.
  - fileSystemArn
```
public final 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
    
    Returns:
    
    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
  - creationTime
```
public final Instant creationTime()
```
    The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
    
    Returns:
    
    The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
  - lifeCycleState
```
public final LifeCycleState lifeCycleState()
```
    The lifecycle phase of the file system.
    
    If the service returns an enum value that is not available in the current SDK version, lifeCycleState will return LifeCycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifeCycleStateAsString().
    
    Returns:
    
    The lifecycle phase of the file system.
    
    See Also:
    
    LifeCycleState
  - lifeCycleStateAsString
```
public final String lifeCycleStateAsString()
```
    The lifecycle phase of the file system.
    
    If the service returns an enum value that is not available in the current SDK version, lifeCycleState will return LifeCycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifeCycleStateAsString().
    
    Returns:
    
    The lifecycle phase of the file system.
    
    See Also:
    
    LifeCycleState
  - name
```
public final 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.
    
    Returns:
    
    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.
  - numberOfMountTargets
```
public final Integer numberOfMountTargets()
```
    The current number of mount targets that the file system has. For more information, see CreateMountTarget.
    
    Returns:
    
    The current number of mount targets that the file system has. For more information, see CreateMountTarget.
  - sizeInBytes
```
public final 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.
    
    Returns:
    
    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.
  - performanceMode
```
public final PerformanceMode performanceMode()
```
    The performance mode of the file system.
    
    If the service returns an enum value that is not available in the current SDK version, performanceMode will return PerformanceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceModeAsString().
    
    Returns:
    
    The performance mode of the file system.
    
    See Also:
    
    PerformanceMode
  - performanceModeAsString
```
public final String performanceModeAsString()
```
    The performance mode of the file system.
    
    If the service returns an enum value that is not available in the current SDK version, performanceMode will return PerformanceMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceModeAsString().
    
    Returns:
    
    The performance mode of the file system.
    
    See Also:
    
    PerformanceMode
  - encrypted
```
public final Boolean encrypted()
```
    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.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of an KMS key used to protect the encrypted file system.
    
    Returns:
    
    The ID of an KMS key used to protect the encrypted file system.
  - throughputMode
```
public final ThroughputMode throughputMode()
```
    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, throughputMode will return ThroughputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from throughputModeAsString().
    
    Returns:
    
    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
    
    See Also:
    
    ThroughputMode
  - throughputModeAsString
```
public final String throughputModeAsString()
```
    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, throughputMode will return ThroughputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from throughputModeAsString().
    
    Returns:
    
    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
    
    See Also:
    
    ThroughputMode
  - provisionedThroughputInMibps
```
public final Double provisionedThroughputInMibps()
```
    The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.
    
    Returns:
    
    The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.
  - availabilityZoneName
```
public final String availabilityZoneName()
```
    Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
    
    Returns:
    
    Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
  - availabilityZoneId
```
public final String availabilityZoneId()
```
    The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. 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.
    
    Returns:
    
    The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. 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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The tags associated with the file system, presented as an array of Tag objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags associated with the file system, presented as an array of Tag objects.
  - toBuilder
```
public FileSystemDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FileSystemDescription.Builder,FileSystemDescription>
  - builder
```
public static FileSystemDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FileSystemDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FileSystemDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerId

creationToken

fileSystemId

fileSystemArn

creationTime

lifeCycleState

lifeCycleStateAsString

name

numberOfMountTargets

sizeInBytes

performanceMode

performanceModeAsString

encrypted

kmsKeyId

throughputMode

throughputModeAsString

provisionedThroughputInMibps

availabilityZoneName

availabilityZoneId

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields