This repository has been archived by the owner on Jul 6, 2023. It is now read-only.
/
async_client.py
315 lines (267 loc) · 12.8 KB
/
async_client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# -*- coding: utf-8 -*-
# Copyright 2020 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 collections import OrderedDict
import functools
import re
from typing import Dict, Sequence, Tuple, Type, Union
import pkg_resources
from google.api_core.client_options import ClientOptions # type: ignore
from google.api_core import exceptions as core_exceptions # type: ignore
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.oauth2 import service_account # type: ignore
OptionalRetry = Union[retries.Retry, object]
from google.cloud.servicecontrol_v1.types import check_error
from google.cloud.servicecontrol_v1.types import service_controller
from .transports.base import ServiceControllerTransport, DEFAULT_CLIENT_INFO
from .transports.grpc_asyncio import ServiceControllerGrpcAsyncIOTransport
from .client import ServiceControllerClient
class ServiceControllerAsyncClient:
"""`Google Service Control API </service-control/overview>`__
Lets clients check and report operations against a `managed
service <https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService>`__.
"""
_client: ServiceControllerClient
DEFAULT_ENDPOINT = ServiceControllerClient.DEFAULT_ENDPOINT
DEFAULT_MTLS_ENDPOINT = ServiceControllerClient.DEFAULT_MTLS_ENDPOINT
common_billing_account_path = staticmethod(
ServiceControllerClient.common_billing_account_path
)
parse_common_billing_account_path = staticmethod(
ServiceControllerClient.parse_common_billing_account_path
)
common_folder_path = staticmethod(ServiceControllerClient.common_folder_path)
parse_common_folder_path = staticmethod(
ServiceControllerClient.parse_common_folder_path
)
common_organization_path = staticmethod(
ServiceControllerClient.common_organization_path
)
parse_common_organization_path = staticmethod(
ServiceControllerClient.parse_common_organization_path
)
common_project_path = staticmethod(ServiceControllerClient.common_project_path)
parse_common_project_path = staticmethod(
ServiceControllerClient.parse_common_project_path
)
common_location_path = staticmethod(ServiceControllerClient.common_location_path)
parse_common_location_path = staticmethod(
ServiceControllerClient.parse_common_location_path
)
@classmethod
def from_service_account_info(cls, info: dict, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
info.
Args:
info (dict): The service account private key info.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
ServiceControllerAsyncClient: The constructed client.
"""
return ServiceControllerClient.from_service_account_info.__func__(ServiceControllerAsyncClient, info, *args, **kwargs) # type: ignore
@classmethod
def from_service_account_file(cls, filename: str, *args, **kwargs):
"""Creates an instance of this client using the provided credentials
file.
Args:
filename (str): The path to the service account private key json
file.
args: Additional arguments to pass to the constructor.
kwargs: Additional arguments to pass to the constructor.
Returns:
ServiceControllerAsyncClient: The constructed client.
"""
return ServiceControllerClient.from_service_account_file.__func__(ServiceControllerAsyncClient, filename, *args, **kwargs) # type: ignore
from_service_account_json = from_service_account_file
@property
def transport(self) -> ServiceControllerTransport:
"""Returns the transport used by the client instance.
Returns:
ServiceControllerTransport: The transport used by the client instance.
"""
return self._client.transport
get_transport_class = functools.partial(
type(ServiceControllerClient).get_transport_class, type(ServiceControllerClient)
)
def __init__(
self,
*,
credentials: ga_credentials.Credentials = None,
transport: Union[str, ServiceControllerTransport] = "grpc_asyncio",
client_options: ClientOptions = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiates the service controller client.
Args:
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.
transport (Union[str, ~.ServiceControllerTransport]): The
transport to use. If set to None, a transport is chosen
automatically.
client_options (ClientOptions): Custom options for the client. It
won't take effect if a ``transport`` instance is provided.
(1) The ``api_endpoint`` property can be used to override the
default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT
environment variable can also be used to override the endpoint:
"always" (always use the default mTLS endpoint), "never" (always
use the default regular endpoint) and "auto" (auto switch to the
default mTLS endpoint if client certificate is present, this is
the default value). However, the ``api_endpoint`` property takes
precedence if provided.
(2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
is "true", then the ``client_cert_source`` property can be used
to provide client certificate for mutual TLS transport. If
not provided, the default SSL client certificate will be used if
present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not
set, no client certificate will be used.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
creation failed for any reason.
"""
self._client = ServiceControllerClient(
credentials=credentials,
transport=transport,
client_options=client_options,
client_info=client_info,
)
async def check(
self,
request: Union[service_controller.CheckRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> service_controller.CheckResponse:
r"""Checks whether an operation on a service should be allowed to
proceed based on the configuration of the service and related
policies. It must be called before the operation is executed.
If feasible, the client should cache the check results and reuse
them for 60 seconds. In case of any server errors, the client
should rely on the cached results for much longer time to avoid
outage. WARNING: There is general 60s delay for the
configuration and policy propagation, therefore callers MUST NOT
depend on the ``Check`` method having the latest policy
information.
NOTE: the
[CheckRequest][google.api.servicecontrol.v1.CheckRequest] has
the size limit (wire-format byte size) of 1MB.
This method requires the ``servicemanagement.services.check``
permission on the specified service. For more information, see
`Cloud IAM <https://cloud.google.com/iam>`__.
Args:
request (Union[google.cloud.servicecontrol_v1.types.CheckRequest, dict]):
The request object. Request message for the Check
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:
google.cloud.servicecontrol_v1.types.CheckResponse:
Response message for the Check
method.
"""
# Create or coerce a protobuf request object.
request = service_controller.CheckRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.check,
default_retry=retries.Retry(
initial=1.0,
maximum=10.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.ServiceUnavailable,
),
deadline=5.0,
),
default_timeout=5.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
async def report(
self,
request: Union[service_controller.ReportRequest, dict] = None,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> service_controller.ReportResponse:
r"""Reports operation results to Google Service Control, such as
logs and metrics. It should be called after an operation is
completed.
If feasible, the client should aggregate reporting data for up
to 5 seconds to reduce API traffic. Limiting aggregation to 5
seconds is to reduce data loss during client crashes. Clients
should carefully choose the aggregation time window to avoid
data loss risk more than 0.01% for business and compliance
reasons.
NOTE: the
[ReportRequest][google.api.servicecontrol.v1.ReportRequest] has
the size limit (wire-format byte size) of 1MB.
This method requires the ``servicemanagement.services.report``
permission on the specified service. For more information, see
`Google Cloud IAM <https://cloud.google.com/iam>`__.
Args:
request (Union[google.cloud.servicecontrol_v1.types.ReportRequest, dict]):
The request object. Request message for the Report
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:
google.cloud.servicecontrol_v1.types.ReportResponse:
Response message for the Report
method.
"""
# Create or coerce a protobuf request object.
request = service_controller.ReportRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.report,
default_timeout=16.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc, tb):
await self.transport.close()
try:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=pkg_resources.get_distribution(
"google-cloud-service-control",
).version,
)
except pkg_resources.DistributionNotFound:
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo()
__all__ = ("ServiceControllerAsyncClient",)