Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 0aa1ea2

Browse files
chore(docs): fix transport README (#2572)
1 parent 295bd84 commit 0aa1ea2

File tree

12 files changed

+73
-61
lines changed
  • gapic/templates/%namespace/%name_%version/%sub/services/%service/transports
  • tests/integration/goldens
    • asset/google/cloud/asset_v1/services/asset_service/transports
    • credentials/google/iam/credentials_v1/services/iam_credentials/transports
    • eventarc/google/cloud/eventarc_v1/services/eventarc/transports
    • logging_internal/google/cloud/logging_v2/services
    • logging/google/cloud/logging_v2/services
    • redis_selective/google/cloud/redis_v1/services/cloud_redis/transports
    • redis/google/cloud/redis_v1/services/cloud_redis/transports

12 files changed

+73
-61
lines changed

gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/README.rst.j2

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
transport inheritance structure
33
_______________________________
44

5-
`{{ service.name }}Transport` is the ABC for all transports.
6-
- public child `{{ service.name }}GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `{{ service.name }}GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_Base{{ service.name }}RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `{{ service.name }}RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
10-
{# Since the service mixins have a similar structure, we factor out shared code into `_shared_macros.j2` to avoid duplication. #}
5+
``{{ service.name }}Transport`` is the ABC for all transports.
6+
7+
- public child ``{{ service.name }}GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``{{ service.name }}GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_Base{{ service.name }}RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``{{ service.name }}RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).
11+
{# Since the service mixins have a similar structure, we factor out shared code into ``_shared_macros.j2`` to avoid duplication. #}

tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`AssetServiceTransport` is the ABC for all transports.
6-
- public child `AssetServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `AssetServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseAssetServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `AssetServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``AssetServiceTransport`` is the ABC for all transports.
6+
7+
- public child ``AssetServiceGrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``AssetServiceGrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseAssetServiceRestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``AssetServiceRestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`IAMCredentialsTransport` is the ABC for all transports.
6-
- public child `IAMCredentialsGrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `IAMCredentialsGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseIAMCredentialsRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `IAMCredentialsRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``IAMCredentialsTransport`` is the ABC for all transports.
6+
7+
- public child ``IAMCredentialsGrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``IAMCredentialsGrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseIAMCredentialsRestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``IAMCredentialsRestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`EventarcTransport` is the ABC for all transports.
6-
- public child `EventarcGrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `EventarcGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseEventarcRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `EventarcRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``EventarcTransport`` is the ABC for all transports.
6+
7+
- public child ``EventarcGrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``EventarcGrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseEventarcRestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``EventarcRestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`ConfigServiceV2Transport` is the ABC for all transports.
6-
- public child `ConfigServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `ConfigServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseConfigServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `ConfigServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``ConfigServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``ConfigServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``ConfigServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseConfigServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``ConfigServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging/google/cloud/logging_v2/services/logging_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`LoggingServiceV2Transport` is the ABC for all transports.
6-
- public child `LoggingServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `LoggingServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseLoggingServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `LoggingServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``LoggingServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``LoggingServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``LoggingServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseLoggingServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``LoggingServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging/google/cloud/logging_v2/services/metrics_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`MetricsServiceV2Transport` is the ABC for all transports.
6-
- public child `MetricsServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `MetricsServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseMetricsServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `MetricsServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``MetricsServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``MetricsServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``MetricsServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseMetricsServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``MetricsServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/config_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`ConfigServiceV2Transport` is the ABC for all transports.
6-
- public child `ConfigServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `ConfigServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseConfigServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `ConfigServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``ConfigServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``ConfigServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``ConfigServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseConfigServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``ConfigServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/logging_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`LoggingServiceV2Transport` is the ABC for all transports.
6-
- public child `LoggingServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `LoggingServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseLoggingServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `LoggingServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``LoggingServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``LoggingServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``LoggingServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseLoggingServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``LoggingServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

tests/integration/goldens/logging_internal/google/cloud/logging_v2/services/metrics_service_v2/transports/README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
transport inheritance structure
33
_______________________________
44

5-
`MetricsServiceV2Transport` is the ABC for all transports.
6-
- public child `MetricsServiceV2GrpcTransport` for sync gRPC transport (defined in `grpc.py`).
7-
- public child `MetricsServiceV2GrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`).
8-
- private child `_BaseMetricsServiceV2RestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`).
9-
- public child `MetricsServiceV2RestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`).
5+
``MetricsServiceV2Transport`` is the ABC for all transports.
6+
7+
- public child ``MetricsServiceV2GrpcTransport`` for sync gRPC transport (defined in ``grpc.py``).
8+
- public child ``MetricsServiceV2GrpcAsyncIOTransport`` for async gRPC transport (defined in ``grpc_asyncio.py``).
9+
- private child ``_BaseMetricsServiceV2RestTransport`` for base REST transport with inner classes ``_BaseMETHOD`` (defined in ``rest_base.py``).
10+
- public child ``MetricsServiceV2RestTransport`` for sync REST transport with inner classes ``METHOD`` derived from the parent's corresponding ``_BaseMETHOD`` classes (defined in ``rest.py``).

0 commit comments

Comments
 (0)