GoogleCloudStorageReadOptions (gcsio 2.2.10 API)

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

```
public abstract class GoogleCloudStorageReadOptions
extends Object
```
Advanced options for reading GoogleCloudStorage objects. Immutable; callers must use the inner GoogleCloudStorageReadOptions.Builder class to construct instances.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GoogleCloudStorageReadOptions.Builder` Mutable builder for GoogleCloudStorageReadOptions.
`static class`	`GoogleCloudStorageReadOptions.Fadvise` Operational modes of fadvise feature.

Field Summary

Fields
Modifier and Type	Field and Description
`static GoogleCloudStorageReadOptions`	`DEFAULT`
`static int`	`DEFAULT_BACKOFF_INITIAL_INTERVAL_MILLIS`
`static int`	`DEFAULT_BACKOFF_MAX_ELAPSED_TIME_MILLIS`
`static int`	`DEFAULT_BACKOFF_MAX_INTERVAL_MILLIS`
`static double`	`DEFAULT_BACKOFF_MULTIPLIER`
`static double`	`DEFAULT_BACKOFF_RANDOMIZATION_FACTOR`
`static GoogleCloudStorageReadOptions.Fadvise`	`DEFAULT_FADVISE`
`static boolean`	`DEFAULT_FAST_FAIL_ON_NOT_FOUND`
`static long`	`DEFAULT_GRPC_READ_MESSAGE_TIMEOUT_MILLIS`
`static long`	`DEFAULT_GRPC_READ_METADATA_TIMEOUT_MILLIS`
`static long`	`DEFAULT_GRPC_READ_TIMEOUT_MILLIS`
`static boolean`	`DEFAULT_GRPC_READ_ZEROCOPY_ENABLED`
`static long`	`DEFAULT_INPLACE_SEEK_LIMIT`
`static int`	`DEFAULT_MIN_RANGE_REQUEST_SIZE`
`static boolean`	`DEFAULT_SUPPORT_GZIP_ENCODING`
`static boolean`	`GRPC_CHECKSUMS_ENABLED_DEFAULT`
`static boolean`	`TRACE_LOGGING_ENABLED_DEFAULT`

Constructor Summary

Constructors
Constructor and Description

GoogleCloudStorageReadOptions()

Constructors
Constructor and Description
`GoogleCloudStorageReadOptions()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static GoogleCloudStorageReadOptions.Builder`	`builder()`
`abstract int`	`getBackoffInitialIntervalMillis()` See `GoogleCloudStorageReadOptions.Builder.setBackoffInitialIntervalMillis(int)`.
`abstract int`	`getBackoffMaxElapsedTimeMillis()` See `GoogleCloudStorageReadOptions.Builder.setBackoffMaxElapsedTimeMillis(int)`.
`abstract int`	`getBackoffMaxIntervalMillis()` See `GoogleCloudStorageReadOptions.Builder.setBackoffMaxIntervalMillis(int)`.
`abstract double`	`getBackoffMultiplier()` See `GoogleCloudStorageReadOptions.Builder.setBackoffMultiplier(double)`.
`abstract double`	`getBackoffRandomizationFactor()` See `GoogleCloudStorageReadOptions.Builder.setBackoffRandomizationFactor(double)`.
`abstract GoogleCloudStorageReadOptions.Fadvise`	`getFadvise()` See `GoogleCloudStorageReadOptions.Builder.setFadvise(com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadOptions.Fadvise)`.
`abstract boolean`	`getFastFailOnNotFound()` See `GoogleCloudStorageReadOptions.Builder.setFastFailOnNotFound(boolean)`.
`abstract long`	`getGrpcReadMessageTimeoutMillis()` See `GoogleCloudStorageReadOptions.Builder.setGrpcReadTimeoutMillis(long)`.
`abstract long`	`getGrpcReadMetadataTimeoutMillis()` See `GoogleCloudStorageReadOptions.Builder.setGrpcReadMetadataTimeoutMillis(long)`.
`abstract long`	`getGrpcReadTimeoutMillis()` See `GoogleCloudStorageReadOptions.Builder.setGrpcReadTimeoutMillis(long)`.
`abstract long`	`getInplaceSeekLimit()` See `GoogleCloudStorageReadOptions.Builder.setInplaceSeekLimit(long)`.
`abstract int`	`getMinRangeRequestSize()` See `GoogleCloudStorageReadOptions.Builder.setMinRangeRequestSize(int)`.
`abstract boolean`	`getSupportGzipEncoding()` See `GoogleCloudStorageReadOptions.Builder.setSupportGzipEncoding(boolean)`.
`abstract boolean`	`isGrpcChecksumsEnabled()` See `GoogleCloudStorageReadOptions.Builder.setGrpcChecksumsEnabled(boolean)`.
`abstract boolean`	`isGrpcReadZeroCopyEnabled()` See `GoogleCloudStorageReadOptions.Builder.setGrpcReadZeroCopyEnabled(boolean)`.
`abstract boolean`	`isTraceLogEnabled()` See `GoogleCloudStorageReadOptions.Builder.setTraceLogEnabled(boolean)` .
`abstract GoogleCloudStorageReadOptions.Builder`	`toBuilder()`

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

- Field Detail
  - DEFAULT_BACKOFF_INITIAL_INTERVAL_MILLIS
```
public static final int DEFAULT_BACKOFF_INITIAL_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKOFF_RANDOMIZATION_FACTOR
```
public static final double DEFAULT_BACKOFF_RANDOMIZATION_FACTOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKOFF_MULTIPLIER
```
public static final double DEFAULT_BACKOFF_MULTIPLIER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKOFF_MAX_INTERVAL_MILLIS
```
public static final int DEFAULT_BACKOFF_MAX_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKOFF_MAX_ELAPSED_TIME_MILLIS
```
public static final int DEFAULT_BACKOFF_MAX_ELAPSED_TIME_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FAST_FAIL_ON_NOT_FOUND
```
public static final boolean DEFAULT_FAST_FAIL_ON_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SUPPORT_GZIP_ENCODING
```
public static final boolean DEFAULT_SUPPORT_GZIP_ENCODING
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INPLACE_SEEK_LIMIT
```
public static final long DEFAULT_INPLACE_SEEK_LIMIT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FADVISE
```
public static final GoogleCloudStorageReadOptions.Fadvise DEFAULT_FADVISE
```
  - DEFAULT_MIN_RANGE_REQUEST_SIZE
```
public static final int DEFAULT_MIN_RANGE_REQUEST_SIZE
```
    See Also:
    
    Constant Field Values
  - GRPC_CHECKSUMS_ENABLED_DEFAULT
```
public static final boolean GRPC_CHECKSUMS_ENABLED_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_GRPC_READ_TIMEOUT_MILLIS
```
public static final long DEFAULT_GRPC_READ_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_GRPC_READ_METADATA_TIMEOUT_MILLIS
```
public static final long DEFAULT_GRPC_READ_METADATA_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_GRPC_READ_ZEROCOPY_ENABLED
```
public static final boolean DEFAULT_GRPC_READ_ZEROCOPY_ENABLED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_GRPC_READ_MESSAGE_TIMEOUT_MILLIS
```
public static final long DEFAULT_GRPC_READ_MESSAGE_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - TRACE_LOGGING_ENABLED_DEFAULT
```
public static final boolean TRACE_LOGGING_ENABLED_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final GoogleCloudStorageReadOptions DEFAULT
```
- Constructor Detail
  - GoogleCloudStorageReadOptions
