rest.py

# -*- coding: utf-8 -*-
# Copyright 2022 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.
#

import dataclasses
import json  # type: ignore
import re
from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
import warnings

from google.api_core import (
    gapic_v1,
    operations_v1,
    path_template,
    rest_helpers,
    rest_streaming,
)
from google.api_core import exceptions as core_exceptions
from google.api_core import retry as retries
from google.auth import credentials as ga_credentials  # type: ignore
from google.auth.transport.grpc import SslCredentials  # type: ignore
from google.auth.transport.requests import AuthorizedSession  # type: ignore
from google.protobuf import json_format
import grpc  # type: ignore
from requests import __version__ as requests_version

try:
    OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault]
except AttributeError:  # pragma: NO COVER
    OptionalRetry = Union[retries.Retry, object]  # type: ignore


from google.longrunning import operations_pb2  # type: ignore

from google.cloud.gaming_v1.types import realms

from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
from .base import RealmsServiceTransport

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
    gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version,
    grpc_version=None,
    rest_version=requests_version,
)


class RealmsServiceRestInterceptor:
    """Interceptor for RealmsService.

    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 RealmsServiceRestTransport.

    .. code-block:: python
        class MyCustomRealmsServiceInterceptor(RealmsServiceRestInterceptor):
            def pre_create_realm(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_create_realm(self, response):
                logging.log(f"Received response: {response}")
                return response

            def pre_delete_realm(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_delete_realm(self, response):
                logging.log(f"Received response: {response}")
                return response

            def pre_get_realm(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_get_realm(self, response):
                logging.log(f"Received response: {response}")
                return response

            def pre_list_realms(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_list_realms(self, response):
                logging.log(f"Received response: {response}")
                return response

            def pre_preview_realm_update(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_preview_realm_update(self, response):
                logging.log(f"Received response: {response}")
                return response

            def pre_update_realm(self, request, metadata):
                logging.log(f"Received request: {request}")
                return request, metadata

            def post_update_realm(self, response):
                logging.log(f"Received response: {response}")
                return response

        transport = RealmsServiceRestTransport(interceptor=MyCustomRealmsServiceInterceptor())
        client = RealmsServiceClient(transport=transport)


    """

    def pre_create_realm(
        self, request: realms.CreateRealmRequest, metadata: Sequence[Tuple[str, str]]
    ) -> Tuple[realms.CreateRealmRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for create_realm

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_create_realm(
        self, response: operations_pb2.Operation
    ) -> operations_pb2.Operation:
        """Post-rpc interceptor for create_realm

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response

    def pre_delete_realm(
        self, request: realms.DeleteRealmRequest, metadata: Sequence[Tuple[str, str]]
    ) -> Tuple[realms.DeleteRealmRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for delete_realm

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_delete_realm(
        self, response: operations_pb2.Operation
    ) -> operations_pb2.Operation:
        """Post-rpc interceptor for delete_realm

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response

    def pre_get_realm(
        self, request: realms.GetRealmRequest, metadata: Sequence[Tuple[str, str]]
    ) -> Tuple[realms.GetRealmRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for get_realm

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_get_realm(self, response: realms.Realm) -> realms.Realm:
        """Post-rpc interceptor for get_realm

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response

    def pre_list_realms(
        self, request: realms.ListRealmsRequest, metadata: Sequence[Tuple[str, str]]
    ) -> Tuple[realms.ListRealmsRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for list_realms

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_list_realms(
        self, response: realms.ListRealmsResponse
    ) -> realms.ListRealmsResponse:
        """Post-rpc interceptor for list_realms

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response

    def pre_preview_realm_update(
        self,
        request: realms.PreviewRealmUpdateRequest,
        metadata: Sequence[Tuple[str, str]],
    ) -> Tuple[realms.PreviewRealmUpdateRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for preview_realm_update

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_preview_realm_update(
        self, response: realms.PreviewRealmUpdateResponse
    ) -> realms.PreviewRealmUpdateResponse:
        """Post-rpc interceptor for preview_realm_update

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response

    def pre_update_realm(
        self, request: realms.UpdateRealmRequest, metadata: Sequence[Tuple[str, str]]
    ) -> Tuple[realms.UpdateRealmRequest, Sequence[Tuple[str, str]]]:
        """Pre-rpc interceptor for update_realm

        Override in a subclass to manipulate the request or metadata
        before they are sent to the RealmsService server.
        """
        return request, metadata

    def post_update_realm(
        self, response: operations_pb2.Operation
    ) -> operations_pb2.Operation:
        """Post-rpc interceptor for update_realm

        Override in a subclass to manipulate the response
        after it is returned by the RealmsService server but before
        it is returned to user code.
        """
        return response


@dataclasses.dataclass
class RealmsServiceRestStub:
    _session: AuthorizedSession
    _host: str
    _interceptor: RealmsServiceRestInterceptor


class RealmsServiceRestTransport(RealmsServiceTransport):
    """REST backend transport for RealmsService.

    A realm is a grouping of game server clusters that are
    considered interchangeable.

    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 = "gameservices.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[RealmsServiceRestInterceptor] = None,
        api_audience: Optional[str] = None,
    ) -> None:
        """Instantiate the transport.

        Args:
            host (Optional[str]):
                 The hostname to connect to.
            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("^(?P<scheme>http(?:s)?://)?(?P<host>.*)$", 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
        )
        self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None
        if client_cert_source_for_mtls:
            self._session.configure_mtls_channel(client_cert_source_for_mtls)
        self._interceptor = interceptor or RealmsServiceRestInterceptor()
        self._prep_wrapped_messages(client_info)

    @property
    def operations_client(self) -> operations_v1.AbstractOperationsClient:
        """Create the client designed to process long-running operations.

        This property caches on the instance; repeated calls return the same
        client.
        """
        # Only create a new client if we do not already have one.
        if self._operations_client is None:
            http_options: Dict[str, List[Dict[str, str]]] = {
                "google.longrunning.Operations.CancelOperation": [
                    {
                        "method": "post",
                        "uri": "/v1/{name=projects/*/locations/*/operations/*}:cancel",
                        "body": "*",
                    },
                ],
                "google.longrunning.Operations.DeleteOperation": [
                    {
                        "method": "delete",
                        "uri": "/v1/{name=projects/*/locations/*/operations/*}",
                    },
                ],
                "google.longrunning.Operations.GetOperation": [
                    {
                        "method": "get",
                        "uri": "/v1/{name=projects/*/locations/*/operations/*}",
                    },
                ],
                "google.longrunning.Operations.ListOperations": [
                    {
                        "method": "get",
                        "uri": "/v1/{name=projects/*/locations/*}/operations",
                    },
                ],
            }

            rest_transport = operations_v1.OperationsRestTransport(
                host=self._host,
                # use the credentials which are saved
                credentials=self._credentials,
                scopes=self._scopes,
                http_options=http_options,
                path_prefix="v1",
            )

            self._operations_client = operations_v1.AbstractOperationsClient(
                transport=rest_transport
            )

        # Return the client from cache.
        return self._operations_client

    class _CreateRealm(RealmsServiceRestStub):
        def __hash__(self):
            return hash("CreateRealm")

        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {
            "realmId": "",
        }

        @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: realms.CreateRealmRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> operations_pb2.Operation:
            r"""Call the create realm method over HTTP.

            Args:
                request (~.realms.CreateRealmRequest):
                    The request object. Request message for
                RealmsService.CreateRealm.
                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:
                ~.operations_pb2.Operation:
                    This resource represents a
                long-running operation that is the
                result of a network API call.

            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "post",
                    "uri": "/v1/{parent=projects/*/locations/*}/realms",
                    "body": "realm",
                },
            ]
            request, metadata = self._interceptor.pre_create_realm(request, metadata)
            pb_request = realms.CreateRealmRequest.pb(request)
            transcoded_request = path_template.transcode(http_options, pb_request)

            # Jsonify the request body

            body = json_format.MessageToJson(
                transcoded_request["body"],
                including_default_value_fields=False,
                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"],
                    including_default_value_fields=False,
                    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 = operations_pb2.Operation()
            json_format.Parse(response.content, resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_create_realm(resp)
            return resp

    class _DeleteRealm(RealmsServiceRestStub):
        def __hash__(self):
            return hash("DeleteRealm")

        __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: realms.DeleteRealmRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> operations_pb2.Operation:
            r"""Call the delete realm method over HTTP.

            Args:
                request (~.realms.DeleteRealmRequest):
                    The request object. Request message for
                RealmsService.DeleteRealm.
                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:
                ~.operations_pb2.Operation:
                    This resource represents a
                long-running operation that is the
                result of a network API call.

            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "delete",
                    "uri": "/v1/{name=projects/*/locations/*/realms/*}",
                },
            ]
            request, metadata = self._interceptor.pre_delete_realm(request, metadata)
            pb_request = realms.DeleteRealmRequest.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"],
                    including_default_value_fields=False,
                    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 = operations_pb2.Operation()
            json_format.Parse(response.content, resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_delete_realm(resp)
            return resp

    class _GetRealm(RealmsServiceRestStub):
        def __hash__(self):
            return hash("GetRealm")

        __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: realms.GetRealmRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> realms.Realm:
            r"""Call the get realm method over HTTP.

            Args:
                request (~.realms.GetRealmRequest):
                    The request object. Request message for
                RealmsService.GetRealm.
                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:
                ~.realms.Realm:
                    A realm resource.
            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "get",
                    "uri": "/v1/{name=projects/*/locations/*/realms/*}",
                },
            ]
            request, metadata = self._interceptor.pre_get_realm(request, metadata)
            pb_request = realms.GetRealmRequest.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"],
                    including_default_value_fields=False,
                    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 = realms.Realm()
            pb_resp = realms.Realm.pb(resp)

            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_get_realm(resp)
            return resp

    class _ListRealms(RealmsServiceRestStub):
        def __hash__(self):
            return hash("ListRealms")

        __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: realms.ListRealmsRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> realms.ListRealmsResponse:
            r"""Call the list realms method over HTTP.

            Args:
                request (~.realms.ListRealmsRequest):
                    The request object. Request message for
                RealmsService.ListRealms.
                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:
                ~.realms.ListRealmsResponse:
                    Response message for
                RealmsService.ListRealms.

            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "get",
                    "uri": "/v1/{parent=projects/*/locations/*}/realms",
                },
            ]
            request, metadata = self._interceptor.pre_list_realms(request, metadata)
            pb_request = realms.ListRealmsRequest.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"],
                    including_default_value_fields=False,
                    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 = realms.ListRealmsResponse()
            pb_resp = realms.ListRealmsResponse.pb(resp)

            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_list_realms(resp)
            return resp

    class _PreviewRealmUpdate(RealmsServiceRestStub):
        def __hash__(self):
            return hash("PreviewRealmUpdate")

        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {
            "updateMask": {},
        }

        @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: realms.PreviewRealmUpdateRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> realms.PreviewRealmUpdateResponse:
            r"""Call the preview realm update method over HTTP.

            Args:
                request (~.realms.PreviewRealmUpdateRequest):
                    The request object. Request message for
                RealmsService.PreviewRealmUpdate.
                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:
                ~.realms.PreviewRealmUpdateResponse:
                    Response message for
                RealmsService.PreviewRealmUpdate.

            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "patch",
                    "uri": "/v1/{realm.name=projects/*/locations/*/realms/*}:previewUpdate",
                    "body": "realm",
                },
            ]
            request, metadata = self._interceptor.pre_preview_realm_update(
                request, metadata
            )
            pb_request = realms.PreviewRealmUpdateRequest.pb(request)
            transcoded_request = path_template.transcode(http_options, pb_request)

            # Jsonify the request body

            body = json_format.MessageToJson(
                transcoded_request["body"],
                including_default_value_fields=False,
                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"],
                    including_default_value_fields=False,
                    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 = realms.PreviewRealmUpdateResponse()
            pb_resp = realms.PreviewRealmUpdateResponse.pb(resp)

            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_preview_realm_update(resp)
            return resp

    class _UpdateRealm(RealmsServiceRestStub):
        def __hash__(self):
            return hash("UpdateRealm")

        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {
            "updateMask": {},
        }

        @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: realms.UpdateRealmRequest,
            *,
            retry: OptionalRetry = gapic_v1.method.DEFAULT,
            timeout: Optional[float] = None,
            metadata: Sequence[Tuple[str, str]] = (),
        ) -> operations_pb2.Operation:
            r"""Call the update realm method over HTTP.

            Args:
                request (~.realms.UpdateRealmRequest):
                    The request object. Request message for
                RealmsService.UpdateRealm.
                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:
                ~.operations_pb2.Operation:
                    This resource represents a
                long-running operation that is the
                result of a network API call.

            """

            http_options: List[Dict[str, str]] = [
                {
                    "method": "patch",
                    "uri": "/v1/{realm.name=projects/*/locations/*/realms/*}",
                    "body": "realm",
                },
            ]
            request, metadata = self._interceptor.pre_update_realm(request, metadata)
            pb_request = realms.UpdateRealmRequest.pb(request)
            transcoded_request = path_template.transcode(http_options, pb_request)

            # Jsonify the request body

            body = json_format.MessageToJson(
                transcoded_request["body"],
                including_default_value_fields=False,
                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"],
                    including_default_value_fields=False,
                    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 = operations_pb2.Operation()
            json_format.Parse(response.content, resp, ignore_unknown_fields=True)
            resp = self._interceptor.post_update_realm(resp)
            return resp

    @property
    def create_realm(
        self,
    ) -> Callable[[realms.CreateRealmRequest], operations_pb2.Operation]:
        # 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._CreateRealm(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def delete_realm(
        self,
    ) -> Callable[[realms.DeleteRealmRequest], operations_pb2.Operation]:
        # 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._DeleteRealm(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def get_realm(self) -> Callable[[realms.GetRealmRequest], realms.Realm]:
        # 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._GetRealm(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def list_realms(
        self,
    ) -> Callable[[realms.ListRealmsRequest], realms.ListRealmsResponse]:
        # 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._ListRealms(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def preview_realm_update(
        self,
    ) -> Callable[
        [realms.PreviewRealmUpdateRequest], realms.PreviewRealmUpdateResponse
    ]:
        # 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._PreviewRealmUpdate(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def update_realm(
        self,
    ) -> Callable[[realms.UpdateRealmRequest], operations_pb2.Operation]:
        # 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._UpdateRealm(self._session, self._host, self._interceptor)  # type: ignore

    @property
    def kind(self) -> str:
        return "rest"

    def close(self):
        self._session.close()


__all__ = ("RealmsServiceRestTransport",)