org.apache.hadoop.fs.s3a.impl

Class PutObjectOptions

java.lang.Object

org.apache.hadoop.fs.s3a.impl.PutObjectOptions

public final class PutObjectOptions
extends Object

Extensible structure for options when putting/writing objects.

Constructor Summary

Constructors

Constructor and Description
PutObjectOptions(boolean keepMarkers, String storageClass, Map<String,String> headers, EnumSet<WriteObjectFlags> writeObjectFlags, String etagOverwrite) Constructor.

Method Summary

Modifier and Type	Method and Description
static PutObjectOptions	defaultOptions() Get the default options.
static PutObjectOptions	deletingDirs() Get the options to delete directory markers.
String	getEtagOverwrite() Get the ETag that must match for an overwrite operation to proceed.
Map<String,String>	getHeaders() Headers for the put/post request.
EnumSet<WriteObjectFlags>	getWriteObjectFlags()
boolean	hasFlag(WriteObjectFlags flag) Does the flag set contain the specific flag.
boolean	isEtagOverwrite() Get the isEtagOverwrite flag.
boolean	isKeepMarkers() Get the marker retention flag.
boolean	isNoObjectOverwrite() Get the noObjectOverwrite flag.
static PutObjectOptions	keepingDirs() Get the options to keep directories.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PutObjectOptions

public PutObjectOptions(boolean keepMarkers,
                        @Nullable
                        String storageClass,
                        @Nullable
                        Map<String,String> headers,
                        EnumSet<WriteObjectFlags> writeObjectFlags,
                        @Nullable
                        String etagOverwrite)

Constructor.

Parameters:

keepMarkers - Can the PUT operation skip marker deletion?

storageClass - Storage class, if not null.

headers - Headers; may be null.

writeObjectFlags - flags for writing

etagOverwrite - etag for etag writes. MUST not be empty if etag overwrite flag is set.

Method Detail

isNoObjectOverwrite

public boolean isNoObjectOverwrite()

Get the noObjectOverwrite flag.

Returns:

true if object override not allowed.

isEtagOverwrite

public boolean isEtagOverwrite()

Get the isEtagOverwrite flag.

Returns:

true if the write MUST overwrite an object with the supplied etag.

hasFlag

public boolean hasFlag(WriteObjectFlags flag)

Does the flag set contain the specific flag.

Parameters:

flag - flag to look for

Returns:

true if the flag is set.

getEtagOverwrite

public String getEtagOverwrite()

Get the ETag that must match for an overwrite operation to proceed.

Returns:

The ETag required for overwrite, or null if no ETag match is required.

isKeepMarkers

public boolean isKeepMarkers()

Get the marker retention flag.

Returns:

true if markers are to be retained.

getHeaders

public Map<String,String> getHeaders()

Headers for the put/post request.

Returns:

headers or null.

getWriteObjectFlags

public EnumSet<WriteObjectFlags> getWriteObjectFlags()

toString

public String toString()

Overrides:

toString in class Object

keepingDirs

public static PutObjectOptions keepingDirs()

Get the options to keep directories.

Returns:

an instance which keeps dirs

deletingDirs

public static PutObjectOptions deletingDirs()

Get the options to delete directory markers.

Returns:

an instance which deletes dirs

defaultOptions

public static PutObjectOptions defaultOptions()

Get the default options.

Returns:

an instance with no storage class or headers.