Environment Variables

A number of environment variables can be used to configure the behavior of the library. There are also functions to configure this behavior in code. The environment variables are convenient when troubleshooting problems.

Endpoint Overrides

  • GOOGLE_CLOUD_CPP_COMPLETION_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeCompletionServiceConnection().
  • GOOGLE_CLOUD_CPP_CONTROL_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeControlServiceConnection().
  • GOOGLE_CLOUD_CPP_CONVERSATIONAL_SEARCH_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeConversationalSearchServiceConnection().
  • GOOGLE_CLOUD_CPP_DATA_STORE_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeDataStoreServiceConnection().
  • GOOGLE_CLOUD_CPP_DOCUMENT_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeDocumentServiceConnection().
  • GOOGLE_CLOUD_CPP_ENGINE_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeEngineServiceConnection().
  • GOOGLE_CLOUD_CPP_GROUNDED_GENERATION_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeGroundedGenerationServiceConnection().
  • GOOGLE_CLOUD_CPP_PROJECT_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeProjectServiceConnection().
  • GOOGLE_CLOUD_CPP_RANK_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeRankServiceConnection().
  • GOOGLE_CLOUD_CPP_RECOMMENDATION_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeRecommendationServiceConnection().
  • GOOGLE_CLOUD_CPP_SCHEMA_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeSchemaServiceConnection().
  • GOOGLE_CLOUD_CPP_SEARCH_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeSearchServiceConnection().
  • GOOGLE_CLOUD_CPP_SITE_SEARCH_ENGINE_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeSiteSearchEngineServiceConnection().
  • GOOGLE_CLOUD_CPP_USER_EVENT_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "discoveryengine.googleapis.com") used by MakeUserEventServiceConnection().
See Also

google::cloud::EndpointOption

Logging

GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc: turns on tracing for most gRPC calls. The library injects an additional Stub decorator that prints each gRPC request and response. Unless you have configured your own logging backend, you should also set GOOGLE_CLOUD_CPP_ENABLE_CLOG to produce any output on the program's console.

See Also

google::cloud::LoggingComponentsOptionGOOGLE_CLOUD_CPP_TRACING_OPTIONS=...: modifies the behavior of gRPC tracing, including whether messages will be output on multiple lines, or whether string/bytes fields will be truncated.

See Also

google::cloud::GrpcTracingOptionsOptionGOOGLE_CLOUD_CPP_ENABLE_CLOG=yes: turns on logging in the library, basically the library always "logs" but the logging infrastructure has no backend to actually print anything until the application sets a backend or they set this environment variable.

See Also

google::cloud::LogBackend

See Also

google::cloud::LogSink

Setting the Default Project

GOOGLE_CLOUD_PROJECT=...: is used in examples and integration tests to configure the GCP project. This has no effect in the library.