GoogleCloudStorageOptions (gcsio 1.9.17 API)

java.lang.Object
- com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

public abstract class GoogleCloudStorageOptions
extends java.lang.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.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoogleCloudStorageOptions.Builder` Mutable builder for the `GoogleCloudStorageOptions` class.

Field Summary

Fields
Modifier and Type	Field and Description
`static AsyncWriteChannelOptions`	`ASYNC_WRITE_CHANNEL_OPTIONS_DEFAULT` Default setting for async write channel.
`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 int`	`COPY_BATCH_THREADS_DEFAULT` Default setting for number of threads to execute GCS batch requests for copy operations.
`static long`	`COPY_MAX_REQUESTS_PER_BATCH_DEFAULT` Default setting for maximum number of requests per GCS batch for copy operations.
`static boolean`	`COPY_WITH_REWRITE_DEFAULT` Default setting for whether or not to use rewrite request for copy operation.
`static boolean`	`CREATE_EMPTY_MARKER_OBJECT_DEFAULT` Default setting for whether or not to create a marker file when beginning file creation.
`static int`	`HTTP_REQUEST_CONNECT_TIMEOUT` Default setting for connect timeout (in millisecond) of GCS HTTP request.
`static int`	`HTTP_REQUEST_READ_TIMEOUT` Default setting for read timeout (in millisecond) of GCS HTTP request.
`static boolean`	`INFER_IMPLICIT_DIRECTORIES_DEFAULT` Default setting for enabling inferring of implicit directories.
`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 GoogleCloudStorageReadOptions`	`READ_CHANNEL_OPTIONS_DEFAULT` Default setting for read write channel.
`static RequesterPaysOptions`	`REQUESTER_PAYS_OPTIONS_DEFAULT` Default setting for requester pays feature.

Constructor Summary

Constructors
Constructor and Description

GoogleCloudStorageOptions()

Constructors
Constructor and Description
`GoogleCloudStorageOptions()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`getAppName()`
`abstract int`	`getBatchThreads()`
`abstract int`	`getCopyBatchThreads()`
`abstract long`	`getCopyMaxRequestsPerBatch()`
`abstract int`	`getHttpRequestConnectTimeout()`
`abstract int`	`getHttpRequestReadTimeout()`
`abstract long`	`getMaxBytesRewrittenPerCall()`
`abstract int`	`getMaxHttpRequestRetries()`
`abstract long`	`getMaxListItemsPerCall()`
`abstract long`	`getMaxRequestsPerBatch()`
`abstract int`	`getMaxWaitMillisForEmptyObjectCreation()`
`abstract java.lang.String`	`getProjectId()`
`abstract java.lang.String`	`getProxyAddress()`
`abstract java.lang.String`	`getProxyPassword()`
`abstract java.lang.String`	`getProxyUsername()`
`abstract GoogleCloudStorageReadOptions`	`getReadChannelOptions()`
`abstract RequesterPaysOptions`	`getRequesterPaysOptions()`
`abstract HttpTransportFactory.HttpTransportType`	`getTransportType()`
`abstract AsyncWriteChannelOptions`	`getWriteChannelOptions()`
`abstract boolean`	`isAutoRepairImplicitDirectoriesEnabled()`
`abstract boolean`	`isCopyWithRewriteEnabled()`
`abstract boolean`	`isInferImplicitDirectoriesEnabled()`
`abstract boolean`	`isMarkerFileCreationEnabled()`
`static GoogleCloudStorageOptions.Builder`	`newBuilder()`
`void`	`throwIfNotValid()`
`abstract GoogleCloudStorageOptions.Builder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
  - INFER_IMPLICIT_DIRECTORIES_DEFAULT
```
public static final boolean INFER_IMPLICIT_DIRECTORIES_DEFAULT
```
    Default setting for enabling inferring of implicit directories.
    
    See Also:
    
    Constant Field Values
  - CREATE_EMPTY_MARKER_OBJECT_DEFAULT
```
public static final boolean CREATE_EMPTY_MARKER_OBJECT_DEFAULT
```
    Default setting for whether or not to create a marker file when beginning file creation.
    
    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
  - 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
  - COPY_MAX_REQUESTS_PER_BATCH_DEFAULT
```
public static final long COPY_MAX_REQUESTS_PER_BATCH_DEFAULT
```
    Default setting for maximum number of requests per GCS batch for copy operations.
    
    See Also:
    
    Constant Field Values
  - COPY_BATCH_THREADS_DEFAULT
```
public static final int COPY_BATCH_THREADS_DEFAULT
```
    Default setting for number of threads to execute GCS batch requests for copy operations.
    
    See Also:
    
    Constant Field Values
  - READ_CHANNEL_OPTIONS_DEFAULT
```
public static final GoogleCloudStorageReadOptions READ_CHANNEL_OPTIONS_DEFAULT
```
    Default setting for read write channel.
  - ASYNC_WRITE_CHANNEL_OPTIONS_DEFAULT
```
public static final AsyncWriteChannelOptions ASYNC_WRITE_CHANNEL_OPTIONS_DEFAULT
```
    Default setting for async write channel.
  - REQUESTER_PAYS_OPTIONS_DEFAULT
```
public static final RequesterPaysOptions REQUESTER_PAYS_OPTIONS_DEFAULT
```
    Default setting for requester pays feature.
- Constructor Detail
  - GoogleCloudStorageOptions
```
public GoogleCloudStorageOptions()
```
- Method Detail
  - newBuilder
```
public static GoogleCloudStorageOptions.Builder newBuilder()
```
  - getProjectId
```
@Nullable
public abstract java.lang.String getProjectId()
```
  - getAppName
```
@Nullable
public abstract java.lang.String getAppName()
```
  - isAutoRepairImplicitDirectoriesEnabled
```
public abstract boolean isAutoRepairImplicitDirectoriesEnabled()
```
  - isInferImplicitDirectoriesEnabled
```
public abstract boolean isInferImplicitDirectoriesEnabled()
```
  - isMarkerFileCreationEnabled
```
public abstract boolean isMarkerFileCreationEnabled()
```
  - getMaxWaitMillisForEmptyObjectCreation
```
public abstract int getMaxWaitMillisForEmptyObjectCreation()
```
  - getMaxListItemsPerCall
```
public abstract long getMaxListItemsPerCall()
```
  - getMaxRequestsPerBatch
```
public abstract long getMaxRequestsPerBatch()
```
  - getBatchThreads
```
public abstract int getBatchThreads()
```
  - getCopyMaxRequestsPerBatch
```
public abstract long getCopyMaxRequestsPerBatch()
```
  - getCopyBatchThreads
```
public abstract int getCopyBatchThreads()
```
  - 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 java.lang.String getProxyAddress()
```
  - getProxyUsername
