Skip to content

Commit d8de996

Browse files
devbwwdevbww
authored
doc: update generated endpoint documentation (googleapis#9062)
Inject the "inject-endpoint-env-vars" markers into the `main.dox` files, and run the `generate-libraries` build to update the descriptions of the various endpoint environment variables.
1 parent a4c0302 commit d8de996

77 files changed

Lines changed: 797 additions & 326 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.

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,13 @@ 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`.
43+
<!-- inject-endpoint-env-vars-start -->
44+
45+
- `GOOGLE_CLOUD_CPP_ACCESS_APPROVAL_ENDPOINT=...` overrides the
46+
`EndpointOption` (which defaults to "accessapproval.googleapis.com")
47+
used by `MakeAccessApprovalConnection()`.
48+
49+
<!-- inject-endpoint-env-vars-end -->
4550

4651
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4752
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,13 @@ 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`.
42+
<!-- inject-endpoint-env-vars-start -->
43+
44+
- `GOOGLE_CLOUD_CPP_ACCESS_CONTEXT_MANAGER_ENDPOINT=...` overrides the
45+
`EndpointOption` (which defaults to "accesscontextmanager.googleapis.com")
46+
used by `MakeAccessContextManagerConnection()`.
47+
48+
<!-- inject-endpoint-env-vars-end -->
4449

4550
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4651
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,13 @@ 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`.
41+
<!-- inject-endpoint-env-vars-start -->
42+
43+
- `GOOGLE_CLOUD_CPP_API_GATEWAY_SERVICE_ENDPOINT=...` overrides the
44+
`EndpointOption` (which defaults to "apigateway.googleapis.com")
45+
used by `MakeApiGatewayServiceConnection()`.
46+
47+
<!-- inject-endpoint-env-vars-end -->
4348

4449
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4550
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,13 @@ 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`.
45+
<!-- inject-endpoint-env-vars-start -->
46+
47+
- `GOOGLE_CLOUD_CPP_APIGEE_CONNECTION_SERVICE_ENDPOINT=...` overrides the
48+
`EndpointOption` (which defaults to "apigeeconnect.googleapis.com")
49+
used by `MakeConnection()`.
50+
51+
<!-- inject-endpoint-env-vars-end -->
4752

4853
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4954
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,29 +38,41 @@ 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`.
41+
<!-- inject-endpoint-env-vars-start -->
4342

44-
- `GOOGLE_CLOUD_CPP_AUTHORIZED_CERTIFICATES_ENDPOINT=...` changes the default endpoint
45-
(appengine.googleapis.com) used by `AuthorizedCertificatesConnection`.
43+
- `GOOGLE_CLOUD_CPP_APPLICATIONS_ENDPOINT=...` overrides the
44+
`EndpointOption` (which defaults to "appengine.googleapis.com")
45+
used by `MakeApplicationsConnection()`.
4646

47-
- `GOOGLE_CLOUD_CPP_AUTHORIZED_DOMAINS_ENDPOINT=...` changes the default endpoint
48-
(appengine.googleapis.com) used by `AuthorizedDomainsConnection`.
47+
- `GOOGLE_CLOUD_CPP_AUTHORIZED_CERTIFICATES_ENDPOINT=...` overrides the
48+
`EndpointOption` (which defaults to "appengine.googleapis.com")
49+
used by `MakeAuthorizedCertificatesConnection()`.
4950

50-
- `GOOGLE_CLOUD_CPP_DOMAIN_MAPPINGS_ENDPOINT=...` changes the default endpoint
51-
(appengine.googleapis.com) used by `DomainMappingsConnection`.
51+
- `GOOGLE_CLOUD_CPP_AUTHORIZED_DOMAINS_ENDPOINT=...` overrides the
52+
`EndpointOption` (which defaults to "appengine.googleapis.com")
53+
used by `MakeAuthorizedDomainsConnection()`.
5254

53-
- `GOOGLE_CLOUD_CPP_FIREWALL_ENDPOINT=...` changes the default endpoint
54-
(appengine.googleapis.com) used by `FirewallConnection`.
55+
- `GOOGLE_CLOUD_CPP_DOMAIN_MAPPINGS_ENDPOINT=...` overrides the
56+
`EndpointOption` (which defaults to "appengine.googleapis.com")
57+
used by `MakeDomainMappingsConnection()`.
5558

56-
- `GOOGLE_CLOUD_CPP_INSTANCES_ENDPOINT=...` changes the default endpoint
57-
(appengine.googleapis.com) used by `InstancesConnection`.
59+
- `GOOGLE_CLOUD_CPP_FIREWALL_ENDPOINT=...` overrides the
60+
`EndpointOption` (which defaults to "appengine.googleapis.com")
61+
used by `MakeFirewallConnection()`.
5862

59-
- `GOOGLE_CLOUD_CPP_SERVICES_ENDPOINT=...` changes the default endpoint
60-
(appengine.googleapis.com) used by `ServicesConnection`.
63+
- `GOOGLE_CLOUD_CPP_INSTANCES_ENDPOINT=...` overrides the
64+
`EndpointOption` (which defaults to "appengine.googleapis.com")
65+
used by `MakeInstancesConnection()`.
6166

62-
- `GOOGLE_CLOUD_CPP_VERSIONS_ENDPOINT=...` changes the default endpoint
63-
(appengine.googleapis.com) used by `VersionsConnection`.
67+
- `GOOGLE_CLOUD_CPP_SERVICES_ENDPOINT=...` overrides the
68+
`EndpointOption` (which defaults to "appengine.googleapis.com")
69+
used by `MakeServicesConnection()`.
70+
71+
- `GOOGLE_CLOUD_CPP_VERSIONS_ENDPOINT=...` overrides the
72+
`EndpointOption` (which defaults to "appengine.googleapis.com")
73+
used by `MakeVersionsConnection()`.
74+
75+
<!-- inject-endpoint-env-vars-end -->
6476

6577
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
6678
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,13 @@ 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`.
42+
<!-- inject-endpoint-env-vars-start -->
43+
44+
- `GOOGLE_CLOUD_CPP_ARTIFACT_REGISTRY_ENDPOINT=...` overrides the
45+
`EndpointOption` (which defaults to "artifactregistry.googleapis.com")
46+
used by `MakeArtifactRegistryConnection()`.
47+
48+
<!-- inject-endpoint-env-vars-end -->
4449

4550
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4651
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,13 @@ 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`.
42+
<!-- inject-endpoint-env-vars-start -->
43+
44+
- `GOOGLE_CLOUD_CPP_ASSET_SERVICE_ENDPOINT=...` overrides the
45+
`EndpointOption` (which defaults to "cloudasset.googleapis.com")
46+
used by `MakeAssetServiceConnection()`.
47+
48+
<!-- inject-endpoint-env-vars-end -->
4449

4550
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4651
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,13 @@ 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`.
44+
<!-- inject-endpoint-env-vars-start -->
45+
46+
- `GOOGLE_CLOUD_CPP_ASSURED_WORKLOADS_SERVICE_ENDPOINT=...` overrides the
47+
`EndpointOption` (which defaults to "assuredworkloads.googleapis.com")
48+
used by `MakeAssuredWorkloadsServiceConnection()`.
49+
50+
<!-- inject-endpoint-env-vars-end -->
4651

4752
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4853
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,17 @@ which should give you a taste of the Cloud AutoML API C++ client library API.
3939

4040
## Environment Variables
4141

42-
- `GOOGLE_CLOUD_CPP_AUTO_ML_ENDPOINT=...` changes the default endpoint
43-
(automl.googleapis.com) used by `AutoMlConnection`.
42+
<!-- inject-endpoint-env-vars-start -->
4443

45-
- `GOOGLE_CLOUD_CPP_AUTOML_PREDICTION_SERVICE_ENDPOINT=...` changes the default endpoint
46-
(automl.googleapis.com) used by `PredictionServiceConnection`.
44+
- `GOOGLE_CLOUD_CPP_AUTO_ML_ENDPOINT=...` overrides the
45+
`EndpointOption` (which defaults to "automl.googleapis.com")
46+
used by `MakeAutoMlConnection()`.
47+
48+
- `GOOGLE_CLOUD_CPP_AUTOML_PREDICTION_SERVICE_ENDPOINT=...` overrides the
49+
`EndpointOption` (which defaults to "automl.googleapis.com")
50+
used by `MakePredictionServiceConnection()`.
51+
52+
<!-- inject-endpoint-env-vars-end -->
4753

4854
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
4955
calls. The library injects an additional Stub decorator that prints each gRPC

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

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,21 @@ which should give you a taste of the Cloud Billing Budget API C++ client library
4040

4141
## Environment Variables
4242

43-
- `GOOGLE_CLOUD_CPP_BUDGET_SERVICE_ENDPOINT=...` changes the default endpoint
44-
(billingbudgets.googleapis.com) used by `BudgetServiceConnection`.
43+
<!-- inject-endpoint-env-vars-start -->
4544

46-
- `GOOGLE_CLOUD_CPP_CLOUD_BILLING_ENDPOINT=...` changes the default endpoint
47-
(cloudbilling.googleapis.com) used by `CloudBillingConnection`.
45+
- `GOOGLE_CLOUD_CPP_BUDGET_SERVICE_ENDPOINT=...` overrides the
46+
`EndpointOption` (which defaults to "billingbudgets.googleapis.com")
47+
used by `MakeBudgetServiceConnection()`.
4848

49-
- `GOOGLE_CLOUD_CPP_CLOUD_CATALOG_ENDPOINT=...` changes the default endpoint
50-
(cloudbilling.googleapis.com) used by `CloudCatalogConnection`.
49+
- `GOOGLE_CLOUD_CPP_CLOUD_BILLING_ENDPOINT=...` overrides the
50+
`EndpointOption` (which defaults to "cloudbilling.googleapis.com")
51+
used by `MakeCloudBillingConnection()`.
52+
53+
- `GOOGLE_CLOUD_CPP_CLOUD_CATALOG_ENDPOINT=...` overrides the
54+
`EndpointOption` (which defaults to "cloudbilling.googleapis.com")
55+
used by `MakeCloudCatalogConnection()`.
56+
57+
<!-- inject-endpoint-env-vars-end -->
5158

5259
- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
5360
calls. The library injects an additional Stub decorator that prints each gRPC

0 commit comments

Comments
 (0)