Skip to content

Commit 547e803

Browse files
dbolducdbolduc
authored
docs: Document service endpoint environment variables (googleapis#8522)
1 parent 21df16d commit 547e803

78 files changed

Lines changed: 408 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/contributor/howto-guide-adding-generated-libraries.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ were written by a robot:
183183
The Cloud documentation links (`cloud.google.com/*/docs/*`) in these files are
184184
not always valid. Find the correct urls and update the links.
185185

186+
Also, be sure to document each service's endpoint environment variable in
187+
`doc/main.dox`
188+
186189
## Update the root files
187190

188191
Manually edit the following files:

‎generator/internal/scaffold_generator.cc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,9 @@ which should give you a taste of the $title$ C++ client library API.
629629
630630
## Environment Variables
631631
632+
- `GOOGLE_CLOUD_CPP_ EDIT HERE _ENDPOINT=...` changes the default endpoint
633+
( EDIT HERE .googleapis.com) used by ` EDIT HERE Connection`.
634+
632635
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
633636
calls. The library injects an additional Stub decorator that prints each gRPC
634637
request and response. Unless you have configured your own logging backend,

‎google/cloud/accessapproval/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ which should give you a taste of the Access Approval API C++ client library API.
4040

4141
## Environment Variables
4242

43+
- `GOOGLE_CLOUD_CPP_ACCESS_APPROVAL_ENDPOINT=...` changes the default endpoint
44+
(accessapproval.googleapis.com) used by `AccessApprovalConnection`.
45+
4346
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4447
calls. The library injects an additional Stub decorator that prints each gRPC
4548
request and response. Unless you have configured your own logging backend,

‎google/cloud/accesscontextmanager/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ which should give you a taste of the Access Context Manager API C++ client libra
3939

4040
## Environment Variables
4141

42+
- `GOOGLE_CLOUD_CPP_ACCESS_CONTEXT_MANAGER_ENDPOINT=...` changes the default endpoint
43+
(accesscontextmanager.googleapis.com) used by `AccessContextManagerConnection`.
44+
4245
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4346
calls. The library injects an additional Stub decorator that prints each gRPC
4447
request and response. Unless you have configured your own logging backend,

‎google/cloud/apigateway/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ which should give you a taste of the API Gateway API C++ client library API.
3838

3939
## Environment Variables
4040

41+
- `GOOGLE_CLOUD_CPP_API_GATEWAY_SERVICE_ENDPOINT=...` changes the default endpoint
42+
(apigateway.googleapis.com) used by `ApiGatewayServiceConnection`.
43+
4144
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4245
calls. The library injects an additional Stub decorator that prints each gRPC
4346
request and response. Unless you have configured your own logging backend,

‎google/cloud/apigeeconnect/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ which should give you a taste of the Apigee Connect API C++ client library API.
4242

4343
## Environment Variables
4444

45+
- `GOOGLE_CLOUD_CPP_APIGEE_CONNECTION_SERVICE_ENDPOINT=...` changes the default endpoint
46+
(apigeeconnect.googleapis.com) used by `ConnectionServiceConnection`.
47+
4548
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4649
calls. The library injects an additional Stub decorator that prints each gRPC
4750
request and response. Unless you have configured your own logging backend,

‎google/cloud/appengine/doc/main.dox‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,30 @@ which should give you a taste of the App Engine Admin API C++ client library API
3838

3939
## Environment Variables
4040

41+
- `GOOGLE_CLOUD_CPP_APPLICATIONS_ENDPOINT=...` changes the default endpoint
42+
(appengine.googleapis.com) used by `ApplicationsConnection`.
43+
44+
- `GOOGLE_CLOUD_CPP_AUTHORIZED_CERTIFICATES_ENDPOINT=...` changes the default endpoint
45+
(appengine.googleapis.com) used by `AuthorizedCertificatesConnection`.
46+
47+
- `GOOGLE_CLOUD_CPP_AUTHORIZED_DOMAINS_ENDPOINT=...` changes the default endpoint
48+
(appengine.googleapis.com) used by `AuthorizedDomainsConnection`.
49+
50+
- `GOOGLE_CLOUD_CPP_DOMAIN_MAPPINGS_ENDPOINT=...` changes the default endpoint
51+
(appengine.googleapis.com) used by `DomainMappingsConnection`.
52+
53+
- `GOOGLE_CLOUD_CPP_FIREWALL_ENDPOINT=...` changes the default endpoint
54+
(appengine.googleapis.com) used by `FirewallConnection`.
55+
56+
- `GOOGLE_CLOUD_CPP_INSTANCES_ENDPOINT=...` changes the default endpoint
57+
(appengine.googleapis.com) used by `InstancesConnection`.
58+
59+
- `GOOGLE_CLOUD_CPP_SERVICES_ENDPOINT=...` changes the default endpoint
60+
(appengine.googleapis.com) used by `ServicesConnection`.
61+
62+
- `GOOGLE_CLOUD_CPP_VERSIONS_ENDPOINT=...` changes the default endpoint
63+
(appengine.googleapis.com) used by `VersionsConnection`.
64+
4165
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4266
calls. The library injects an additional Stub decorator that prints each gRPC
4367
request and response. Unless you have configured your own logging backend,

‎google/cloud/artifactregistry/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ which should give you a taste of the Artifact Registry API C++ client library AP
3939

4040
## Environment Variables
4141

42+
- `GOOGLE_CLOUD_CPP_ARTIFACT_REGISTRY_ENDPOINT=...` changes the default endpoint
43+
(artifactregistry.googleapis.com) used by `ArtifactRegistryConnection`.
44+
4245
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4346
calls. The library injects an additional Stub decorator that prints each gRPC
4447
request and response. Unless you have configured your own logging backend,

‎google/cloud/asset/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ which should give you a taste of the Cloud Asset API C++ client library API.
3939

4040
## Environment Variables
4141

42+
- `GOOGLE_CLOUD_CPP_ASSET_SERVICE_ENDPOINT=...` changes the default endpoint
43+
(cloudasset.googleapis.com) used by `AssetServiceConnection`.
44+
4245
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4346
calls. The library injects an additional Stub decorator that prints each gRPC
4447
request and response. Unless you have configured your own logging backend,

‎google/cloud/assuredworkloads/doc/main.dox‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ which should give you a taste of the Assured Workloads API C++ client library AP
4141

4242
## Environment Variables
4343

44+
- `GOOGLE_CLOUD_CPP_ASSURED_WORKLOADS_SERVICE_ENDPOINT=...` changes the default endpoint
45+
(assuredworkloads.googleapis.com) used by `AssuredWorkloadsServiceConnection`.
46+
4447
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4548
calls. The library injects an additional Stub decorator that prints each gRPC
4649
request and response. Unless you have configured your own logging backend,

0 commit comments

Comments
 (0)