public final class FileTransformerConfiguration extends Object implements ToCopyableBuilder<FileTransformerConfiguration.Builder,FileTransformerConfiguration>
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.Modifier and Type | Class and Description |
---|---|
static interface |
FileTransformerConfiguration.Builder |
static class |
FileTransformerConfiguration.FailureBehavior
Defines how the SDK should handle the file if there is an exception
|
static class |
FileTransformerConfiguration.FileWriteOption
Defines how the SDK should write the file
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
copy
public FileTransformerConfiguration.FileWriteOption fileWriteOption()
FileTransformerConfiguration.FileWriteOption
public FileTransformerConfiguration.FailureBehavior failureBehavior()
FileTransformerConfiguration.FailureBehavior
public static FileTransformerConfiguration.Builder builder()
FileTransformerConfiguration.Builder
, used to create a FileTransformerConfiguration
.public static FileTransformerConfiguration defaultCreateNew()
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).
public static FileTransformerConfiguration defaultCreateOrReplaceExisting()
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
public static FileTransformerConfiguration defaultCreateOrAppend()
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
public FileTransformerConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<FileTransformerConfiguration.Builder,FileTransformerConfiguration>
Copyright © 2023. All rights reserved.