com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageOptions

java.lang.Object

com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

public abstract class GoogleCloudStorageOptions
extends Object

Configuration options for the GoogleCloudStorage class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleCloudStorageOptions.Builder Mutable builder for the GoogleCloudStorageOptions class.
static class	GoogleCloudStorageOptions.MetricsSink

Field Summary

Fields

Modifier and Type	Field and Description
static Class<? extends AuthorizationHandler>	AUTHORIZATION_HANDLER_IMPL_CLASS_DEFAULT Default setting for authorization handler.
static Map<String,String>	AUTHORIZATION_HANDLER_PROPERTIES_DEFAULT Default properties for authorization handler.
static boolean	AUTO_REPAIR_IMPLICIT_DIRECTORIES_DEFAULT Default setting for enabling auto-repair of implicit directories.
static int	BATCH_THREADS_DEFAULT Default setting for number of threads to execute GCS batch requests.
static boolean	COPY_WITH_REWRITE_DEFAULT Default setting for whether or not to use rewrite request for copy operation.
static GoogleCloudStorageOptions	DEFAULT
static boolean	DIRECT_PATH_PREFERRED_DEFAULT Default setting to prefer DirectPath for gRPC.
static boolean	ENABLE_GRPC_DEFAULT Default setting for enabling use of GCS gRPC API.
static boolean	ENABLE_TRAFFIC_DIRECTOR_DEFAULT Default setting for enabling use of the Traffic Director for GCS gRPC API.
static long	GRPC_MESSAGE_TIMEOUT_CHECK_INTERVAL Default setting for grpc message timeout check interval (in milliseconds)
static boolean	GRPC_WRITE_DEFAULT
static int	HTTP_REQUEST_CONNECT_TIMEOUT Default setting for connect timeout (in millisecond) of GCS HTTP request.
static com.google.common.collect.ImmutableMap<String,String>	HTTP_REQUEST_HEADERS_DEFAULT Default setting for GCS HTTP request headers.
static int	HTTP_REQUEST_READ_TIMEOUT Default setting for read timeout (in millisecond) of GCS HTTP request.
static int	MAX_BYTES_REWRITTEN_PER_CALL_DEFAULT Default setting for max number of bytes rewritten per rewrite request/call.
static int	MAX_HTTP_REQUEST_RETRIES Default setting for maximum number of GCS HTTP request retires.
static long	MAX_LIST_ITEMS_PER_CALL_DEFAULT Default number of items to return per call to the list* GCS RPCs.
static long	MAX_REQUESTS_PER_BATCH_DEFAULT Default setting for maximum number of requests per GCS batch.
static int	MAX_WAIT_MILLIS_FOR_EMPTY_OBJECT_CREATION Default setting for the length of time to wait for empty objects to appear if we believe we are in a race with multiple workers.
static String	STORAGE_ROOT_URL_DEFAULT Default root URL for Cloud Storage API endpoint.
static String	STORAGE_SERVICE_PATH_DEFAULT Default service Path for Cloud Storage API endpoint.

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageOptions()

Method Summary

Modifier and Type	Method and Description
static GoogleCloudStorageOptions.Builder	builder()
abstract String	getAppName()
abstract Class<? extends AuthorizationHandler>	getAuthorizationHandlerImplClass()
abstract Map<String,String>	getAuthorizationHandlerProperties()
abstract int	getBatchThreads()
abstract CooperativeLockingOptions	getCooperativeLockingOptions()
abstract String	getEncryptionAlgorithm()
abstract RedactedString	getEncryptionKey()
abstract RedactedString	getEncryptionKeyHash()
abstract long	getGrpcMessageTimeoutCheckInterval()
abstract int	getHttpRequestConnectTimeout()
abstract com.google.common.collect.ImmutableMap<String,String>	getHttpRequestHeaders()
abstract int	getHttpRequestReadTimeout()
abstract long	getMaxBytesRewrittenPerCall()
abstract int	getMaxHttpRequestRetries()
abstract long	getMaxListItemsPerCall()
abstract long	getMaxRequestsPerBatch()
abstract int	getMaxWaitMillisForEmptyObjectCreation()
abstract GoogleCloudStorageOptions.MetricsSink	getMetricsSink()
abstract String	getProjectId()
abstract String	getProxyAddress()
abstract RedactedString	getProxyPassword()
abstract RedactedString	getProxyUsername()
abstract GoogleCloudStorageReadOptions	getReadChannelOptions()
abstract RequesterPaysOptions	getRequesterPaysOptions()
abstract String	getStorageRootUrl()
abstract String	getStorageServicePath()
abstract com.google.common.collect.ImmutableSet<String>	getTraceLogExcludeProperties()
abstract long	getTraceLogTimeThreshold()
abstract HttpTransportFactory.HttpTransportType	getTransportType()
abstract AsyncWriteChannelOptions	getWriteChannelOptions()
abstract boolean	isAutoRepairImplicitDirectoriesEnabled()
abstract boolean	isCopyWithRewriteEnabled()
abstract boolean	isDirectPathPreferred()
abstract boolean	isGrpcEnabled()
abstract boolean	isGrpcWriteEnabled()
abstract boolean	isHnBucketRenameEnabled()
abstract boolean	isOperationTraceLogEnabled()
abstract boolean	isTraceLogEnabled()
abstract boolean	isTrafficDirectorEnabled()
void	throwIfNotValid()
abstract GoogleCloudStorageOptions.Builder	toBuilder()
RetryHttpInitializerOptions	toRetryHttpInitializerOptions()

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_GRPC_DEFAULT