```
public GoogleCloudStorageReadOptions()
```
- Method Detail
  - builder
```
public static GoogleCloudStorageReadOptions.Builder builder()
```
  - toBuilder
```
public abstract GoogleCloudStorageReadOptions.Builder toBuilder()
```
  - getBackoffInitialIntervalMillis
```
public abstract int getBackoffInitialIntervalMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setBackoffInitialIntervalMillis(int).
  - getBackoffRandomizationFactor
```
public abstract double getBackoffRandomizationFactor()
```
    See GoogleCloudStorageReadOptions.Builder.setBackoffRandomizationFactor(double).
  - getBackoffMultiplier
```
public abstract double getBackoffMultiplier()
```
    See GoogleCloudStorageReadOptions.Builder.setBackoffMultiplier(double).
  - getBackoffMaxIntervalMillis
```
public abstract int getBackoffMaxIntervalMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setBackoffMaxIntervalMillis(int).
  - getBackoffMaxElapsedTimeMillis
```
public abstract int getBackoffMaxElapsedTimeMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setBackoffMaxElapsedTimeMillis(int).
  - getFastFailOnNotFound
```
public abstract boolean getFastFailOnNotFound()
```
    See GoogleCloudStorageReadOptions.Builder.setFastFailOnNotFound(boolean).
  - getSupportGzipEncoding
```
public abstract boolean getSupportGzipEncoding()
```
    See GoogleCloudStorageReadOptions.Builder.setSupportGzipEncoding(boolean).
  - getInplaceSeekLimit
```
public abstract long getInplaceSeekLimit()
```
    See GoogleCloudStorageReadOptions.Builder.setInplaceSeekLimit(long).
  - getFadvise
```
public abstract GoogleCloudStorageReadOptions.Fadvise getFadvise()
```
    See GoogleCloudStorageReadOptions.Builder.setFadvise(com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadOptions.Fadvise).
  - getMinRangeRequestSize
```
public abstract int getMinRangeRequestSize()
```
    See GoogleCloudStorageReadOptions.Builder.setMinRangeRequestSize(int).
  - isGrpcChecksumsEnabled
```
public abstract boolean isGrpcChecksumsEnabled()
```
    See GoogleCloudStorageReadOptions.Builder.setGrpcChecksumsEnabled(boolean).
  - getGrpcReadTimeoutMillis
```
public abstract long getGrpcReadTimeoutMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setGrpcReadTimeoutMillis(long).
  - getGrpcReadMetadataTimeoutMillis
