com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageReadOptions.Builder

java.lang.Object

com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadOptions.Builder

Enclosing class:

GoogleCloudStorageReadOptions

public abstract static class GoogleCloudStorageReadOptions.Builder
extends java.lang.Object

Mutable builder for GoogleCloudStorageReadOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GoogleCloudStorageReadOptions	build()
abstract GoogleCloudStorageReadOptions.Builder	setBackoffInitialIntervalMillis(int backoffInitialIntervalMillis) On exponential back-off, the initial delay before the first retry; subsequent retries then grow as an exponential function of the current delay interval.
abstract GoogleCloudStorageReadOptions.Builder	setBackoffMaxElapsedTimeMillis(int backoffMaxElapsedTimeMillis) The maximum total time elapsed since the first retry over the course of a series of retries.
abstract GoogleCloudStorageReadOptions.Builder	setBackoffMaxIntervalMillis(int backoffMaxIntervalMillis) The maximum amount of sleep between retries; at this point, there will be no further exponential back-off.
abstract GoogleCloudStorageReadOptions.Builder	setBackoffMultiplier(double backoffMultiplier) The base of the exponent used for exponential back-off; each subsequent sleep interval is roughly this many times the previous interval.
abstract GoogleCloudStorageReadOptions.Builder	setBackoffRandomizationFactor(double backoffRandomizationFactor) The amount of jitter introduced when computing the next retry sleep interval so that when many clients are retrying, they don't all retry at the same time.
abstract GoogleCloudStorageReadOptions.Builder	setBufferSize(int bufferSize) If set to a positive value, low-level streams will be wrapped inside a BufferedInputStream of this size.
abstract GoogleCloudStorageReadOptions.Builder	setFadvise(GoogleCloudStorageReadOptions.Fadvise fadvise) Sets fadvise mode that tunes behavior to optimize HTTP GET requests for various use cases.
abstract GoogleCloudStorageReadOptions.Builder	setFastFailOnNotFound(boolean fastFailOnNotFound) True if attempts to open a new channel on a nonexistent object are required to immediately throw an IOException.
abstract GoogleCloudStorageReadOptions.Builder	setGenerationReadConsistency(GoogleCloudStorageReadOptions.GenerationReadConsistency consistency) Sets the generation read consistency model.
abstract GoogleCloudStorageReadOptions.Builder	setInplaceSeekLimit(long inplaceSeekLimit) If seeking to a new position which is within this number of bytes in front of the current position, then we will skip forward by reading and discarding the necessary amount of bytes rather than trying to open a brand-new underlying stream.
abstract GoogleCloudStorageReadOptions.Builder	setMinRangeRequestSize(int size) Sets the minimum size of the HTTP Range header that could be set in GCS request when opening new stream to read an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setBackoffInitialIntervalMillis

public abstract GoogleCloudStorageReadOptions.Builder setBackoffInitialIntervalMillis(int backoffInitialIntervalMillis)

On exponential back-off, the initial delay before the first retry; subsequent retries then grow as an exponential function of the current delay interval.

setBackoffRandomizationFactor

public abstract GoogleCloudStorageReadOptions.Builder setBackoffRandomizationFactor(double backoffRandomizationFactor)

The amount of jitter introduced when computing the next retry sleep interval so that when many clients are retrying, they don't all retry at the same time.

setBackoffMultiplier

public abstract GoogleCloudStorageReadOptions.Builder setBackoffMultiplier(double backoffMultiplier)

The base of the exponent used for exponential back-off; each subsequent sleep interval is roughly this many times the previous interval.

setBackoffMaxIntervalMillis

public abstract GoogleCloudStorageReadOptions.Builder setBackoffMaxIntervalMillis(int backoffMaxIntervalMillis)

The maximum amount of sleep between retries; at this point, there will be no further exponential back-off. This prevents intervals from growing unreasonably large.

setBackoffMaxElapsedTimeMillis

public abstract GoogleCloudStorageReadOptions.Builder setBackoffMaxElapsedTimeMillis(int backoffMaxElapsedTimeMillis)

The maximum total time elapsed since the first retry over the course of a series of retries. This makes it easier to bound the maximum time it takes to respond to a permanent failure without having to calculate the summation of a series of exponentiated intervals while accounting for the randomization of back-off intervals.

setFastFailOnNotFound

public abstract GoogleCloudStorageReadOptions.Builder setFastFailOnNotFound(boolean fastFailOnNotFound)

True if attempts to open a new channel on a nonexistent object are required to immediately throw an IOException. If false, then channels may not throw exceptions for such cases until attempting to call read(). Performance can be improved if this is set to false and the caller is equipped to deal with delayed failures for not-found objects. Or if the caller is already sure the object being opened exists, it is recommended to set this to false to avoid doing extraneous checks on open().

setBufferSize

public abstract GoogleCloudStorageReadOptions.Builder setBufferSize(int bufferSize)

If set to a positive value, low-level streams will be wrapped inside a BufferedInputStream of this size. Otherwise no buffer will be created to wrap the low-level streams. Note that the low-level streams may or may not have their own additional buffering layers independent of this setting.

setInplaceSeekLimit

public abstract GoogleCloudStorageReadOptions.Builder setInplaceSeekLimit(long inplaceSeekLimit)

If seeking to a new position which is within this number of bytes in front of the current position, then we will skip forward by reading and discarding the necessary amount of bytes rather than trying to open a brand-new underlying stream.

setFadvise

public abstract GoogleCloudStorageReadOptions.Builder setFadvise(GoogleCloudStorageReadOptions.Fadvise fadvise)

Sets fadvise mode that tunes behavior to optimize HTTP GET requests for various use cases.

Supported modes:

• AUTO - automatically switches to RANDOM mode if backward read or forward read for more than setInplaceSeekLimit(long) bytes is detected.
• RANDOM - sends HTTP requests with Range header set to greater of provided reade buffer by user or setBufferSize(int).
• SEQUENTIAL - sends HTTP requests with unbounded Range header.

setMinRangeRequestSize

public abstract GoogleCloudStorageReadOptions.Builder setMinRangeRequestSize(int size)

Sets the minimum size of the HTTP Range header that could be set in GCS request when opening new stream to read an object.

setGenerationReadConsistency

public abstract GoogleCloudStorageReadOptions.Builder setGenerationReadConsistency(GoogleCloudStorageReadOptions.GenerationReadConsistency consistency)

Sets the generation read consistency model.

Supported modes:

• LATEST: always read the latest generation.
• BEST_EFFORT: will try to read a certain generation (when the read-channel was opened), but when that generation is deleted/overwritten, fall back to the latest generation.
• STRICT: will try to read a certain generation (when the read-channel was opened), but when that generation is deleted/overwritten, throw an exception.

build

public GoogleCloudStorageReadOptions build()