Class CreateFileSystemResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFileSystemResponse.Builder,
CreateFileSystemResponse>
A description of the file system.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
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.final String
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems.builder()
final Instant
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).final String
The opaque string specified in the request.final Boolean
A Boolean value that, if true, indicates that the file system is encrypted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) for the EFS file system, in the formatarn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.final String
The ID of the file system, assigned by Amazon EFS.Describes the protection on the file system.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The ID of an KMS key used to protect the encrypted file system.final LifeCycleState
The lifecycle phase of the file system.final String
The lifecycle phase of the file system.final String
name()
You can add tags to a file system, including aName
tag.final Integer
The current number of mount targets that the file system has.final String
ownerId()
The Amazon Web Services account that created the file system.final PerformanceMode
The Performance mode of the file system.final String
The Performance mode of the file system.final Double
The amount of provisioned throughput, measured in MiBps, for the file system.static Class
<? extends CreateFileSystemResponse.Builder> final FileSystemSize
The latest known metered size (in bytes) of data stored in the file system, in itsValue
field, and the time at which that size was determined in itsTimestamp
field.tags()
The tags associated with the file system, presented as an array ofTag
objects.final ThroughputMode
Displays the file system's throughput mode.final String
Displays the file system's throughput mode.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.efs.model.EfsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ownerId
The Amazon Web Services account that created the file system.
- Returns:
- The Amazon Web Services account that created the file system.
-
creationToken
The opaque string specified in the request.
- Returns:
- The opaque string specified in the request.
-
fileSystemId
The ID of the file system, assigned by Amazon EFS.
- Returns:
- The ID of the file system, assigned by Amazon EFS.
-
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
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
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 returnLifeCycleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifeCycleStateAsString()
.- Returns:
- The lifecycle phase of the file system.
- See Also:
-
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 returnLifeCycleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifeCycleStateAsString()
.- Returns:
- The lifecycle phase of the file system.
- See Also:
-
name
You can add tags to a file system, including a
Name
tag. For more information, see CreateFileSystem. If the file system has aName
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 aName
tag, Amazon EFS returns the value in this field.
-
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
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 itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
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 itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
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
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 returnPerformanceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperformanceModeAsString()
.- Returns:
- The Performance mode of the file system.
- See Also:
-
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 returnPerformanceMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperformanceModeAsString()
.- Returns:
- The Performance mode of the file system.
- See Also:
-
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
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
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 returnThroughputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthroughputModeAsString()
.- Returns:
- Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
- See Also:
-
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 returnThroughputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthroughputModeAsString()
.- Returns:
- Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
- See Also:
-
provisionedThroughputInMibps
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set toprovisioned
.- Returns:
- The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems
using
ThroughputMode
set toprovisioned
.
-
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.
- Returns:
- 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.
-
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.- Returns:
- 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.
-
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 theisEmpty()
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
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.
-
fileSystemProtection
Describes the protection on the file system.
- Returns:
- Describes the protection on the file system.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFileSystemResponse.Builder,
CreateFileSystemResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-