com.google.cloud.hadoop.gcsio

Class CreateObjectOptions

java.lang.Object

com.google.cloud.hadoop.gcsio.CreateObjectOptions

public class CreateObjectOptions
extends Object

Options for creating objects in GCS.

Field Summary

Fields

Modifier and Type	Field and Description
static CreateObjectOptions	DEFAULT
static String	DEFAULT_CONTENT_TYPE
static Map<String,byte[]>	EMPTY_METADATA

Constructor Summary

Constructors

Constructor and Description
CreateObjectOptions(boolean overwriteExisting) Construct a new CreateObjectOptions with empty metadata and the default content-type.
CreateObjectOptions(boolean overwriteExisting, Map<String,byte[]> metadata) Construct a new CreateObjectOptions with the specified metadata, and default content-type.
CreateObjectOptions(boolean overwriteExisting, String contentType, Map<String,byte[]> metadata) Construct a new CreateObjectOptions with the spec metadata and content-type.
CreateObjectOptions(boolean overwriteExisting, String contentType, Map<String,byte[]> metadata, boolean requireMetadataMatchForEmptyObjects) Construct a new CreateObjectOptions with the spec metadata and content-type.

Method Summary

Modifier and Type	Method and Description
String	getContentType() Content type to set when creating a file.
Map<String,byte[]>	getMetadata() Custom metadata to apply to this object.
boolean	getRequireMetadataMatchForEmptyObjects() See constructor param for details.
boolean	overwriteExisting() Get the value of overwriteExisting.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_METADATA

public static final Map<String,byte[]> EMPTY_METADATA

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT

public static final CreateObjectOptions DEFAULT

Constructor Detail

CreateObjectOptions

public CreateObjectOptions(boolean overwriteExisting)

Construct a new CreateObjectOptions with empty metadata and the default content-type. Since no metadata was explicitly provided, we will set metadata-match for empty objects to false.

Parameters:

overwriteExisting - True to overwrite any existing objects with the same name.

CreateObjectOptions

public CreateObjectOptions(boolean overwriteExisting,
                           Map<String,byte[]> metadata)

Construct a new CreateObjectOptions with the specified metadata, and default content-type. Since metadata was explicitly provided, even if empty, we will set metadata-match for empty objects to true.

Parameters:

overwriteExisting - True to overwrite any existing objects with the same name.

metadata - A dictionary of metadata to apply to created objects.

CreateObjectOptions

public CreateObjectOptions(boolean overwriteExisting,
                           String contentType,
                           Map<String,byte[]> metadata)

Construct a new CreateObjectOptions with the spec metadata and content-type. Since metadata was explicitly provided, even if empty, we will set metadata-match for empty objects to true.

Parameters:

overwriteExisting - True to overwrite any existing objects with the same name

contentType - content-type for the created file

metadata - A dictionary of metadata to apply to created objects

CreateObjectOptions

public CreateObjectOptions(boolean overwriteExisting,
                           String contentType,
                           Map<String,byte[]> metadata,
                           boolean requireMetadataMatchForEmptyObjects)

Construct a new CreateObjectOptions with the spec metadata and content-type.

Parameters:

overwriteExisting - True to overwrite any existing objects with the same name

contentType - content-type for the created file

metadata - A dictionary of metadata to apply to created objects

requireMetadataMatchForEmptyObjects - if true, when creating an empty object and certain types of errors occur, any existing object is checked for an exact metadata match to the metadata in this CreateObjectOptions before accepting the creation as successful. If false, then on error for creating empty objects, as long as an appropriate empty object already exists, even if it holds different metadata than provided in this CreateObjectOptions instance, it may be considered created successfully.

Method Detail

overwriteExisting

public boolean overwriteExisting()

Get the value of overwriteExisting.

getContentType

public String getContentType()

Content type to set when creating a file.

getMetadata

public Map<String,byte[]> getMetadata()

Custom metadata to apply to this object.

getRequireMetadataMatchForEmptyObjects

public boolean getRequireMetadataMatchForEmptyObjects()

See constructor param for details.