com.google.cloud.hadoop.gcsio

Class CreateFileOptions

java.lang.Object

com.google.cloud.hadoop.gcsio.CreateFileOptions

public abstract class CreateFileOptions
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateFileOptions.Builder Builder for CreateFileOptions

Field Summary

Fields

Modifier and Type	Field and Description
static CreateFileOptions	DEFAULT_NO_OVERWRITE
static CreateFileOptions	DEFAULT_OVERWRITE

Constructor Summary

Constructors

Constructor and Description
CreateFileOptions()

Method Summary

Modifier and Type	Method and Description
static CreateFileOptions.Builder	builder()
abstract com.google.common.collect.ImmutableMap<String,byte[]>	getAttributes() Extended attributes to set when creating a file.
abstract String	getContentType() Content-type to set when creating a file.
abstract long	getOverwriteGenerationId() Generation of existing object to overwrite.
abstract boolean	isEnsureNoDirectoryConflict() If true, makes sure there isn't already a directory object of the same name.
abstract boolean	isOverwriteExisting() Whether to overwrite an existing file with the same name.
abstract CreateFileOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NO_OVERWRITE

public static final CreateFileOptions DEFAULT_NO_OVERWRITE

DEFAULT_OVERWRITE

public static final CreateFileOptions DEFAULT_OVERWRITE

Constructor Detail

CreateFileOptions

public CreateFileOptions()

Method Detail

builder

public static CreateFileOptions.Builder builder()

toBuilder

public abstract CreateFileOptions.Builder toBuilder()

getAttributes

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

Extended attributes to set when creating a file.

getContentType

@Nullable
public abstract String getContentType()

Content-type to set when creating a file.

isEnsureNoDirectoryConflict

public abstract boolean isEnsureNoDirectoryConflict()

If true, makes sure there isn't already a directory object of the same name. If false, you run the risk of creating hard-to-cleanup/access files whose names collide with directory names. If already sure no such directory exists, then this is safe to set for improved performance.

isOverwriteExisting

public abstract boolean isOverwriteExisting()

Whether to overwrite an existing file with the same name.

getOverwriteGenerationId

public abstract long getOverwriteGenerationId()

Generation of existing object to overwrite. Ignored if set to StorageResourceId.UNKNOWN_GENERATION_ID, but otherwise this is used instead of overwriteExisting, where 0 indicates no existing object, and otherwise an existing object will only be overwritten by the newly created file if its generation matches this provided generationId.