public static final boolean ENABLE_GRPC_DEFAULT

Default setting for enabling use of GCS gRPC API.

See Also:

Constant Field Values

ENABLE_TRAFFIC_DIRECTOR_DEFAULT

public static final boolean ENABLE_TRAFFIC_DIRECTOR_DEFAULT

Default setting for enabling use of the Traffic Director for GCS gRPC API.

See Also:

Constant Field Values

DIRECT_PATH_PREFERRED_DEFAULT

public static final boolean DIRECT_PATH_PREFERRED_DEFAULT

Default setting to prefer DirectPath for gRPC.

See Also:

Constant Field Values

STORAGE_ROOT_URL_DEFAULT

public static final String STORAGE_ROOT_URL_DEFAULT

Default root URL for Cloud Storage API endpoint.

See Also:

Constant Field Values

STORAGE_SERVICE_PATH_DEFAULT

public static final String STORAGE_SERVICE_PATH_DEFAULT

Default service Path for Cloud Storage API endpoint.

See Also:

Constant Field Values

AUTO_REPAIR_IMPLICIT_DIRECTORIES_DEFAULT

public static final boolean AUTO_REPAIR_IMPLICIT_DIRECTORIES_DEFAULT

Default setting for enabling auto-repair of implicit directories.

See Also:

Constant Field Values

MAX_WAIT_MILLIS_FOR_EMPTY_OBJECT_CREATION

public static final int MAX_WAIT_MILLIS_FOR_EMPTY_OBJECT_CREATION

Default setting for the length of time to wait for empty objects to appear if we believe we are in a race with multiple workers.

See Also:

Constant Field Values

MAX_LIST_ITEMS_PER_CALL_DEFAULT

public static final long MAX_LIST_ITEMS_PER_CALL_DEFAULT

Default number of items to return per call to the list* GCS RPCs.

See Also:

Constant Field Values

MAX_REQUESTS_PER_BATCH_DEFAULT

public static final long MAX_REQUESTS_PER_BATCH_DEFAULT

Default setting for maximum number of requests per GCS batch.

See Also:

Constant Field Values

BATCH_THREADS_DEFAULT

public static final int BATCH_THREADS_DEFAULT

Default setting for number of threads to execute GCS batch requests.

See Also:

Constant Field Values

MAX_HTTP_REQUEST_RETRIES

public static final int MAX_HTTP_REQUEST_RETRIES

Default setting for maximum number of GCS HTTP request retires.

See Also:

Constant Field Values

HTTP_REQUEST_CONNECT_TIMEOUT

public static final int HTTP_REQUEST_CONNECT_TIMEOUT

Default setting for connect timeout (in millisecond) of GCS HTTP request.

See Also:

Constant Field Values

HTTP_REQUEST_READ_TIMEOUT

public static final int HTTP_REQUEST_READ_TIMEOUT

Default setting for read timeout (in millisecond) of GCS HTTP request.

See Also:

Constant Field Values

COPY_WITH_REWRITE_DEFAULT

public static final boolean COPY_WITH_REWRITE_DEFAULT

Default setting for whether or not to use rewrite request for copy operation.

See Also:

Constant Field Values

GRPC_WRITE_DEFAULT

public static final boolean GRPC_WRITE_DEFAULT

See Also:

Constant Field Values

MAX_BYTES_REWRITTEN_PER_CALL_DEFAULT

public static final int MAX_BYTES_REWRITTEN_PER_CALL_DEFAULT

Default setting for max number of bytes rewritten per rewrite request/call.

See Also:

Constant Field Values

GRPC_MESSAGE_TIMEOUT_CHECK_INTERVAL

public static final long GRPC_MESSAGE_TIMEOUT_CHECK_INTERVAL

Default setting for grpc message timeout check interval (in milliseconds)

See Also:

Constant Field Values

HTTP_REQUEST_HEADERS_DEFAULT

