# -*- coding: utf-8 -*- # Copyright 2024 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # from google.auth.transport.requests import AuthorizedSession # type: ignore import json # type: ignore import grpc # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.api_core import exceptions as core_exceptions from google.api_core import retry as retries from google.api_core import rest_helpers from google.api_core import rest_streaming from google.api_core import path_template from google.api_core import gapic_v1 from google.protobuf import json_format from google.iam.v1 import iam_policy_pb2 # type: ignore from google.iam.v1 import policy_pb2 # type: ignore from requests import __version__ as requests_version import dataclasses import re from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union import warnings try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.Retry, object, None] # type: ignore from google.iam.v1 import iam_policy_pb2 # type: ignore from google.iam.v1 import policy_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore from google.pubsub_v1.types import pubsub from .base import SubscriberTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, grpc_version=None, rest_version=requests_version, ) class SubscriberRestInterceptor: """Interceptor for Subscriber. Interceptors are used to manipulate requests, request metadata, and responses in arbitrary ways. Example use cases include: * Logging * Verifying requests according to service or custom semantics * Stripping extraneous information from responses These use cases and more can be enabled by injecting an instance of a custom subclass when constructing the SubscriberRestTransport. .. code-block:: python class MyCustomSubscriberInterceptor(SubscriberRestInterceptor): def pre_acknowledge(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def pre_create_snapshot(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_create_snapshot(self, response): logging.log(f"Received response: {response}") return response def pre_create_subscription(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_create_subscription(self, response): logging.log(f"Received response: {response}") return response def pre_delete_snapshot(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def pre_delete_subscription(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def pre_get_snapshot(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_get_snapshot(self, response): logging.log(f"Received response: {response}") return response def pre_get_subscription(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_get_subscription(self, response): logging.log(f"Received response: {response}") return response def pre_list_snapshots(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_list_snapshots(self, response): logging.log(f"Received response: {response}") return response def pre_list_subscriptions(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_list_subscriptions(self, response): logging.log(f"Received response: {response}") return response def pre_modify_ack_deadline(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def pre_modify_push_config(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def pre_pull(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_pull(self, response): logging.log(f"Received response: {response}") return response def pre_seek(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_seek(self, response): logging.log(f"Received response: {response}") return response def pre_update_snapshot(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_update_snapshot(self, response): logging.log(f"Received response: {response}") return response def pre_update_subscription(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_update_subscription(self, response): logging.log(f"Received response: {response}") return response transport = SubscriberRestTransport(interceptor=MyCustomSubscriberInterceptor()) client = SubscriberClient(transport=transport) """ def pre_acknowledge( self, request: pubsub.AcknowledgeRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.AcknowledgeRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for acknowledge Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def pre_create_snapshot( self, request: pubsub.CreateSnapshotRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.CreateSnapshotRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for create_snapshot Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_create_snapshot(self, response: pubsub.Snapshot) -> pubsub.Snapshot: """Post-rpc interceptor for create_snapshot Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_create_subscription( self, request: pubsub.Subscription, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.Subscription, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for create_subscription Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_create_subscription( self, response: pubsub.Subscription ) -> pubsub.Subscription: """Post-rpc interceptor for create_subscription Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_delete_snapshot( self, request: pubsub.DeleteSnapshotRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.DeleteSnapshotRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for delete_snapshot Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def pre_delete_subscription( self, request: pubsub.DeleteSubscriptionRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.DeleteSubscriptionRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for delete_subscription Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def pre_get_snapshot( self, request: pubsub.GetSnapshotRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.GetSnapshotRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for get_snapshot Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_get_snapshot(self, response: pubsub.Snapshot) -> pubsub.Snapshot: """Post-rpc interceptor for get_snapshot Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_get_subscription( self, request: pubsub.GetSubscriptionRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.GetSubscriptionRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for get_subscription Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_get_subscription( self, response: pubsub.Subscription ) -> pubsub.Subscription: """Post-rpc interceptor for get_subscription Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_list_snapshots( self, request: pubsub.ListSnapshotsRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.ListSnapshotsRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for list_snapshots Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_list_snapshots( self, response: pubsub.ListSnapshotsResponse ) -> pubsub.ListSnapshotsResponse: """Post-rpc interceptor for list_snapshots Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_list_subscriptions( self, request: pubsub.ListSubscriptionsRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.ListSubscriptionsRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for list_subscriptions Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_list_subscriptions( self, response: pubsub.ListSubscriptionsResponse ) -> pubsub.ListSubscriptionsResponse: """Post-rpc interceptor for list_subscriptions Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_modify_ack_deadline( self, request: pubsub.ModifyAckDeadlineRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.ModifyAckDeadlineRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for modify_ack_deadline Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def pre_modify_push_config( self, request: pubsub.ModifyPushConfigRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.ModifyPushConfigRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for modify_push_config Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def pre_pull( self, request: pubsub.PullRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.PullRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for pull Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_pull(self, response: pubsub.PullResponse) -> pubsub.PullResponse: """Post-rpc interceptor for pull Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_seek( self, request: pubsub.SeekRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.SeekRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for seek Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_seek(self, response: pubsub.SeekResponse) -> pubsub.SeekResponse: """Post-rpc interceptor for seek Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_update_snapshot( self, request: pubsub.UpdateSnapshotRequest, metadata: Sequence[Tuple[str, str]] ) -> Tuple[pubsub.UpdateSnapshotRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for update_snapshot Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_update_snapshot(self, response: pubsub.Snapshot) -> pubsub.Snapshot: """Post-rpc interceptor for update_snapshot Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_update_subscription( self, request: pubsub.UpdateSubscriptionRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[pubsub.UpdateSubscriptionRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for update_subscription Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_update_subscription( self, response: pubsub.Subscription ) -> pubsub.Subscription: """Post-rpc interceptor for update_subscription Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_get_iam_policy( self, request: iam_policy_pb2.GetIamPolicyRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[iam_policy_pb2.GetIamPolicyRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for get_iam_policy Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_get_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: """Post-rpc interceptor for get_iam_policy Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_set_iam_policy( self, request: iam_policy_pb2.SetIamPolicyRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[iam_policy_pb2.SetIamPolicyRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for set_iam_policy Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_set_iam_policy(self, response: policy_pb2.Policy) -> policy_pb2.Policy: """Post-rpc interceptor for set_iam_policy Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response def pre_test_iam_permissions( self, request: iam_policy_pb2.TestIamPermissionsRequest, metadata: Sequence[Tuple[str, str]], ) -> Tuple[iam_policy_pb2.TestIamPermissionsRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for test_iam_permissions Override in a subclass to manipulate the request or metadata before they are sent to the Subscriber server. """ return request, metadata def post_test_iam_permissions( self, response: iam_policy_pb2.TestIamPermissionsResponse ) -> iam_policy_pb2.TestIamPermissionsResponse: """Post-rpc interceptor for test_iam_permissions Override in a subclass to manipulate the response after it is returned by the Subscriber server but before it is returned to user code. """ return response @dataclasses.dataclass class SubscriberRestStub: _session: AuthorizedSession _host: str _interceptor: SubscriberRestInterceptor class SubscriberRestTransport(SubscriberTransport): """REST backend transport for Subscriber. The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the ``Pull`` method or by establishing a bi-directional stream using the ``StreamingPull`` method. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation and call it. It sends JSON representations of protocol buffers over HTTP/1.1 """ def __init__( self, *, host: str = "pubsub.googleapis.com", credentials: Optional[ga_credentials.Credentials] = None, credentials_file: Optional[str] = None, scopes: Optional[Sequence[str]] = None, client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, quota_project_id: Optional[str] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, always_use_jwt_access: Optional[bool] = False, url_scheme: str = "https", interceptor: Optional[SubscriberRestInterceptor] = None, api_audience: Optional[str] = None, ) -> None: """Instantiate the transport. Args: host (Optional[str]): The hostname to connect to (default: 'pubsub.googleapis.com'). credentials (Optional[google.auth.credentials.Credentials]): The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. credentials_file (Optional[str]): A file with credentials that can be loaded with :func:`google.auth.load_credentials_from_file`. This argument is ignored if ``channel`` is provided. scopes (Optional(Sequence[str])): A list of scopes. This argument is ignored if ``channel`` is provided. client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client certificate to configure mutual TLS HTTP channel. It is ignored if ``channel`` is provided. quota_project_id (Optional[str]): An optional project to use for billing and quota. client_info (google.api_core.gapic_v1.client_info.ClientInfo): The client info used to send a user-agent string along with API requests. If ``None``, then default info will be used. Generally, you only need to set this if you are developing your own client library. always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. url_scheme: the protocol scheme for the API endpoint. Normally "https", but for testing or local servers, "http" can be specified. """ # Run the base constructor # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the # credentials object maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) if maybe_url_match is None: raise ValueError( f"Unexpected hostname structure: {host}" ) # pragma: NO COVER url_match_items = maybe_url_match.groupdict() host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host super().__init__( host=host, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, api_audience=api_audience, ) self._session = AuthorizedSession( self._credentials, default_host=self.DEFAULT_HOST ) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or SubscriberRestInterceptor() self._prep_wrapped_messages(client_info) class _Acknowledge(SubscriberRestStub): def __hash__(self): return hash("Acknowledge") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.AcknowledgeRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ): r"""Call the acknowledge method over HTTP. Args: request (~.pubsub.AcknowledgeRequest): The request object. Request for the Acknowledge method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{subscription=projects/*/subscriptions/*}:acknowledge", "body": "*", }, ] request, metadata = self._interceptor.pre_acknowledge(request, metadata) pb_request = pubsub.AcknowledgeRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) class _CreateSnapshot(SubscriberRestStub): def __hash__(self): return hash("CreateSnapshot") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.CreateSnapshotRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Snapshot: r"""Call the create snapshot method over HTTP. Args: request (~.pubsub.CreateSnapshotRequest): The request object. Request for the ``CreateSnapshot`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Snapshot: A snapshot resource. Snapshots are used in `Seek `__ operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. """ http_options: List[Dict[str, str]] = [ { "method": "put", "uri": "/v1/{name=projects/*/snapshots/*}", "body": "*", }, ] request, metadata = self._interceptor.pre_create_snapshot(request, metadata) pb_request = pubsub.CreateSnapshotRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Snapshot() pb_resp = pubsub.Snapshot.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_create_snapshot(resp) return resp class _CreateSubscription(SubscriberRestStub): def __hash__(self): return hash("CreateSubscription") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.Subscription, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Subscription: r"""Call the create subscription method over HTTP. Args: request (~.pubsub.Subscription): The request object. A subscription resource. If none of ``push_config``, ``bigquery_config``, or ``cloud_storage_config`` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Subscription: A subscription resource. If none of ``push_config``, ``bigquery_config``, or ``cloud_storage_config`` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. """ http_options: List[Dict[str, str]] = [ { "method": "put", "uri": "/v1/{name=projects/*/subscriptions/*}", "body": "*", }, ] request, metadata = self._interceptor.pre_create_subscription( request, metadata ) pb_request = pubsub.Subscription.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Subscription() pb_resp = pubsub.Subscription.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_create_subscription(resp) return resp class _DeleteSnapshot(SubscriberRestStub): def __hash__(self): return hash("DeleteSnapshot") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.DeleteSnapshotRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ): r"""Call the delete snapshot method over HTTP. Args: request (~.pubsub.DeleteSnapshotRequest): The request object. Request for the ``DeleteSnapshot`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ http_options: List[Dict[str, str]] = [ { "method": "delete", "uri": "/v1/{snapshot=projects/*/snapshots/*}", }, ] request, metadata = self._interceptor.pre_delete_snapshot(request, metadata) pb_request = pubsub.DeleteSnapshotRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) class _DeleteSubscription(SubscriberRestStub): def __hash__(self): return hash("DeleteSubscription") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.DeleteSubscriptionRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ): r"""Call the delete subscription method over HTTP. Args: request (~.pubsub.DeleteSubscriptionRequest): The request object. Request for the DeleteSubscription method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ http_options: List[Dict[str, str]] = [ { "method": "delete", "uri": "/v1/{subscription=projects/*/subscriptions/*}", }, ] request, metadata = self._interceptor.pre_delete_subscription( request, metadata ) pb_request = pubsub.DeleteSubscriptionRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) class _GetSnapshot(SubscriberRestStub): def __hash__(self): return hash("GetSnapshot") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.GetSnapshotRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Snapshot: r"""Call the get snapshot method over HTTP. Args: request (~.pubsub.GetSnapshotRequest): The request object. Request for the GetSnapshot method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Snapshot: A snapshot resource. Snapshots are used in `Seek `__ operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. """ http_options: List[Dict[str, str]] = [ { "method": "get", "uri": "/v1/{snapshot=projects/*/snapshots/*}", }, ] request, metadata = self._interceptor.pre_get_snapshot(request, metadata) pb_request = pubsub.GetSnapshotRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Snapshot() pb_resp = pubsub.Snapshot.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_get_snapshot(resp) return resp class _GetSubscription(SubscriberRestStub): def __hash__(self): return hash("GetSubscription") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.GetSubscriptionRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Subscription: r"""Call the get subscription method over HTTP. Args: request (~.pubsub.GetSubscriptionRequest): The request object. Request for the GetSubscription method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Subscription: A subscription resource. If none of ``push_config``, ``bigquery_config``, or ``cloud_storage_config`` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. """ http_options: List[Dict[str, str]] = [ { "method": "get", "uri": "/v1/{subscription=projects/*/subscriptions/*}", }, ] request, metadata = self._interceptor.pre_get_subscription( request, metadata ) pb_request = pubsub.GetSubscriptionRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Subscription() pb_resp = pubsub.Subscription.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_get_subscription(resp) return resp class _ListSnapshots(SubscriberRestStub): def __hash__(self): return hash("ListSnapshots") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.ListSnapshotsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.ListSnapshotsResponse: r"""Call the list snapshots method over HTTP. Args: request (~.pubsub.ListSnapshotsRequest): The request object. Request for the ``ListSnapshots`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.ListSnapshotsResponse: Response for the ``ListSnapshots`` method. """ http_options: List[Dict[str, str]] = [ { "method": "get", "uri": "/v1/{project=projects/*}/snapshots", }, ] request, metadata = self._interceptor.pre_list_snapshots(request, metadata) pb_request = pubsub.ListSnapshotsRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.ListSnapshotsResponse() pb_resp = pubsub.ListSnapshotsResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_list_snapshots(resp) return resp class _ListSubscriptions(SubscriberRestStub): def __hash__(self): return hash("ListSubscriptions") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.ListSubscriptionsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.ListSubscriptionsResponse: r"""Call the list subscriptions method over HTTP. Args: request (~.pubsub.ListSubscriptionsRequest): The request object. Request for the ``ListSubscriptions`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.ListSubscriptionsResponse: Response for the ``ListSubscriptions`` method. """ http_options: List[Dict[str, str]] = [ { "method": "get", "uri": "/v1/{project=projects/*}/subscriptions", }, ] request, metadata = self._interceptor.pre_list_subscriptions( request, metadata ) pb_request = pubsub.ListSubscriptionsRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.ListSubscriptionsResponse() pb_resp = pubsub.ListSubscriptionsResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_list_subscriptions(resp) return resp class _ModifyAckDeadline(SubscriberRestStub): def __hash__(self): return hash("ModifyAckDeadline") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.ModifyAckDeadlineRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ): r"""Call the modify ack deadline method over HTTP. Args: request (~.pubsub.ModifyAckDeadlineRequest): The request object. Request for the ModifyAckDeadline method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{subscription=projects/*/subscriptions/*}:modifyAckDeadline", "body": "*", }, ] request, metadata = self._interceptor.pre_modify_ack_deadline( request, metadata ) pb_request = pubsub.ModifyAckDeadlineRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) class _ModifyPushConfig(SubscriberRestStub): def __hash__(self): return hash("ModifyPushConfig") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.ModifyPushConfigRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ): r"""Call the modify push config method over HTTP. Args: request (~.pubsub.ModifyPushConfigRequest): The request object. Request for the ModifyPushConfig method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{subscription=projects/*/subscriptions/*}:modifyPushConfig", "body": "*", }, ] request, metadata = self._interceptor.pre_modify_push_config( request, metadata ) pb_request = pubsub.ModifyPushConfigRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) class _Pull(SubscriberRestStub): def __hash__(self): return hash("Pull") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.PullRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.PullResponse: r"""Call the pull method over HTTP. Args: request (~.pubsub.PullRequest): The request object. Request for the ``Pull`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.PullResponse: Response for the ``Pull`` method. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{subscription=projects/*/subscriptions/*}:pull", "body": "*", }, ] request, metadata = self._interceptor.pre_pull(request, metadata) pb_request = pubsub.PullRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.PullResponse() pb_resp = pubsub.PullResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_pull(resp) return resp class _Seek(SubscriberRestStub): def __hash__(self): return hash("Seek") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.SeekRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.SeekResponse: r"""Call the seek method over HTTP. Args: request (~.pubsub.SeekRequest): The request object. Request for the ``Seek`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.SeekResponse: Response for the ``Seek`` method (this response is empty). """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{subscription=projects/*/subscriptions/*}:seek", "body": "*", }, ] request, metadata = self._interceptor.pre_seek(request, metadata) pb_request = pubsub.SeekRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.SeekResponse() pb_resp = pubsub.SeekResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_seek(resp) return resp class _StreamingPull(SubscriberRestStub): def __hash__(self): return hash("StreamingPull") def __call__( self, request: pubsub.StreamingPullRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> rest_streaming.ResponseIterator: raise NotImplementedError( "Method StreamingPull is not available over REST transport" ) class _UpdateSnapshot(SubscriberRestStub): def __hash__(self): return hash("UpdateSnapshot") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.UpdateSnapshotRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Snapshot: r"""Call the update snapshot method over HTTP. Args: request (~.pubsub.UpdateSnapshotRequest): The request object. Request for the UpdateSnapshot method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Snapshot: A snapshot resource. Snapshots are used in `Seek `__ operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. """ http_options: List[Dict[str, str]] = [ { "method": "patch", "uri": "/v1/{snapshot.name=projects/*/snapshots/*}", "body": "*", }, ] request, metadata = self._interceptor.pre_update_snapshot(request, metadata) pb_request = pubsub.UpdateSnapshotRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Snapshot() pb_resp = pubsub.Snapshot.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_update_snapshot(resp) return resp class _UpdateSubscription(SubscriberRestStub): def __hash__(self): return hash("UpdateSubscription") __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): return { k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict } def __call__( self, request: pubsub.UpdateSubscriptionRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.Subscription: r"""Call the update subscription method over HTTP. Args: request (~.pubsub.UpdateSubscriptionRequest): The request object. Request for the UpdateSubscription method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: ~.pubsub.Subscription: A subscription resource. If none of ``push_config``, ``bigquery_config``, or ``cloud_storage_config`` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. """ http_options: List[Dict[str, str]] = [ { "method": "patch", "uri": "/v1/{subscription.name=projects/*/subscriptions/*}", "body": "*", }, ] request, metadata = self._interceptor.pre_update_subscription( request, metadata ) pb_request = pubsub.UpdateSubscriptionRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( transcoded_request["body"], use_integers_for_enums=True ) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads( json_format.MessageToJson( transcoded_request["query_params"], use_integers_for_enums=True, ) ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = pubsub.Subscription() pb_resp = pubsub.Subscription.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_update_subscription(resp) return resp @property def acknowledge(self) -> Callable[[pubsub.AcknowledgeRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._Acknowledge(self._session, self._host, self._interceptor) # type: ignore @property def create_snapshot( self, ) -> Callable[[pubsub.CreateSnapshotRequest], pubsub.Snapshot]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._CreateSnapshot(self._session, self._host, self._interceptor) # type: ignore @property def create_subscription( self, ) -> Callable[[pubsub.Subscription], pubsub.Subscription]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._CreateSubscription(self._session, self._host, self._interceptor) # type: ignore @property def delete_snapshot( self, ) -> Callable[[pubsub.DeleteSnapshotRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._DeleteSnapshot(self._session, self._host, self._interceptor) # type: ignore @property def delete_subscription( self, ) -> Callable[[pubsub.DeleteSubscriptionRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._DeleteSubscription(self._session, self._host, self._interceptor) # type: ignore @property def get_snapshot(self) -> Callable[[pubsub.GetSnapshotRequest], pubsub.Snapshot]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._GetSnapshot(self._session, self._host, self._interceptor) # type: ignore @property def get_subscription( self, ) -> Callable[[pubsub.GetSubscriptionRequest], pubsub.Subscription]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._GetSubscription(self._session, self._host, self._interceptor) # type: ignore @property def list_snapshots( self, ) -> Callable[[pubsub.ListSnapshotsRequest], pubsub.ListSnapshotsResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._ListSnapshots(self._session, self._host, self._interceptor) # type: ignore @property def list_subscriptions( self, ) -> Callable[[pubsub.ListSubscriptionsRequest], pubsub.ListSubscriptionsResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._ListSubscriptions(self._session, self._host, self._interceptor) # type: ignore @property def modify_ack_deadline( self, ) -> Callable[[pubsub.ModifyAckDeadlineRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._ModifyAckDeadline(self._session, self._host, self._interceptor) # type: ignore @property def modify_push_config( self, ) -> Callable[[pubsub.ModifyPushConfigRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._ModifyPushConfig(self._session, self._host, self._interceptor) # type: ignore @property def pull(self) -> Callable[[pubsub.PullRequest], pubsub.PullResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._Pull(self._session, self._host, self._interceptor) # type: ignore @property def seek(self) -> Callable[[pubsub.SeekRequest], pubsub.SeekResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._Seek(self._session, self._host, self._interceptor) # type: ignore @property def streaming_pull( self, ) -> Callable[[pubsub.StreamingPullRequest], pubsub.StreamingPullResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._StreamingPull(self._session, self._host, self._interceptor) # type: ignore @property def update_snapshot( self, ) -> Callable[[pubsub.UpdateSnapshotRequest], pubsub.Snapshot]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._UpdateSnapshot(self._session, self._host, self._interceptor) # type: ignore @property def update_subscription( self, ) -> Callable[[pubsub.UpdateSubscriptionRequest], pubsub.Subscription]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._UpdateSubscription(self._session, self._host, self._interceptor) # type: ignore @property def get_iam_policy(self): return self._GetIamPolicy(self._session, self._host, self._interceptor) # type: ignore class _GetIamPolicy(SubscriberRestStub): def __call__( self, request: iam_policy_pb2.GetIamPolicyRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> policy_pb2.Policy: r"""Call the get iam policy method over HTTP. Args: request (iam_policy_pb2.GetIamPolicyRequest): The request object for GetIamPolicy method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: policy_pb2.Policy: Response from GetIamPolicy method. """ http_options: List[Dict[str, str]] = [ { "method": "get", "uri": "/v1/{resource=projects/*/topics/*}:getIamPolicy", }, { "method": "get", "uri": "/v1/{resource=projects/*/subscriptions/*}:getIamPolicy", }, { "method": "get", "uri": "/v1/{resource=projects/*/snapshots/*}:getIamPolicy", }, { "method": "get", "uri": "/v1/{resource=projects/*/schemas/*}:getIamPolicy", }, ] request, metadata = self._interceptor.pre_get_iam_policy(request, metadata) request_kwargs = json_format.MessageToDict(request) transcoded_request = path_template.transcode(http_options, **request_kwargs) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads(json.dumps(transcoded_request["query_params"])) # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params), ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) resp = policy_pb2.Policy() resp = json_format.Parse(response.content.decode("utf-8"), resp) resp = self._interceptor.post_get_iam_policy(resp) return resp @property def set_iam_policy(self): return self._SetIamPolicy(self._session, self._host, self._interceptor) # type: ignore class _SetIamPolicy(SubscriberRestStub): def __call__( self, request: iam_policy_pb2.SetIamPolicyRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> policy_pb2.Policy: r"""Call the set iam policy method over HTTP. Args: request (iam_policy_pb2.SetIamPolicyRequest): The request object for SetIamPolicy method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: policy_pb2.Policy: Response from SetIamPolicy method. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{resource=projects/*/topics/*}:setIamPolicy", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/subscriptions/*}:setIamPolicy", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/snapshots/*}:setIamPolicy", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/schemas/*}:setIamPolicy", "body": "*", }, ] request, metadata = self._interceptor.pre_set_iam_policy(request, metadata) request_kwargs = json_format.MessageToDict(request) transcoded_request = path_template.transcode(http_options, **request_kwargs) body = json.dumps(transcoded_request["body"]) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads(json.dumps(transcoded_request["query_params"])) # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) resp = policy_pb2.Policy() resp = json_format.Parse(response.content.decode("utf-8"), resp) resp = self._interceptor.post_set_iam_policy(resp) return resp @property def test_iam_permissions(self): return self._TestIamPermissions(self._session, self._host, self._interceptor) # type: ignore class _TestIamPermissions(SubscriberRestStub): def __call__( self, request: iam_policy_pb2.TestIamPermissionsRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = (), ) -> iam_policy_pb2.TestIamPermissionsResponse: r"""Call the test iam permissions method over HTTP. Args: request (iam_policy_pb2.TestIamPermissionsRequest): The request object for TestIamPermissions method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. Returns: iam_policy_pb2.TestIamPermissionsResponse: Response from TestIamPermissions method. """ http_options: List[Dict[str, str]] = [ { "method": "post", "uri": "/v1/{resource=projects/*/subscriptions/*}:testIamPermissions", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/topics/*}:testIamPermissions", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/snapshots/*}:testIamPermissions", "body": "*", }, { "method": "post", "uri": "/v1/{resource=projects/*/schemas/*}:testIamPermissions", "body": "*", }, ] request, metadata = self._interceptor.pre_test_iam_permissions( request, metadata ) request_kwargs = json_format.MessageToDict(request) transcoded_request = path_template.transcode(http_options, **request_kwargs) body = json.dumps(transcoded_request["body"]) uri = transcoded_request["uri"] method = transcoded_request["method"] # Jsonify the query params query_params = json.loads(json.dumps(transcoded_request["query_params"])) # Send the request headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params), data=body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) resp = iam_policy_pb2.TestIamPermissionsResponse() resp = json_format.Parse(response.content.decode("utf-8"), resp) resp = self._interceptor.post_test_iam_permissions(resp) return resp @property def kind(self) -> str: return "rest" def close(self): self._session.close() __all__ = ("SubscriberRestTransport",)