Global

Members

RowStateEnum

Enum for chunk formatter Row state. NEW_ROW: initial state or state after commitRow or resetRow ROW_IN_PROGRESS: state after first valid chunk without commitRow or resetRow CELL_IN_PROGRESS: state when valueSize > 0(partial cell)

(constant) gapicConfig

Client JSON configuration object, loaded from src/v2/bigtable_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

(constant) gapicConfig

Client JSON configuration object, loaded from src/v2/bigtable_instance_admin_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

(constant) gapicConfig

Client JSON configuration object, loaded from src/v2/bigtable_table_admin_client_config.json. This file defines retry strategy and timeouts for all API methods in this library.

Type Definitions

ClientConfig

Properties:
Name Type Attributes Default Description
apiEndpoint string <optional>

Override the default API endpoint used to reach Bigtable. This is useful for connecting to your local Bigtable emulator.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.
appProfileId string <optional>

An application profile ID, a configuration string value describing how Cloud Bigtable should treat traffic from a particular end user application.
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
autoRetry boolean <optional>
 true

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.
maxRetries number <optional>
 3

Maximum number of automatic retries attempted before returning the error.

GetInstancesCallback(errnullable, instances, locations, apiResponse)

Parameters:
Name Type Attributes Description
err Error <nullable>

Request error, if any.
instances Array.<Instance>

Array of Instance instances.
locations Array.<string>

from which Instance information could not be retrieved
apiResponse object

The full API response. Note: 'failedLocations' property may contain locations from which Instance information could not be retrieved. Values are of the form projects/<project>/locations/<zone_id>

GetInstancesResponse

Properties:
Name Type Description
0 Array.<Instance>

Array of Instance instances.
1 Array.<string>

locations from which Instance information could not be retrieved
2 object

The full API response. Note: 'failedLocations' property may contain locations from which Instance information could not be retrieved. Values are of the form projects/<project>/locations/<zone_id>