```
@Nullable
public abstract java.lang.String getProxyUsername()
```
  - getProxyPassword
```
@Nullable
public abstract java.lang.String 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()
```
  - toBuilder
```
public abstract GoogleCloudStorageOptions.Builder toBuilder()
```
  - throwIfNotValid
```
public void throwIfNotValid()
```

Class GoogleCloudStorageOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTO_REPAIR_IMPLICIT_DIRECTORIES_DEFAULT

INFER_IMPLICIT_DIRECTORIES_DEFAULT

CREATE_EMPTY_MARKER_OBJECT_DEFAULT

MAX_WAIT_MILLIS_FOR_EMPTY_OBJECT_CREATION

MAX_LIST_ITEMS_PER_CALL_DEFAULT

MAX_REQUESTS_PER_BATCH_DEFAULT

BATCH_THREADS_DEFAULT

MAX_HTTP_REQUEST_RETRIES

HTTP_REQUEST_CONNECT_TIMEOUT

HTTP_REQUEST_READ_TIMEOUT

COPY_WITH_REWRITE_DEFAULT

MAX_BYTES_REWRITTEN_PER_CALL_DEFAULT

COPY_MAX_REQUESTS_PER_BATCH_DEFAULT

COPY_BATCH_THREADS_DEFAULT

READ_CHANNEL_OPTIONS_DEFAULT

ASYNC_WRITE_CHANNEL_OPTIONS_DEFAULT

REQUESTER_PAYS_OPTIONS_DEFAULT

Constructor Detail

GoogleCloudStorageOptions

Method Detail

newBuilder

getProjectId

getAppName

isAutoRepairImplicitDirectoriesEnabled

isInferImplicitDirectoriesEnabled

isMarkerFileCreationEnabled

getMaxWaitMillisForEmptyObjectCreation

getMaxListItemsPerCall

getMaxRequestsPerBatch

getBatchThreads

getCopyMaxRequestsPerBatch

getCopyBatchThreads

getMaxHttpRequestRetries

getHttpRequestConnectTimeout

getHttpRequestReadTimeout

getTransportType

getProxyAddress

getProxyUsername

getProxyPassword

isCopyWithRewriteEnabled

getMaxBytesRewrittenPerCall

getReadChannelOptions

getWriteChannelOptions

getRequesterPaysOptions

toBuilder

throwIfNotValid