Skip to content

fix: include version headers in long running operations #19059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daniel-sanche wants to merge 6 commits into from
+276 −3
Open

fix: include version headers in long running operations #19059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7fd029d
fix: include headers in lro operations
daniel-sanche Nov 12, 2026
47ef50c
revert changes in ads templates
daniel-sanche Nov 12, 2026
3bc2f98
removed conditional check
daniel-sanche Nov 13, 2026
56d2959
removed unneeded test
daniel-sanche Nov 13, 2026
f972b93
revert version check change
daniel-sanche Nov 13, 2026
15f6de0
Merge branch 'main' into google-cloud-python-internal_gapic-generator…
daniel-sanche Nov 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...ator/gapic/templates/%namespace/%name_%version/%sub/services/%service/_async_mixins.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -101,6 +102,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -160,6 +162,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -214,6 +217,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -271,6 +275,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -397,6 +402,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -519,6 +525,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -579,6 +586,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -638,6 +646,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -693,6 +702,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down
8 changes: 8 additions & 0 deletions ...erator/gapic/templates/%namespace/%name_%version/%sub/services/%service/_client_macros.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,21 @@
{% endif %}
)
{% if method.lro %}
{% if service.version %}
lro_metadata = None
if HAS_GOOGLE_API_CORE_VERSION_HEADER: # pragma: NO COVER
lro_metadata = [version_header.to_api_version_header("{{ service.version }}")]
{% endif %}

# Wrap the response in an operation future.
response = {{ method.client_output.ident.module_alias or method.client_output.ident.module }}.from_gapic(
response,
self._transport.operations_client,
{{ method.lro.response_type.ident }},
metadata_type={{ method.lro.metadata_type.ident }},
{% if service.version %}
grpc_metadata=lro_metadata,
{% endif %}
)
{% elif method.paged_result_field %}

Expand Down
10 changes: 10 additions & 0 deletions ...-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/_mixins.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -103,6 +104,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -166,6 +168,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -220,6 +223,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -277,6 +281,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -407,6 +412,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -533,6 +539,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -597,6 +604,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -660,6 +668,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -719,6 +728,7 @@
gapic_v1.routing_header.to_grpc_metadata(
(("name", request_pb.name),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down
11 changes: 11 additions & 0 deletions ...rator/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,13 +430,21 @@ class {{ service.async_client_name }}:
{% endif %}
)
{% if method.lro %}
{% if service.version %}
lro_metadata = None
if HAS_GOOGLE_API_CORE_VERSION_HEADER: # pragma: NO COVER
lro_metadata = [version_header.to_api_version_header("{{ service.version }}")]
{% endif %}

# Wrap the response in an operation future.
response = {{ method.client_output_async.ident.module_alias or method.client_output_async.ident.module }}.from_gapic(
response,
self._client._transport.operations_client,
{{ method.lro.response_type.ident }},
metadata_type={{ method.lro.metadata_type.ident }},
{% if service.version %}
grpc_metadata=lro_metadata,
{% endif %}
)
{% elif method.paged_result_field %}

Expand Down Expand Up @@ -569,6 +577,7 @@ class {{ service.async_client_name }}:
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -687,6 +696,7 @@ class {{ service.async_client_name }}:
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -743,6 +753,7 @@ class {{ service.async_client_name }}:
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down
3 changes: 3 additions & 0 deletions ...c-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -849,6 +850,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down Expand Up @@ -915,6 +917,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request_pb.resource),)),
)
{{ shared_macros.add_api_version_header_to_metadata(service.version) }}

# Validate the universe domain.
self._validate_universe_domain()
Expand Down
Loading
Loading