Skip to content

Commit

Permalink
doc(bigtable): create page for configuration options (#10197)
Browse files Browse the repository at this point in the history
  • Loading branch information
coryan authored Nov 8, 2022
1 parent 7b600b7 commit 733cea0
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
9 changes: 9 additions & 0 deletions google/cloud/bigtable/doc/bigtable-options.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*!
@defgroup bigtable-options Bigtable Client Library Configuration Options

The Bigtable client library uses the same mechanism as all other C++ client
libraries for configuration. As usual for the C++ client libraries, it adds a
number of unique options only applicable for the Bigtable library.

@see @ref options - for an overview of client library configuration.
*/
24 changes: 21 additions & 3 deletions google/cloud/bigtable/options.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
*
* @see https://cloud.google.com/bigtable/docs/replication-overview#app-profiles
* for how app profiles are used to achieve replication.
*
* @ingroup bigtable-options
*/
struct AppProfileIdOption {
using Type = std::string;
Expand Down Expand Up @@ -109,6 +111,8 @@ struct InstanceAdminEndpointOption {
* Minimum time in ms to refresh connections.
*
* The server will not disconnect idle connections before this time.
*
* @ingroup bigtable-options
*/
struct MinConnectionRefreshOption {
using Type = std::chrono::milliseconds;
Expand All @@ -123,6 +127,8 @@ struct MinConnectionRefreshOption {
*
* @note If this value is less than the value of `MinConnectionRefreshOption`,
* it will be set to the value of `MinConnectionRefreshOption`.
*
* @ingroup bigtable-options
*/
struct MaxConnectionRefreshOption {
using Type = std::chrono::milliseconds;
Expand All @@ -145,17 +151,29 @@ using DataLimitedErrorCountRetryPolicy =
::google::cloud::internal::LimitedErrorCountRetryPolicy<
bigtable::internal::SafeGrpcRetry>;

/// Option to configure the retry policy used by `Table`.
/**
* Option to configure the retry policy used by `Table`.
*
* @ingroup bigtable-options
*/
struct DataRetryPolicyOption {
using Type = std::shared_ptr<DataRetryPolicy>;
};

/// Option to configure the backoff policy used by `Table`.
/**
* Option to configure the backoff policy used by `Table`.
*
* @ingroup bigtable-options
*/
struct DataBackoffPolicyOption {
using Type = std::shared_ptr<BackoffPolicy>;
};

/// Option to configure the idempotency policy used by `Table`.
/**
* Option to configure the idempotency policy used by `Table`.
*
* @ingroup bigtable-options
*/
struct IdempotentMutationPolicyOption {
using Type = std::shared_ptr<bigtable::IdempotentMutationPolicy>;
};
Expand Down

0 comments on commit 733cea0

Please sign in to comment.