```
public abstract long getGrpcReadMetadataTimeoutMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setGrpcReadMetadataTimeoutMillis(long).
  - isGrpcReadZeroCopyEnabled
```
public abstract boolean isGrpcReadZeroCopyEnabled()
```
    See GoogleCloudStorageReadOptions.Builder.setGrpcReadZeroCopyEnabled(boolean).
  - getGrpcReadMessageTimeoutMillis
```
public abstract long getGrpcReadMessageTimeoutMillis()
```
    See GoogleCloudStorageReadOptions.Builder.setGrpcReadTimeoutMillis(long).
  - isTraceLogEnabled
```
public abstract boolean isTraceLogEnabled()
```
    See GoogleCloudStorageReadOptions.Builder.setTraceLogEnabled(boolean) .

Class GoogleCloudStorageReadOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BACKOFF_INITIAL_INTERVAL_MILLIS

DEFAULT_BACKOFF_RANDOMIZATION_FACTOR

DEFAULT_BACKOFF_MULTIPLIER

DEFAULT_BACKOFF_MAX_INTERVAL_MILLIS

DEFAULT_BACKOFF_MAX_ELAPSED_TIME_MILLIS

DEFAULT_FAST_FAIL_ON_NOT_FOUND

DEFAULT_SUPPORT_GZIP_ENCODING

DEFAULT_INPLACE_SEEK_LIMIT

DEFAULT_FADVISE

DEFAULT_MIN_RANGE_REQUEST_SIZE

GRPC_CHECKSUMS_ENABLED_DEFAULT

DEFAULT_GRPC_READ_TIMEOUT_MILLIS

DEFAULT_GRPC_READ_METADATA_TIMEOUT_MILLIS

DEFAULT_GRPC_READ_ZEROCOPY_ENABLED

DEFAULT_GRPC_READ_MESSAGE_TIMEOUT_MILLIS

TRACE_LOGGING_ENABLED_DEFAULT

DEFAULT

Constructor Detail

GoogleCloudStorageReadOptions

Method Detail

builder

toBuilder

getBackoffInitialIntervalMillis

getBackoffRandomizationFactor

getBackoffMultiplier

getBackoffMaxIntervalMillis

getBackoffMaxElapsedTimeMillis

getFastFailOnNotFound

getSupportGzipEncoding

getInplaceSeekLimit

getFadvise

getMinRangeRequestSize

isGrpcChecksumsEnabled

getGrpcReadTimeoutMillis

getGrpcReadMetadataTimeoutMillis

isGrpcReadZeroCopyEnabled

getGrpcReadMessageTimeoutMillis

isTraceLogEnabled