BigtableOptionsFactory (com.google.cloud.bigtable:bigtable-hbase 0.2.2 API)

java.lang.Object
- com.google.cloud.bigtable.hbase.BigtableOptionsFactory

```
public class BigtableOptionsFactory
extends Object
```
Static methods to convert an instance of Configuration to a BigtableOptions instance.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIGTABE_USE_SERVICE_ACCOUNTS_KEY` Key to set to enable service accounts to be used, either metadata server-based or P12-based.
`static String`	`BIGTABLE_CHANNEL_TIMEOUT_MS_KEY` The maximum length of time to keep a Bigtable grpc channel open.
`static String`	`BIGTABLE_CLUSTER_ADMIN_HOST_KEY`
`static String`	`BIGTABLE_DATA_CHANNEL_COUNT_KEY` The number of grpc channels to open for asynchronous processing such as puts.
`static String`	`BIGTABLE_HOST_KEY`
`static boolean`	`BIGTABLE_NULL_CREDENTIAL_ENABLE_DEFAULT`
`static String`	`BIGTABLE_NULL_CREDENTIAL_ENABLE_KEY` Key to allow unit tests to proceed with an invalid credential configuration.
`static String`	`BIGTABLE_PORT_KEY`
`static String`	`BIGTABLE_SERVICE_ACCOUNT_EMAIL_KEY` Key to set when using P12 keyfile authentication.
`static String`	`BIGTABLE_SERVICE_ACCOUNT_JSON_KEYFILE_LOCATION_KEY` Key to set to a location where a json security credentials file can be found.
`static String`	`BIGTABLE_SERVICE_ACCOUNT_P12_KEYFILE_LOCATION_KEY` Key to set to a location where a P12 keyfile can be found that corresponds to the provided service account email address.
`static String`	`BIGTABLE_TABLE_ADMIN_HOST_KEY`
`static boolean`	`BIGTABLE_USE_SERVICE_ACCOUNTS_DEFAULT`
`static String`	`CLUSTER_KEY`
`static String`	`ENABLE_GRPC_RETRIES_KEY` Key to set to a boolean flag indicating whether or not grpc retries should be enabled.
`static String`	`ENABLE_GRPC_RETRY_DEADLINEEXCEEDED_KEY` Key to set to a boolean flag indicating whether or not to retry grpc call on deadline exceeded.
`static String`	`IP_OVERRIDE_KEY` If set, bypass DNS host lookup and use the given IP address.
`protected static Logger`	`LOG`
`static String`	`MAX_ELAPSED_BACKOFF_MILLIS_KEY` Key to set the maximum amount of time to wait for retries, given a backoff policy on errors.
`static String`	`PROJECT_ID_KEY`
`static String`	`READ_BATCH_SIZE` Key to set the batch size of messages to request when scanning.
`static String`	`READ_BUFFER_SIZE` Key to set the maximum number of messages to buffer when scanning.
`static String`	`READ_PARTIAL_ROW_TIMEOUT_MS` Key to set the amount of time to wait when reading a partial row.
`static String`	`ZONE_KEY`

Constructor Summary

Constructors
Constructor and Description

BigtableOptionsFactory()

Constructors
Constructor and Description
`BigtableOptionsFactory()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static BigtableOptions fromConfiguration(org.apache.hadoop.conf.Configuration configuration)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BigtableOptions`	`fromConfiguration(org.apache.hadoop.conf.Configuration configuration)`

- Field Detail
  - LOG
```
protected static final Logger LOG
```
  - BIGTABLE_PORT_KEY
```
public static final String BIGTABLE_PORT_KEY
```
    See Also:
    
    Constant Field Values
  - BIGTABLE_CLUSTER_ADMIN_HOST_KEY
```
public static final String BIGTABLE_CLUSTER_ADMIN_HOST_KEY
```
    See Also:
    
    Constant Field Values
  - BIGTABLE_TABLE_ADMIN_HOST_KEY
```
public static final String BIGTABLE_TABLE_ADMIN_HOST_KEY
```
    See Also:
    
    Constant Field Values
  - BIGTABLE_HOST_KEY
```
public static final String BIGTABLE_HOST_KEY
```
    See Also:
    
    Constant Field Values
  - PROJECT_ID_KEY
```
public static final String PROJECT_ID_KEY
```
    See Also:
    
    Constant Field Values
  - CLUSTER_KEY
```
public static final String CLUSTER_KEY
```
    See Also:
    
    Constant Field Values
  - ZONE_KEY
```
public static final String ZONE_KEY
```
    See Also:
    
    Constant Field Values
  - IP_OVERRIDE_KEY
```
public static final String IP_OVERRIDE_KEY
```
    If set, bypass DNS host lookup and use the given IP address.
    
    See Also:
    
    Constant Field Values
  - BIGTABE_USE_SERVICE_ACCOUNTS_KEY
```
public static final String BIGTABE_USE_SERVICE_ACCOUNTS_KEY
```
    Key to set to enable service accounts to be used, either metadata server-based or P12-based. Defaults to enabled.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_USE_SERVICE_ACCOUNTS_DEFAULT
```
public static final boolean BIGTABLE_USE_SERVICE_ACCOUNTS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - BIGTABLE_NULL_CREDENTIAL_ENABLE_KEY
```
public static final String BIGTABLE_NULL_CREDENTIAL_ENABLE_KEY
```
    Key to allow unit tests to proceed with an invalid credential configuration.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_NULL_CREDENTIAL_ENABLE_DEFAULT
