Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# -*- coding: utf-8 -*-
2# Copyright 2025 Google LLC
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16import abc
17from typing import Awaitable, Callable, Dict, Optional, Sequence, Union
19from google.cloud.errorreporting_v1beta1 import gapic_version as package_version
21import google.auth # type: ignore
22import google.api_core
23from google.api_core import exceptions as core_exceptions
24from google.api_core import gapic_v1
25from google.api_core import retry as retries
26from google.auth import credentials as ga_credentials # type: ignore
27from google.oauth2 import service_account # type: ignore
28import google.protobuf
30from google.cloud.errorreporting_v1beta1.types import report_errors_service
32DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
33 gapic_version=package_version.__version__
34)
36if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
37 DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
40class ReportErrorsServiceTransport(abc.ABC):
41 """Abstract transport class for ReportErrorsService."""
43 AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",)
45 DEFAULT_HOST: str = "clouderrorreporting.googleapis.com"
47 def __init__(
48 self,
49 *,
50 host: str = DEFAULT_HOST,
51 credentials: Optional[ga_credentials.Credentials] = None,
52 credentials_file: Optional[str] = None,
53 scopes: Optional[Sequence[str]] = None,
54 quota_project_id: Optional[str] = None,
55 client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
56 always_use_jwt_access: Optional[bool] = False,
57 api_audience: Optional[str] = None,
58 **kwargs,
59 ) -> None:
60 """Instantiate the transport.
62 Args:
63 host (Optional[str]):
64 The hostname to connect to (default: 'clouderrorreporting.googleapis.com').
65 credentials (Optional[google.auth.credentials.Credentials]): The
66 authorization credentials to attach to requests. These
67 credentials identify the application to the service; if none
68 are specified, the client will attempt to ascertain the
69 credentials from the environment.
70 credentials_file (Optional[str]): Deprecated. A file with credentials that can
71 be loaded with :func:`google.auth.load_credentials_from_file`.
72 This argument is mutually exclusive with credentials. This argument will be
73 removed in the next major version of this library.
74 scopes (Optional[Sequence[str]]): A list of scopes.
75 quota_project_id (Optional[str]): An optional project to use for billing
76 and quota.
77 client_info (google.api_core.gapic_v1.client_info.ClientInfo):
78 The client info used to send a user-agent string along with
79 API requests. If ``None``, then default info will be used.
80 Generally, you only need to set this if you're developing
81 your own client library.
82 always_use_jwt_access (Optional[bool]): Whether self signed JWT should
83 be used for service account credentials.
84 """
86 scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES}
88 # Save the scopes.
89 self._scopes = scopes
90 if not hasattr(self, "_ignore_credentials"):
91 self._ignore_credentials: bool = False
93 # If no credentials are provided, then determine the appropriate
94 # defaults.
95 if credentials and credentials_file:
96 raise core_exceptions.DuplicateCredentialArgs(
97 "'credentials_file' and 'credentials' are mutually exclusive"
98 )
100 if credentials_file is not None:
101 credentials, _ = google.auth.load_credentials_from_file(
102 credentials_file, **scopes_kwargs, quota_project_id=quota_project_id
103 )
104 elif credentials is None and not self._ignore_credentials:
105 credentials, _ = google.auth.default(
106 **scopes_kwargs, quota_project_id=quota_project_id
107 )
108 # Don't apply audience if the credentials file passed from user.
109 if hasattr(credentials, "with_gdch_audience"):
110 credentials = credentials.with_gdch_audience(
111 api_audience if api_audience else host
112 )
114 # If the credentials are service account credentials, then always try to use self signed JWT.
115 if (
116 always_use_jwt_access
117 and isinstance(credentials, service_account.Credentials)
118 and hasattr(service_account.Credentials, "with_always_use_jwt_access")
119 ):
120 credentials = credentials.with_always_use_jwt_access(True)
122 # Save the credentials.
123 self._credentials = credentials
125 # Save the hostname. Default to port 443 (HTTPS) if none is specified.
126 if ":" not in host:
127 host += ":443"
128 self._host = host
130 @property
131 def host(self):
132 return self._host
134 def _prep_wrapped_messages(self, client_info):
135 # Precompute the wrapped methods.
136 self._wrapped_methods = {
137 self.report_error_event: gapic_v1.method.wrap_method(
138 self.report_error_event,
139 default_timeout=None,
140 client_info=client_info,
141 ),
142 }
144 def close(self):
145 """Closes resources associated with the transport.
147 .. warning::
148 Only call this method if the transport is NOT shared
149 with other clients - this may cause errors in other clients!
150 """
151 raise NotImplementedError()
153 @property
154 def report_error_event(
155 self,
156 ) -> Callable[
157 [report_errors_service.ReportErrorEventRequest],
158 Union[
159 report_errors_service.ReportErrorEventResponse,
160 Awaitable[report_errors_service.ReportErrorEventResponse],
161 ],
162 ]:
163 raise NotImplementedError()
165 @property
166 def kind(self) -> str:
167 raise NotImplementedError()
170__all__ = ("ReportErrorsServiceTransport",)