Class FileUploaderFieldConfig

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.FileUploaderFieldConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FileUploaderFieldConfig.Builder,FileUploaderFieldConfig>
@Generated("software.amazon.awssdk:codegen") public final class FileUploaderFieldConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FileUploaderFieldConfig.Builder,FileUploaderFieldConfig>

Describes the configuration for the file uploader field.

See Also:

  • Method Details

    • accessLevel

      public final StorageAccessLevel accessLevel()

      The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

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

      Returns:
      The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
      See Also:

    • accessLevelAsString

      public final String accessLevelAsString()

      The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.

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

      Returns:
      The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation.
      See Also:

    • hasAcceptedFileTypes

      public final boolean hasAcceptedFileTypes()
      For responses, this returns true if the service returned a value for the AcceptedFileTypes 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.

    • acceptedFileTypes

      public final List<String> acceptedFileTypes()

      The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

      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 hasAcceptedFileTypes() method.

      Returns:
      The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.

    • showThumbnails

      public final Boolean showThumbnails()

      Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

      Returns:
      Specifies whether to display or hide the image preview after selecting a file for upload. The default value is true to display the image preview.

    • isResumable

      public final Boolean isResumable()

      Allows the file upload operation to be paused and resumed. The default value is false.

      When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

      Returns:
      Allows the file upload operation to be paused and resumed. The default value is false.

      When isResumable is set to true, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.

    • maxFileCount

      public final Integer maxFileCount()

      Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

      Returns:
      Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.

    • maxSize

      public final Integer maxSize()

      The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

      Returns:
      The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.

    • toBuilder

      public FileUploaderFieldConfig.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<FileUploaderFieldConfig.Builder,FileUploaderFieldConfig>
      Returns:
      a builder for type T

    • builder

      public static FileUploaderFieldConfig.Builder builder()

    • serializableBuilderClass

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

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