@Generated(value="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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
FileUploaderFieldConfig.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
acceptedFileTypes()
The file types that are allowed to be uploaded by the file uploader.
|
StorageAccessLevel |
accessLevel()
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
|
String |
accessLevelAsString()
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
|
static FileUploaderFieldConfig.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAcceptedFileTypes()
For responses, this returns true if the service returned a value for the AcceptedFileTypes property.
|
int |
hashCode() |
Boolean |
isResumable()
Allows the file upload operation to be paused and resumed.
|
Integer |
maxFileCount()
Specifies the maximum number of files that can be selected to upload.
|
Integer |
maxSize()
The maximum file size in bytes that the file uploader will accept.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends FileUploaderFieldConfig.Builder> |
serializableBuilderClass() |
Boolean |
showThumbnails()
Specifies whether to display or hide the image preview after selecting a file for upload.
|
FileUploaderFieldConfig.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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().
private, protected, or public. For
detailed information about the permissions associated with each access level, see File access levels in the
Amplify documentation.StorageAccessLevelpublic 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().
private, protected, or public. For
detailed information about the permissions associated with each access level, see File access levels in the
Amplify documentation.StorageAccessLevelpublic final boolean hasAcceptedFileTypes()
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.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.
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.
true to display the image preview.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.
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.
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.
public final Integer maxSize()
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
public FileUploaderFieldConfig.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<FileUploaderFieldConfig.Builder,FileUploaderFieldConfig>public static FileUploaderFieldConfig.Builder builder()
public static Class<? extends FileUploaderFieldConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.