```
public static final boolean BIGTABLE_NULL_CREDENTIAL_ENABLE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - BIGTABLE_SERVICE_ACCOUNT_EMAIL_KEY
```
public static final String BIGTABLE_SERVICE_ACCOUNT_EMAIL_KEY
```
    Key to set when using P12 keyfile authentication. The value should be the service account email address as displayed. If this value is not set and using service accounts is enabled, a metadata server account will be used.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_SERVICE_ACCOUNT_P12_KEYFILE_LOCATION_KEY
```
public static final String BIGTABLE_SERVICE_ACCOUNT_P12_KEYFILE_LOCATION_KEY
```
    Key to set to a location where a P12 keyfile can be found that corresponds to the provided service account email address.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_SERVICE_ACCOUNT_JSON_KEYFILE_LOCATION_KEY
```
public static final String BIGTABLE_SERVICE_ACCOUNT_JSON_KEYFILE_LOCATION_KEY
```
    Key to set to a location where a json security credentials file can be found.
    
    See Also:
    
    Constant Field Values
  - ENABLE_GRPC_RETRIES_KEY
```
public static final String ENABLE_GRPC_RETRIES_KEY
```
    Key to set to a boolean flag indicating whether or not grpc retries should be enabled. The default is to enable retries on failed idempotent operations.
    
    See Also:
    
    Constant Field Values
  - ENABLE_GRPC_RETRY_DEADLINEEXCEEDED_KEY
```
public static final String ENABLE_GRPC_RETRY_DEADLINEEXCEEDED_KEY
```
    Key to set to a boolean flag indicating whether or not to retry grpc call on deadline exceeded. This flag is used only when grpc retries is enabled.
    
    See Also:
    
    Constant Field Values
  - MAX_ELAPSED_BACKOFF_MILLIS_KEY
```
public static final String MAX_ELAPSED_BACKOFF_MILLIS_KEY
```
    Key to set the maximum amount of time to wait for retries, given a backoff policy on errors. This flag is used only when grpc retries is enabled.
    
    See Also:
    
    Constant Field Values
  - READ_PARTIAL_ROW_TIMEOUT_MS
```
public static final String READ_PARTIAL_ROW_TIMEOUT_MS
```
    Key to set the amount of time to wait when reading a partial row.
    
    See Also:
    
    Constant Field Values
  - READ_BUFFER_SIZE
```
public static final String READ_BUFFER_SIZE
```
    Key to set the maximum number of messages to buffer when scanning.
    
    See Also:
    
    Constant Field Values
  - READ_BATCH_SIZE
```
public static final String READ_BATCH_SIZE
```
    Key to set the batch size of messages to request when scanning.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_DATA_CHANNEL_COUNT_KEY
```
public static final String BIGTABLE_DATA_CHANNEL_COUNT_KEY
```
    The number of grpc channels to open for asynchronous processing such as puts.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_CHANNEL_TIMEOUT_MS_KEY
```
public static final String BIGTABLE_CHANNEL_TIMEOUT_MS_KEY
```
    The maximum length of time to keep a Bigtable grpc channel open.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BigtableOptionsFactory
```
public BigtableOptionsFactory()
```
- Method Detail
  - fromConfiguration
```
public static BigtableOptions fromConfiguration(org.apache.hadoop.conf.Configuration configuration)
                                         throws IOException
```
    Throws:
    
    IOException

Class BigtableOptionsFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

BIGTABLE_PORT_KEY

BIGTABLE_CLUSTER_ADMIN_HOST_KEY

BIGTABLE_TABLE_ADMIN_HOST_KEY

BIGTABLE_HOST_KEY

PROJECT_ID_KEY

CLUSTER_KEY

ZONE_KEY

IP_OVERRIDE_KEY

BIGTABE_USE_SERVICE_ACCOUNTS_KEY

BIGTABLE_USE_SERVICE_ACCOUNTS_DEFAULT

BIGTABLE_NULL_CREDENTIAL_ENABLE_KEY

BIGTABLE_NULL_CREDENTIAL_ENABLE_DEFAULT

BIGTABLE_SERVICE_ACCOUNT_EMAIL_KEY

BIGTABLE_SERVICE_ACCOUNT_P12_KEYFILE_LOCATION_KEY

BIGTABLE_SERVICE_ACCOUNT_JSON_KEYFILE_LOCATION_KEY

ENABLE_GRPC_RETRIES_KEY

ENABLE_GRPC_RETRY_DEADLINEEXCEEDED_KEY

MAX_ELAPSED_BACKOFF_MILLIS_KEY

READ_PARTIAL_ROW_TIMEOUT_MS

READ_BUFFER_SIZE

READ_BATCH_SIZE

BIGTABLE_DATA_CHANNEL_COUNT_KEY

BIGTABLE_CHANNEL_TIMEOUT_MS_KEY

Constructor Detail

BigtableOptionsFactory

Method Detail

fromConfiguration