Class UpdateFileSystemResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.efs.model.EfsResponse
software.amazon.awssdk.services.efs.model.UpdateFileSystemResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateFileSystemResponse.Builder,UpdateFileSystemResponse>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFileSystemResponse extends EfsResponse implements ToCopyableBuilder<UpdateFileSystemResponse.Builder,UpdateFileSystemResponse>

A description of the file system.

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 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

      public final 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.

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

    • fileSystemProtection

      public final FileSystemProtectionDescription fileSystemProtection()

      Describes the protection on the file system.

      Returns:
      Describes the protection on the file system.

    • toBuilder

      public UpdateFileSystemResponse.Builder 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 interface ToCopyableBuilder<UpdateFileSystemResponse.Builder,UpdateFileSystemResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static UpdateFileSystemResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFileSystemResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.