public static final com.google.common.collect.ImmutableMap<String,String> HTTP_REQUEST_HEADERS_DEFAULT

Default setting for GCS HTTP request headers.

AUTHORIZATION_HANDLER_IMPL_CLASS_DEFAULT

public static final Class<? extends AuthorizationHandler> AUTHORIZATION_HANDLER_IMPL_CLASS_DEFAULT

Default setting for authorization handler.

AUTHORIZATION_HANDLER_PROPERTIES_DEFAULT

public static final Map<String,String> AUTHORIZATION_HANDLER_PROPERTIES_DEFAULT

Default properties for authorization handler.

DEFAULT

public static final GoogleCloudStorageOptions DEFAULT

Constructor Detail

GoogleCloudStorageOptions

public GoogleCloudStorageOptions()

Method Detail

builder

public static GoogleCloudStorageOptions.Builder builder()

toBuilder

public abstract GoogleCloudStorageOptions.Builder toBuilder()

isGrpcEnabled

public abstract boolean isGrpcEnabled()

isHnBucketRenameEnabled

public abstract boolean isHnBucketRenameEnabled()

isTrafficDirectorEnabled

public abstract boolean isTrafficDirectorEnabled()

isDirectPathPreferred

public abstract boolean isDirectPathPreferred()

getStorageRootUrl

public abstract String getStorageRootUrl()

getStorageServicePath

public abstract String getStorageServicePath()

isGrpcWriteEnabled

public abstract boolean isGrpcWriteEnabled()

getProjectId

@Nullable
public abstract String getProjectId()

getAppName

@Nullable
public abstract String getAppName()

isAutoRepairImplicitDirectoriesEnabled

public abstract boolean isAutoRepairImplicitDirectoriesEnabled()

getMaxWaitMillisForEmptyObjectCreation

public abstract int getMaxWaitMillisForEmptyObjectCreation()

getMaxListItemsPerCall

public abstract long getMaxListItemsPerCall()

getMaxRequestsPerBatch

public abstract long getMaxRequestsPerBatch()

getBatchThreads

public abstract int getBatchThreads()

getMaxHttpRequestRetries

public abstract int getMaxHttpRequestRetries()

getHttpRequestConnectTimeout

public abstract int getHttpRequestConnectTimeout()

getHttpRequestReadTimeout

public abstract int getHttpRequestReadTimeout()

getTransportType

public abstract HttpTransportFactory.HttpTransportType getTransportType()

getProxyAddress

@Nullable
public abstract String getProxyAddress()

getProxyUsername

@Nullable
public abstract RedactedString getProxyUsername()

getProxyPassword

@Nullable
public abstract RedactedString getProxyPassword()

isCopyWithRewriteEnabled

public abstract boolean isCopyWithRewriteEnabled()

getMaxBytesRewrittenPerCall

public abstract long getMaxBytesRewrittenPerCall()

getReadChannelOptions

public abstract GoogleCloudStorageReadOptions getReadChannelOptions()

getWriteChannelOptions

public abstract AsyncWriteChannelOptions getWriteChannelOptions()

getRequesterPaysOptions

public abstract RequesterPaysOptions getRequesterPaysOptions()

getCooperativeLockingOptions

public abstract CooperativeLockingOptions getCooperativeLockingOptions()

getHttpRequestHeaders

public abstract com.google.common.collect.ImmutableMap<String,String> getHttpRequestHeaders()

getEncryptionAlgorithm

@Nullable
public abstract String getEncryptionAlgorithm()

getEncryptionKey

@Nullable
public abstract RedactedString getEncryptionKey()

getEncryptionKeyHash

@Nullable
public abstract RedactedString getEncryptionKeyHash()

getGrpcMessageTimeoutCheckInterval

public abstract long getGrpcMessageTimeoutCheckInterval()

getMetricsSink

public abstract GoogleCloudStorageOptions.MetricsSink getMetricsSink()

isTraceLogEnabled

public abstract boolean isTraceLogEnabled()

isOperationTraceLogEnabled

public abstract boolean isOperationTraceLogEnabled()

getTraceLogTimeThreshold

public abstract long getTraceLogTimeThreshold()

getTraceLogExcludeProperties

public abstract com.google.common.collect.ImmutableSet<String> getTraceLogExcludeProperties()

toRetryHttpInitializerOptions

public RetryHttpInitializerOptions toRetryHttpInitializerOptions()

getAuthorizationHandlerImplClass

@Nullable
public abstract Class<? extends AuthorizationHandler> getAuthorizationHandlerImplClass()

getAuthorizationHandlerProperties

public abstract Map<String,String> getAuthorizationHandlerProperties()

throwIfNotValid

public void throwIfNotValid()