BigtableOptions (Cloud Bigtable HBase Client for Java 1.21.1 API)

java.lang.Object
- com.google.cloud.bigtable.config.BigtableOptions

All Implemented Interfaces:

Serializable, Cloneable
```
@InternalExtensionOnly
public class BigtableOptions
extends Object
implements Serializable, Cloneable
```
An immutable class providing access to configuration options for Bigtable.

Version:

$Id: $Id

Author:

sduskis

See Also:

google-cloud-bigtable java idiomatic client to access cloud Bigtable API., Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BigtableOptions.Builder` A mutable builder for BigtableConnectionOptions.
`static interface`	`BigtableOptions.ChannelConfigurator` For internal use only - public for technical reasons.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIGTABLE_ADMIN_HOST_DEFAULT` For internal use only - public for technical reasons.
`static String`	`BIGTABLE_APP_PROFILE_DEFAULT` Constant `BIGTABLE_APP_PROFILE_DEFAULT=""`, defaults to the server default app profile
`static String`	`BIGTABLE_BATCH_DATA_HOST_DEFAULT` For internal use only - public for technical reasons.
`static String`	`BIGTABLE_CLIENT_ADAPTER` Deprecated. This field will be removed in future versions.
`static int`	`BIGTABLE_DATA_CHANNEL_COUNT_DEFAULT` For internal use only - public for technical reasons.
`static String`	`BIGTABLE_DATA_HOST_DEFAULT` For internal use only - public for technical reasons.
`static String`	`BIGTABLE_EMULATOR_HOST_ENV_VAR` For internal use only - public for technical reasons.
`static int`	`BIGTABLE_PORT_DEFAULT` For internal use only - public for technical reasons.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BigtableOptions.Builder`	`builder()` Create a new instance of the `BigtableOptions.Builder`.
`protected BigtableOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdminHost()` Getter for the field `tableAdminHost`.
`String`	`getAppProfileId()` Getter for the field `appProfileId`.
`BulkOptions`	`getBulkOptions()` Getter for the field `bulkOptions`.
`CallOptionsConfig`	`getCallOptionsConfig()` Getter for the field `callOptionsConfig`.
`BigtableOptions.ChannelConfigurator`	`getChannelConfigurator()` For internal use only - public for technical reasons.
`int`	`getChannelCount()` The number of data channels to create.
`CredentialOptions`	`getCredentialOptions()` Get the credential this object was constructed with.
`String`	`getDataHost()` Getter for the field `dataHost`.
`static BigtableOptions`	`getDefaultOptions()`
`String`	`getInstanceId()` Getter for the field `instanceId`.
`BigtableInstanceName`	`getInstanceName()` Getter for the field `instanceName`.
`int`	`getPort()` Getter for the field `port`.
`String`	`getProjectId()` Getter for the field `projectId`.
`RetryOptions`	`getRetryOptions()` Options controlling retries.
`String`	`getTracingCookie()` Getter for tracing cookie
`String`	`getUserAgent()` Gets the user-agent to be appended to User-Agent header when creating new streams for the channel.
`static boolean`	`isDirectPathEnabled()` Checks if DirectPath is enabled via an environment variable.
`BigtableOptions.Builder`	`toBuilder()` toBuilder.
`String`	`toString()`
`boolean`	`useBatch()`
`boolean`	`useCachedChannel()` Experimental feature to allow situations with multiple connections to optimize their startup time.
`boolean`	`useGCJClient()` useGCJClient
`boolean`	`usePlaintextNegotiation()` usePlaintextNegotiation.

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

- Field Detail
  - BIGTABLE_EMULATOR_HOST_ENV_VAR
```
@InternalApi(value="For internal usage only")
public static final String BIGTABLE_EMULATOR_HOST_ENV_VAR
```
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_ADMIN_HOST_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final String BIGTABLE_ADMIN_HOST_DEFAULT
```
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_DATA_HOST_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final String BIGTABLE_DATA_HOST_DEFAULT
```
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_BATCH_DATA_HOST_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final String BIGTABLE_BATCH_DATA_HOST_DEFAULT
```
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_PORT_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final int BIGTABLE_PORT_DEFAULT
```
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_DATA_CHANNEL_COUNT_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final int BIGTABLE_DATA_CHANNEL_COUNT_DEFAULT
```
    For internal use only - public for technical reasons.
  - BIGTABLE_APP_PROFILE_DEFAULT
```
@InternalApi(value="For internal usage only")
public static final String BIGTABLE_APP_PROFILE_DEFAULT
```
    Constant BIGTABLE_APP_PROFILE_DEFAULT="", defaults to the server default app profile
    For internal use only - public for technical reasons.
    
    See Also:
    
    Constant Field Values
  - BIGTABLE_CLIENT_ADAPTER
