com.google.cloud.hadoop.gcsio

Class CreateObjectOptions

java.lang.Object

com.google.cloud.hadoop.gcsio.CreateObjectOptions

public abstract class CreateObjectOptions
extends Object

Options that can be specified when creating a file in the GoogleCloudStorage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateObjectOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE_DEFAULT
static CreateObjectOptions	DEFAULT_NO_OVERWRITE
static CreateObjectOptions	DEFAULT_OVERWRITE

Constructor Summary

Constructors

Constructor and Description
CreateObjectOptions()

Method Summary

Modifier and Type	Method and Description
static CreateObjectOptions.Builder	builder()
abstract String	getContentEncoding() Content encoding for the created object.
abstract String	getContentType() Content type for the created object.
abstract String	getKmsKeyName() A KMS key name to encrypt the created object.
abstract com.google.common.collect.ImmutableMap<String,byte[]>	getMetadata() A metadata to apply to the create object.
abstract boolean	isEnsureEmptyObjectsMetadataMatch() 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.
abstract boolean	isOverwriteExisting() Whether to overwrite any existing objects with the same name
abstract CreateObjectOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE_DEFAULT

public static final String CONTENT_TYPE_DEFAULT

See Also:

Constant Field Values

DEFAULT_NO_OVERWRITE

public static final CreateObjectOptions DEFAULT_NO_OVERWRITE

DEFAULT_OVERWRITE

public static final CreateObjectOptions DEFAULT_OVERWRITE

Constructor Detail

CreateObjectOptions

public CreateObjectOptions()

Method Detail

builder

public static CreateObjectOptions.Builder builder()

toBuilder

public abstract CreateObjectOptions.Builder toBuilder()

getContentEncoding

@Nullable
public abstract String getContentEncoding()

Content encoding for the created object.

getContentType

@Nullable
public abstract String getContentType()

Content type for the created object.

isEnsureEmptyObjectsMetadataMatch

public abstract boolean isEnsureEmptyObjectsMetadataMatch()

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.

getKmsKeyName

@Nullable
public abstract String getKmsKeyName()

A KMS key name to encrypt the created object.

getMetadata

public abstract com.google.common.collect.ImmutableMap<String,byte[]> getMetadata()

A metadata to apply to the create object.

isOverwriteExisting

public abstract boolean isOverwriteExisting()

Whether to overwrite any existing objects with the same name