options.h File Reference

This file defines options to be used with instances of google::cloud::Options. More...

#include "google/cloud/bigtable/version.h"
#include "google/cloud/options.h"
#include <chrono>
#include <string>

Go to the source code of this file.

Classes
struct	google::cloud::bigtable::DataEndpointOption
	The endpoint for data operations. More...
struct	google::cloud::bigtable::AdminEndpointOption
	The endpoint for table admin operations. More...
struct	google::cloud::bigtable::InstanceAdminEndpointOption
	The endpoint for instance admin operations. More...
struct	google::cloud::bigtable::MinConnectionRefreshOption
	Minimum time in ms to refresh connections. More...
struct	google::cloud::bigtable::MaxConnectionRefreshOption
	Maximum time in ms to refresh connections. More...

Namespaces
	google
	google::cloud
	google::cloud::bigtable
	Contains all the Cloud Bigtable C++ client APIs.

Typedefs
using	google::cloud::bigtable::ClientOptionList = OptionList< DataEndpointOption, AdminEndpointOption, InstanceAdminEndpointOption, MinConnectionRefreshOption, MaxConnectionRefreshOption >
	The complete list of options accepted by bigtable::*Client More...

Detailed Description

This file defines options to be used with instances of google::cloud::Options.

By convention options are named with an "Option" suffix. As the name would imply, all options are optional, and leaving them unset will result in a reasonable default being chosen.

Not all options are meaningful to all functions that accept a google::cloud::Options instance. Each function that accepts a google::cloud::Options should document which options it expects. This is typically done by indicating lists of options using "OptionList" aliases. For example, a function may indicate that users may set any option in ClientOptionList.

Note

Unrecognized options are allowed and will be ignored. To debug issues with options set GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes in the environment and unexpected options will be logged.

See also

google::cloud::CommonOptionList

google::cloud::GrpcOptionList

Definition in file options.h.