```
@Deprecated
public static final String BIGTABLE_CLIENT_ADAPTER
```
    Deprecated. This field will be removed in future versions.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDefaultOptions
```
public static BigtableOptions getDefaultOptions()
```
  - isDirectPathEnabled
```
@InternalApi(value="For internal use only")
public static boolean isDirectPathEnabled()
```
    Checks if DirectPath is enabled via an environment variable.
    For internal use only - public for technical reasons.
  - builder
```
public static BigtableOptions.Builder builder()
```
    Create a new instance of the BigtableOptions.Builder.
  - getProjectId
```
public String getProjectId()
```
    Getter for the field projectId.
    
    Returns:
    
    a String object.
  - getDataHost
```
public String getDataHost()
```
    Getter for the field dataHost.
    
    Returns:
    
    a String object.
  - getAdminHost
```
public String getAdminHost()
```
    Getter for the field tableAdminHost.
    
    Returns:
    
    a String object.
  - getInstanceId
```
public String getInstanceId()
```
    Getter for the field instanceId.
    
    Returns:
    
    a String object.
  - getAppProfileId
```
public String getAppProfileId()
```
    Getter for the field appProfileId.
    
    Returns:
    
    a String object.
  - getPort
```
public int getPort()
```
    Getter for the field port.
    
    Returns:
    
    a int.
  - getCredentialOptions
```
public CredentialOptions getCredentialOptions()
```
    Get the credential this object was constructed with. May be null.
    
    Returns:
    
    Null to indicate no credentials, otherwise, the Credentials object.
  - getUserAgent
```
public String getUserAgent()
```
    Gets the user-agent to be appended to User-Agent header when creating new streams for the channel.
    
    Returns:
    
    a String object.
  - getRetryOptions
```
public RetryOptions getRetryOptions()
```
    Options controlling retries.
    
    Returns:
    
    a RetryOptions object.
  - getChannelCount
```
public int getChannelCount()
```
    The number of data channels to create.
    
    Returns:
    
    a int.
  - getChannelConfigurator
```
@InternalApi(value="Visible for testing only")
 @Nullable
public BigtableOptions.ChannelConfigurator getChannelConfigurator()
```
    For internal use only - public for technical reasons.
  - getInstanceName
```
public BigtableInstanceName getInstanceName()
```
    Getter for the field instanceName.
    
    Returns:
    
    a BigtableInstanceName object.
  - getBulkOptions
```
public BulkOptions getBulkOptions()
```
    Getter for the field bulkOptions.
    
    Returns:
    
    a BulkOptions object.
  - usePlaintextNegotiation
```
public boolean usePlaintextNegotiation()
```
    usePlaintextNegotiation.
    
    Returns:
    
    a boolean.
  - getCallOptionsConfig
```
public CallOptionsConfig getCallOptionsConfig()
```
    Getter for the field callOptionsConfig.
    
    Returns:
    
    a CallOptionsConfig object.
  - useGCJClient
```
@BetaApi(value="Will be removed after hbase transitions away from bigtable-client-core")
public boolean useGCJClient()
```
    useGCJClient
    
    Returns:
    
    a boolean flag to decide which client to use for Data & Admin Operations.
  - getTracingCookie
```
@BetaApi(value="The API for tracing cookie is not yet stable and may change in the future")
public String getTracingCookie()
```
    Getter for tracing cookie
    
    Returns:
    
    return the tracing cookie.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public BigtableOptions.Builder toBuilder()
```
    toBuilder.
    
    Returns:
    
    a BigtableOptions.Builder object.
  - useCachedChannel
```
public boolean useCachedChannel()
```
    Experimental feature to allow situations with multiple connections to optimize their startup time.
    
    Returns:
    
    true if this feature should be turned on in BigtableSession.
  - useBatch
```
public boolean useBatch()
```
  - clone
```
protected BigtableOptions clone()
```
    Overrides:
    
    clone in class Object

Class BigtableOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BIGTABLE_EMULATOR_HOST_ENV_VAR

BIGTABLE_ADMIN_HOST_DEFAULT

BIGTABLE_DATA_HOST_DEFAULT

BIGTABLE_BATCH_DATA_HOST_DEFAULT

BIGTABLE_PORT_DEFAULT

BIGTABLE_DATA_CHANNEL_COUNT_DEFAULT

BIGTABLE_APP_PROFILE_DEFAULT

BIGTABLE_CLIENT_ADAPTER

Method Detail

getDefaultOptions

isDirectPathEnabled

builder

getProjectId

getDataHost

getAdminHost

getInstanceId

getAppProfileId

getPort

getCredentialOptions

getUserAgent

getRetryOptions

getChannelCount

getChannelConfigurator

getInstanceName

getBulkOptions

usePlaintextNegotiation

getCallOptionsConfig

useGCJClient

getTracingCookie

equals

toString

toBuilder

useCachedChannel

useBatch

clone