Class CreateFileSystemResponse

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

  • Method Details

    • creationTime

      public final Instant creationTime()

      The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).

      Returns:
      The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).

    • fileSystemArn

      public final String fileSystemArn()

      The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id.

      Returns:
      The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id.

    • fileSystemId

      public final String fileSystemId()

      The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.

      Returns:
      The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.

    • bucket

      public final String bucket()

      The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.

      Returns:
      The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.

    • prefix

      public final String prefix()

      The prefix within the S3 bucket that scopes the file system access.

      Returns:
      The prefix within the S3 bucket that scopes the file system access.

    • clientToken

      public final String clientToken()

      The client token used for idempotency.

      Returns:
      The client token used for idempotency.

    • kmsKeyId

      public final String kmsKeyId()

      The ARN or alias of the KMS key used for encryption.

      Returns:
      The ARN or alias of the KMS key used for encryption.

    • status

      public final LifeCycleState status()

      The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).

      If the service returns an enum value that is not available in the current SDK version, status will return LifeCycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).
      See Also:

    • statusAsString

      public final String statusAsString()

      The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).

      If the service returns an enum value that is not available in the current SDK version, status will return LifeCycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).
      See Also:

    • statusMessage

      public final String statusMessage()

      Additional information about the file system status. This field provides more details when the status is ERROR, or during state transitions.

      Returns:
      Additional information about the file system status. This field provides more details when the status is ERROR, or during state transitions.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role used for S3 access.

      Returns:
      The ARN of the IAM role used for S3 access.

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the file system owner.

      Returns:
      The Amazon Web Services account ID of the file system owner.

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

      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.

    • name

      public final String name()

      The name of the file system, derived from the Name tag if present.

      Returns:
      The name of the file system, derived from the Name tag if present.

    • toBuilder

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

    • builder

      public static CreateFileSystemResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateFileSystemResponse.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.