FileUploaderFieldConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplifyuibuilder.model.FileUploaderFieldConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FileUploaderFieldConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the configuration for the file uploader field.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FileUploaderFieldConfig()

Constructors
Constructor and Description
`FileUploaderFieldConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileUploaderFieldConfig`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAcceptedFileTypes()` The file types that are allowed to be uploaded by the file uploader.
`String`	`getAccessLevel()` The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
`Boolean`	`getIsResumable()` Allows the file upload operation to be paused and resumed.
`Integer`	`getMaxFileCount()` Specifies the maximum number of files that can be selected to upload.
`Integer`	`getMaxSize()` The maximum file size in bytes that the file uploader will accept.
`Boolean`	`getShowThumbnails()` Specifies whether to display or hide the image preview after selecting a file for upload.
`int`	`hashCode()`
`Boolean`	`isResumable()` Allows the file upload operation to be paused and resumed.
`Boolean`	`isShowThumbnails()` Specifies whether to display or hide the image preview after selecting a file for upload.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAcceptedFileTypes(Collection<String> acceptedFileTypes)` The file types that are allowed to be uploaded by the file uploader.
`void`	`setAccessLevel(String accessLevel)` The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
`void`	`setIsResumable(Boolean isResumable)` Allows the file upload operation to be paused and resumed.
`void`	`setMaxFileCount(Integer maxFileCount)` Specifies the maximum number of files that can be selected to upload.
`void`	`setMaxSize(Integer maxSize)` The maximum file size in bytes that the file uploader will accept.
`void`	`setShowThumbnails(Boolean showThumbnails)` Specifies whether to display or hide the image preview after selecting a file for upload.
`String`	`toString()` Returns a string representation of this object.
`FileUploaderFieldConfig`	`withAcceptedFileTypes(Collection<String> acceptedFileTypes)` The file types that are allowed to be uploaded by the file uploader.
`FileUploaderFieldConfig`	`withAcceptedFileTypes(String... acceptedFileTypes)` The file types that are allowed to be uploaded by the file uploader.
`FileUploaderFieldConfig`	`withAccessLevel(StorageAccessLevel accessLevel)` The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
`FileUploaderFieldConfig`	`withAccessLevel(String accessLevel)` The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
`FileUploaderFieldConfig`	`withIsResumable(Boolean isResumable)` Allows the file upload operation to be paused and resumed.
`FileUploaderFieldConfig`	`withMaxFileCount(Integer maxFileCount)` Specifies the maximum number of files that can be selected to upload.
`FileUploaderFieldConfig`	`withMaxSize(Integer maxSize)` The maximum file size in bytes that the file uploader will accept.
`FileUploaderFieldConfig`	`withShowThumbnails(Boolean showThumbnails)` Specifies whether to display or hide the image preview after selecting a file for upload.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileUploaderFieldConfig
```
public FileUploaderFieldConfig()
```
- Method Detail
  - setAccessLevel
```
public void setAccessLevel(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    StorageAccessLevel
  - getAccessLevel
```
public String getAccessLevel()
```
    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.
    
    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:
    
    StorageAccessLevel
  - withAccessLevel
```
public FileUploaderFieldConfig withAccessLevel(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageAccessLevel
  - withAccessLevel
```
public FileUploaderFieldConfig withAccessLevel(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageAccessLevel
  - getAcceptedFileTypes
```
public List<String> getAcceptedFileTypes()
```
    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.
    
    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.
  - setAcceptedFileTypes
```
public void setAcceptedFileTypes(Collection<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.
    
    Parameters:
    
    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.
  - withAcceptedFileTypes
```
public FileUploaderFieldConfig withAcceptedFileTypes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAcceptedFileTypes(java.util.Collection) or withAcceptedFileTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAcceptedFileTypes
```
public FileUploaderFieldConfig withAcceptedFileTypes(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShowThumbnails
```
public void setShowThumbnails(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.
    
    Parameters:
    
    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.
  - getShowThumbnails
```
public Boolean getShowThumbnails()
```
    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.
  - withShowThumbnails
```
public FileUploaderFieldConfig withShowThumbnails(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isShowThumbnails
```
public Boolean isShowThumbnails()
```
    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.
  - setIsResumable
```
public void setIsResumable(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.
    
    Parameters:
    
    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.
  - getIsResumable
```
public Boolean getIsResumable()
```
    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.
  - withIsResumable
```
public FileUploaderFieldConfig withIsResumable(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isResumable
```
public 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.
  - setMaxFileCount
```
public void setMaxFileCount(Integer maxFileCount)
```
    Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
    
    Parameters:
    
    maxFileCount - Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
  - getMaxFileCount
```
public Integer getMaxFileCount()
```
    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.
  - withMaxFileCount
```
public FileUploaderFieldConfig withMaxFileCount(Integer maxFileCount)
```
    Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
    
    Parameters:
    
    maxFileCount - Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxSize
```
public void setMaxSize(Integer maxSize)
```
    The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
    
    Parameters:
    
    maxSize - The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
  - getMaxSize
```
public Integer getMaxSize()
```
    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.
  - withMaxSize
```
public FileUploaderFieldConfig withMaxSize(Integer maxSize)
```
    The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
    
    Parameters:
    
    maxSize - The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FileUploaderFieldConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FileUploaderFieldConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileUploaderFieldConfig

Method Detail

setAccessLevel

getAccessLevel

withAccessLevel

withAccessLevel

getAcceptedFileTypes

setAcceptedFileTypes

withAcceptedFileTypes

withAcceptedFileTypes

setShowThumbnails

getShowThumbnails

withShowThumbnails

isShowThumbnails

setIsResumable

getIsResumable

withIsResumable

isResumable

setMaxFileCount

getMaxFileCount

withMaxFileCount

setMaxSize

getMaxSize

withMaxSize

toString

equals

hashCode

clone

marshall