This repository has been archived by the owner on Dec 31, 2023. It is now read-only.
/
grpc.py
581 lines (523 loc) · 25.9 KB
/
grpc.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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
# -*- 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.
#
import warnings
from typing import Callable, Dict, Optional, Sequence, Tuple, Union
from google.api_core import grpc_helpers # type: ignore
from google.api_core import gapic_v1 # type: ignore
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
import grpc # type: ignore
from google.cloud.monitoring_v3.types import notification
from google.cloud.monitoring_v3.types import notification_service
from google.protobuf import empty_pb2 # type: ignore
from .base import NotificationChannelServiceTransport, DEFAULT_CLIENT_INFO
class NotificationChannelServiceGrpcTransport(NotificationChannelServiceTransport):
"""gRPC backend transport for NotificationChannelService.
The Notification Channel API provides access to configuration
that controls how messages related to incidents are sent.
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 protocol buffers over the wire using gRPC (which is built on
top of HTTP/2); the ``grpcio`` package must be installed.
"""
_stubs: Dict[str, Callable]
def __init__(
self,
*,
host: str = "monitoring.googleapis.com",
credentials: ga_credentials.Credentials = None,
credentials_file: str = None,
scopes: Sequence[str] = None,
channel: grpc.Channel = None,
api_mtls_endpoint: str = None,
client_cert_source: Callable[[], Tuple[bytes, bytes]] = None,
ssl_channel_credentials: grpc.ChannelCredentials = None,
client_cert_source_for_mtls: 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,
) -> 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.
This argument is ignored if ``channel`` is provided.
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.
channel (Optional[grpc.Channel]): A ``Channel`` instance through
which to make calls.
api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
If provided, it overrides the ``host`` argument and tries to create
a mutual TLS channel with client SSL credentials from
``client_cert_source`` or application default SSL credentials.
client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]):
Deprecated. A callback to provide client SSL certificate bytes and
private key bytes, both in PEM format. It is ignored if
``api_mtls_endpoint`` is None.
ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
for the grpc channel. It is ignored if ``channel`` is provided.
client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]):
A callback to provide client certificate bytes and private key bytes,
both in PEM format. It is used to configure a mutual TLS channel. It is
ignored if ``channel`` or ``ssl_channel_credentials`` 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're developing
your own client library.
always_use_jwt_access (Optional[bool]): Whether self signed JWT should
be used for service account credentials.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
creation failed for any reason.
google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
and ``credentials_file`` are passed.
"""
self._grpc_channel = None
self._ssl_channel_credentials = ssl_channel_credentials
self._stubs: Dict[str, Callable] = {}
if api_mtls_endpoint:
warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning)
if client_cert_source:
warnings.warn("client_cert_source is deprecated", DeprecationWarning)
if channel:
# Ignore credentials if a channel was passed.
credentials = False
# If a channel was explicitly provided, set it.
self._grpc_channel = channel
self._ssl_channel_credentials = None
else:
if api_mtls_endpoint:
host = api_mtls_endpoint
# Create SSL credentials with client_cert_source or application
# default SSL credentials.
if client_cert_source:
cert, key = client_cert_source()
self._ssl_channel_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
else:
self._ssl_channel_credentials = SslCredentials().ssl_credentials
else:
if client_cert_source_for_mtls and not ssl_channel_credentials:
cert, key = client_cert_source_for_mtls()
self._ssl_channel_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
# The base transport sets the host, credentials and scopes
super().__init__(
host=host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
self._grpc_channel = type(self).create_channel(
self._host,
credentials=self._credentials,
credentials_file=credentials_file,
scopes=self._scopes,
ssl_credentials=self._ssl_channel_credentials,
quota_project_id=quota_project_id,
options=[
("grpc.max_send_message_length", -1),
("grpc.max_receive_message_length", -1),
],
)
# Wrap messages. This must be done after self._grpc_channel exists
self._prep_wrapped_messages(client_info)
@classmethod
def create_channel(
cls,
host: str = "monitoring.googleapis.com",
credentials: ga_credentials.Credentials = None,
credentials_file: str = None,
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
**kwargs,
) -> grpc.Channel:
"""Create and return a gRPC channel object.
Args:
host (Optional[str]): The host for the channel to use.
credentials (Optional[~.Credentials]): The
authorization credentials to attach to requests. These
credentials identify this 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 mutually exclusive with credentials.
scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
service. These are only used when credentials are not specified and
are passed to :func:`google.auth.default`.
quota_project_id (Optional[str]): An optional project to use for billing
and quota.
kwargs (Optional[dict]): Keyword arguments, which are passed to the
channel creation.
Returns:
grpc.Channel: A gRPC channel object.
Raises:
google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
and ``credentials_file`` are passed.
"""
return grpc_helpers.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
default_scopes=cls.AUTH_SCOPES,
scopes=scopes,
default_host=cls.DEFAULT_HOST,
**kwargs,
)
@property
def grpc_channel(self) -> grpc.Channel:
"""Return the channel designed to connect to this service.
"""
return self._grpc_channel
@property
def list_notification_channel_descriptors(
self,
) -> Callable[
[notification_service.ListNotificationChannelDescriptorsRequest],
notification_service.ListNotificationChannelDescriptorsResponse,
]:
r"""Return a callable for the list notification channel
descriptors method over gRPC.
Lists the descriptors for supported channel types.
The use of descriptors makes it possible for new channel
types to be dynamically added.
Returns:
Callable[[~.ListNotificationChannelDescriptorsRequest],
~.ListNotificationChannelDescriptorsResponse]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_notification_channel_descriptors" not in self._stubs:
self._stubs[
"list_notification_channel_descriptors"
] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/ListNotificationChannelDescriptors",
request_serializer=notification_service.ListNotificationChannelDescriptorsRequest.serialize,
response_deserializer=notification_service.ListNotificationChannelDescriptorsResponse.deserialize,
)
return self._stubs["list_notification_channel_descriptors"]
@property
def get_notification_channel_descriptor(
self,
) -> Callable[
[notification_service.GetNotificationChannelDescriptorRequest],
notification.NotificationChannelDescriptor,
]:
r"""Return a callable for the get notification channel
descriptor method over gRPC.
Gets a single channel descriptor. The descriptor
indicates which fields are expected / permitted for a
notification channel of the given type.
Returns:
Callable[[~.GetNotificationChannelDescriptorRequest],
~.NotificationChannelDescriptor]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_notification_channel_descriptor" not in self._stubs:
self._stubs[
"get_notification_channel_descriptor"
] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/GetNotificationChannelDescriptor",
request_serializer=notification_service.GetNotificationChannelDescriptorRequest.serialize,
response_deserializer=notification.NotificationChannelDescriptor.deserialize,
)
return self._stubs["get_notification_channel_descriptor"]
@property
def list_notification_channels(
self,
) -> Callable[
[notification_service.ListNotificationChannelsRequest],
notification_service.ListNotificationChannelsResponse,
]:
r"""Return a callable for the list notification channels method over gRPC.
Lists the notification channels that have been
created for the project.
Returns:
Callable[[~.ListNotificationChannelsRequest],
~.ListNotificationChannelsResponse]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_notification_channels" not in self._stubs:
self._stubs["list_notification_channels"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/ListNotificationChannels",
request_serializer=notification_service.ListNotificationChannelsRequest.serialize,
response_deserializer=notification_service.ListNotificationChannelsResponse.deserialize,
)
return self._stubs["list_notification_channels"]
@property
def get_notification_channel(
self,
) -> Callable[
[notification_service.GetNotificationChannelRequest],
notification.NotificationChannel,
]:
r"""Return a callable for the get notification channel method over gRPC.
Gets a single notification channel. The channel
includes the relevant configuration details with which
the channel was created. However, the response may
truncate or omit passwords, API keys, or other private
key matter and thus the response may not be 100%
identical to the information that was supplied in the
call to the create method.
Returns:
Callable[[~.GetNotificationChannelRequest],
~.NotificationChannel]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_notification_channel" not in self._stubs:
self._stubs["get_notification_channel"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/GetNotificationChannel",
request_serializer=notification_service.GetNotificationChannelRequest.serialize,
response_deserializer=notification.NotificationChannel.deserialize,
)
return self._stubs["get_notification_channel"]
@property
def create_notification_channel(
self,
) -> Callable[
[notification_service.CreateNotificationChannelRequest],
notification.NotificationChannel,
]:
r"""Return a callable for the create notification channel method over gRPC.
Creates a new notification channel, representing a
single notification endpoint such as an email address,
SMS number, or PagerDuty service.
Returns:
Callable[[~.CreateNotificationChannelRequest],
~.NotificationChannel]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_notification_channel" not in self._stubs:
self._stubs["create_notification_channel"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/CreateNotificationChannel",
request_serializer=notification_service.CreateNotificationChannelRequest.serialize,
response_deserializer=notification.NotificationChannel.deserialize,
)
return self._stubs["create_notification_channel"]
@property
def update_notification_channel(
self,
) -> Callable[
[notification_service.UpdateNotificationChannelRequest],
notification.NotificationChannel,
]:
r"""Return a callable for the update notification channel method over gRPC.
Updates a notification channel. Fields not specified
in the field mask remain unchanged.
Returns:
Callable[[~.UpdateNotificationChannelRequest],
~.NotificationChannel]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "update_notification_channel" not in self._stubs:
self._stubs["update_notification_channel"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/UpdateNotificationChannel",
request_serializer=notification_service.UpdateNotificationChannelRequest.serialize,
response_deserializer=notification.NotificationChannel.deserialize,
)
return self._stubs["update_notification_channel"]
@property
def delete_notification_channel(
self,
) -> Callable[
[notification_service.DeleteNotificationChannelRequest], empty_pb2.Empty
]:
r"""Return a callable for the delete notification channel method over gRPC.
Deletes a notification channel.
Returns:
Callable[[~.DeleteNotificationChannelRequest],
~.Empty]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_notification_channel" not in self._stubs:
self._stubs["delete_notification_channel"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/DeleteNotificationChannel",
request_serializer=notification_service.DeleteNotificationChannelRequest.serialize,
response_deserializer=empty_pb2.Empty.FromString,
)
return self._stubs["delete_notification_channel"]
@property
def send_notification_channel_verification_code(
self,
) -> Callable[
[notification_service.SendNotificationChannelVerificationCodeRequest],
empty_pb2.Empty,
]:
r"""Return a callable for the send notification channel
verification code method over gRPC.
Causes a verification code to be delivered to the channel. The
code can then be supplied in ``VerifyNotificationChannel`` to
verify the channel.
Returns:
Callable[[~.SendNotificationChannelVerificationCodeRequest],
~.Empty]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "send_notification_channel_verification_code" not in self._stubs:
self._stubs[
"send_notification_channel_verification_code"
] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/SendNotificationChannelVerificationCode",
request_serializer=notification_service.SendNotificationChannelVerificationCodeRequest.serialize,
response_deserializer=empty_pb2.Empty.FromString,
)
return self._stubs["send_notification_channel_verification_code"]
@property
def get_notification_channel_verification_code(
self,
) -> Callable[
[notification_service.GetNotificationChannelVerificationCodeRequest],
notification_service.GetNotificationChannelVerificationCodeResponse,
]:
r"""Return a callable for the get notification channel
verification code method over gRPC.
Requests a verification code for an already verified
channel that can then be used in a call to
VerifyNotificationChannel() on a different channel with
an equivalent identity in the same or in a different
project. This makes it possible to copy a channel
between projects without requiring manual reverification
of the channel. If the channel is not in the verified
state, this method will fail (in other words, this may
only be used if the
SendNotificationChannelVerificationCode and
VerifyNotificationChannel paths have already been used
to put the given channel into the verified state).
There is no guarantee that the verification codes
returned by this method will be of a similar structure
or form as the ones that are delivered to the channel
via SendNotificationChannelVerificationCode; while
VerifyNotificationChannel() will recognize both the
codes delivered via
SendNotificationChannelVerificationCode() and returned
from GetNotificationChannelVerificationCode(), it is
typically the case that the verification codes delivered
via
SendNotificationChannelVerificationCode() will be
shorter and also have a shorter expiration (e.g. codes
such as "G-123456") whereas GetVerificationCode() will
typically return a much longer, websafe base 64 encoded
string that has a longer expiration time.
Returns:
Callable[[~.GetNotificationChannelVerificationCodeRequest],
~.GetNotificationChannelVerificationCodeResponse]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_notification_channel_verification_code" not in self._stubs:
self._stubs[
"get_notification_channel_verification_code"
] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/GetNotificationChannelVerificationCode",
request_serializer=notification_service.GetNotificationChannelVerificationCodeRequest.serialize,
response_deserializer=notification_service.GetNotificationChannelVerificationCodeResponse.deserialize,
)
return self._stubs["get_notification_channel_verification_code"]
@property
def verify_notification_channel(
self,
) -> Callable[
[notification_service.VerifyNotificationChannelRequest],
notification.NotificationChannel,
]:
r"""Return a callable for the verify notification channel method over gRPC.
Verifies a ``NotificationChannel`` by proving receipt of the
code delivered to the channel as a result of calling
``SendNotificationChannelVerificationCode``.
Returns:
Callable[[~.VerifyNotificationChannelRequest],
~.NotificationChannel]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "verify_notification_channel" not in self._stubs:
self._stubs["verify_notification_channel"] = self.grpc_channel.unary_unary(
"/google.monitoring.v3.NotificationChannelService/VerifyNotificationChannel",
request_serializer=notification_service.VerifyNotificationChannelRequest.serialize,
response_deserializer=notification.NotificationChannel.deserialize,
)
return self._stubs["verify_notification_channel"]
def close(self):
self.grpc_channel.close()
__all__ = ("NotificationChannelServiceGrpcTransport",)