Skip to content

feat: note that "rest" transport support is beta. #1403

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

Merged
vchudnov-g merged 1 commit into from
Aug 12, 2022
Merged

feat: note that "rest" transport support is beta. #1403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions gapic/ads-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 @@ -233,6 +233,11 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
transport (Union[str, {{ service.name }}Transport]): The
transport to use. If set to None, a transport is chosen
automatically.
{% if 'rest' in opts.transport and not opts.rest_numeric_enums %}
NOTE: "rest" transport functionality is currently in a
beta state (preview). We welcome your feedback via an
issue in this library's source repository.
{% endif %}
client_options (google.api_core.client_options.ClientOptions): Custom options for the
client. It won't take effect if a ``transport`` instance is provided.
(1) The ``api_endpoint`` property can be used to override the
Expand Down
12 changes: 12 additions & 0 deletions gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/transports/rest.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ class {{service.name}}RestTransport({{service.name}}Transport):
and call it.

It sends JSON representations of protocol buffers over HTTP/1.1

{% if not opts.rest_numeric_enums %}
NOTE: This REST transport functionality is currently in a beta
state (preview). We welcome your feedback via an issue in this
library's source repository. Thank you!
{% endif %}
"""


Expand All @@ -147,6 +153,12 @@ class {{service.name}}RestTransport({{service.name}}Transport):
) -> None:
"""Instantiate the transport.

{% if not opts.rest_numeric_enums %}
NOTE: This REST transport functionality is currently in a beta
state (preview). We welcome your feedback via a GitHub issue in
this library's repository. Thank you!
{% endif %}

Args:
host ({% if service.host %}Optional[str]{% else %}str{% endif %}):
{{ ' ' }}The hostname to connect to.
Expand Down
5 changes: 5 additions & 0 deletions 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 @@ -290,6 +290,11 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
transport (Union[str, {{ service.name }}Transport]): The
transport to use. If set to None, a transport is chosen
automatically.
{% if 'rest' in opts.transport and not opts.rest_numeric_enums %}
NOTE: "rest" transport functionality is currently in a
beta state (preview). We welcome your feedback via an
issue in this library's source repository.
{% endif %}
client_options (google.api_core.client_options.ClientOptions): Custom options for the
client. It won't take effect if a ``transport`` instance is provided.
(1) The ``api_endpoint`` property can be used to override the
Expand Down
12 changes: 12 additions & 0 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/rest.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ class {{service.name}}RestTransport({{service.name}}Transport):
and call it.

It sends JSON representations of protocol buffers over HTTP/1.1

{% if not opts.rest_numeric_enums %}
NOTE: This REST transport functionality is currently in a beta
state (preview). We welcome your feedback via an issue in this
library's source repository. Thank you!
{% endif %}
"""


Expand All @@ -154,6 +160,12 @@ class {{service.name}}RestTransport({{service.name}}Transport):
) -> None:
"""Instantiate the transport.

{% if not opts.rest_numeric_enums %}
NOTE: This REST transport functionality is currently in a beta
state (preview). We welcome your feedback via a GitHub issue in
this library's repository. Thank you!
{% endif %}

Args:
host ({% if service.host %}Optional[str]{% else %}str{% endif %}):
{{ ' ' }}The hostname to connect to.
Expand Down