Class FileTransformerConfiguration

java.lang.Object

software.amazon.awssdk.core.FileTransformerConfiguration

All Implemented Interfaces:

ToCopyableBuilder<FileTransformerConfiguration.Builder,FileTransformerConfiguration>

public final class FileTransformerConfiguration
extends Object
implements ToCopyableBuilder<FileTransformerConfiguration.Builder,FileTransformerConfiguration>

Configuration options for AsyncResponseTransformer.toFile(Path, FileTransformerConfiguration) to configure how the SDK should write the file and if the SDK should delete the file when an exception occurs.

See Also:

• builder()
• FileTransformerConfiguration.FileWriteOption
• FileTransformerConfiguration.FailureBehavior

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileTransformerConfiguration.Builder
static enum	FileTransformerConfiguration.FailureBehavior	Defines how the SDK should handle the file if there is an exception
static enum	FileTransformerConfiguration.FileWriteOption	Defines how the SDK should write the file

Method Summary

Modifier and Type	Method	Description
static FileTransformerConfiguration.Builder	builder()	Create a FileTransformerConfiguration.Builder, used to create a FileTransformerConfiguration.
static FileTransformerConfiguration	defaultCreateNew()	Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_NEW
static FileTransformerConfiguration	defaultCreateOrAppend()	Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_OR_APPEND_TO_EXISTING
static FileTransformerConfiguration	defaultCreateOrReplaceExisting()	Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_OR_REPLACE_EXISTING
boolean	equals(Object o)
Optional<ExecutorService>	executorService()	The configured ExecutorService the writes should be executed on.
FileTransformerConfiguration.FailureBehavior	failureBehavior()	The configured FileTransformerConfiguration.FailureBehavior
FileTransformerConfiguration.FileWriteOption	fileWriteOption()	The configured FileTransformerConfiguration.FileWriteOption
int	hashCode()
Long	position()	Exclusively used with FileTransformerConfiguration.FileWriteOption.WRITE_TO_POSITION.
FileTransformerConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

fileWriteOption

public FileTransformerConfiguration.FileWriteOption fileWriteOption()

The configured FileTransformerConfiguration.FileWriteOption

failureBehavior

public FileTransformerConfiguration.FailureBehavior failureBehavior()

The configured FileTransformerConfiguration.FailureBehavior

executorService

public Optional<ExecutorService> executorService()

The configured ExecutorService the writes should be executed on.

If not set, the default thread pool defined by the underlying FileSystemProvider will be used. This will typically be the thread pool defined by the AsynchronousChannelGroup.

position

public Long position()

Exclusively used with FileTransformerConfiguration.FileWriteOption.WRITE_TO_POSITION. Configures the position, where to start writing to the existing file. The location correspond to the first byte where new data will be written. For example, if 128 is configured, bytes 0-127 of the existing file will remain untouched and data will be written starting at byte 128. If not specified, defaults to 0.

Returns:

The offset at which to start overwriting data in the file.

builder

public static FileTransformerConfiguration.Builder builder()

Create a FileTransformerConfiguration.Builder, used to create a FileTransformerConfiguration.

defaultCreateNew

public static FileTransformerConfiguration defaultCreateNew()

Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_NEW

Always create a new file. If the file already exists, FileAlreadyExistsException will be thrown. In the event of an error, the SDK will attempt to delete the file (whatever has been written to it so far).

defaultCreateOrReplaceExisting

public static FileTransformerConfiguration defaultCreateOrReplaceExisting()

Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_OR_REPLACE_EXISTING

Create a new file if it doesn't exist, otherwise replace the existing file. In the event of an error, the SDK will NOT attempt to delete the file, leaving it as-is

defaultCreateOrAppend

public static FileTransformerConfiguration defaultCreateOrAppend()

Returns the default FileTransformerConfiguration for FileTransformerConfiguration.FileWriteOption.CREATE_OR_APPEND_TO_EXISTING

Create a new file if it doesn't exist, otherwise append to the existing file. In the event of an error, the SDK will NOT attempt to delete the file, leaving it as-is

toBuilder

public FileTransformerConfiguration.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<FileTransformerConfiguration.Builder,FileTransformerConfiguration>

Returns:

a builder for type T

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object