This repository has been archived by the owner on Nov 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
grpc_asyncio.py
507 lines (450 loc) · 21.1 KB
/
grpc_asyncio.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
# -*- 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 Awaitable, Callable, Dict, Optional, Sequence, Tuple
from google.api_core import gapic_v1 # type: ignore
from google.api_core import grpc_helpers_async # type: ignore
from google import auth # type: ignore
from google.auth import credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
from google.cloud.osconfig_v1.types import patch_deployments
from google.cloud.osconfig_v1.types import patch_jobs
from google.protobuf import empty_pb2 as empty # type: ignore
from .base import OsConfigServiceTransport, DEFAULT_CLIENT_INFO
from .grpc import OsConfigServiceGrpcTransport
class OsConfigServiceGrpcAsyncIOTransport(OsConfigServiceTransport):
"""gRPC AsyncIO backend transport for OsConfigService.
OS Config API
The OS Config service is a server-side component that you can
use to manage package installations and patch jobs for virtual
machine instances.
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.
"""
_grpc_channel: aio.Channel
_stubs: Dict[str, Callable] = {}
@classmethod
def create_channel(
cls,
host: str = "osconfig.googleapis.com",
credentials: credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
**kwargs,
) -> aio.Channel:
"""Create and return a gRPC AsyncIO channel object.
Args:
address (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 ignored if ``channel`` is provided.
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:
aio.Channel: A gRPC AsyncIO channel object.
"""
scopes = scopes or cls.AUTH_SCOPES
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes,
quota_project_id=quota_project_id,
**kwargs,
)
def __init__(
self,
*,
host: str = "osconfig.googleapis.com",
credentials: credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
channel: aio.Channel = None,
api_mtls_endpoint: str = None,
client_cert_source: Callable[[], Tuple[bytes, bytes]] = None,
ssl_channel_credentials: grpc.ChannelCredentials = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> 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 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`.
channel (Optional[aio.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 applicatin 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 grpc 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're developing
your own client library.
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._ssl_channel_credentials = ssl_channel_credentials
if channel:
# Sanity check: Ensure that channel and credentials are not both
# provided.
credentials = False
# If a channel was explicitly provided, set it.
self._grpc_channel = channel
self._ssl_channel_credentials = None
elif api_mtls_endpoint:
warnings.warn(
"api_mtls_endpoint and client_cert_source are deprecated",
DeprecationWarning,
)
host = (
api_mtls_endpoint
if ":" in api_mtls_endpoint
else api_mtls_endpoint + ":443"
)
if credentials is None:
credentials, _ = auth.default(
scopes=self.AUTH_SCOPES, quota_project_id=quota_project_id
)
# Create SSL credentials with client_cert_source or application
# default SSL credentials.
if client_cert_source:
cert, key = client_cert_source()
ssl_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
else:
ssl_credentials = SslCredentials().ssl_credentials
# create a new channel. The provided one is ignored.
self._grpc_channel = type(self).create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
ssl_credentials=ssl_credentials,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
options=[
("grpc.max_send_message_length", -1),
("grpc.max_receive_message_length", -1),
],
)
self._ssl_channel_credentials = ssl_credentials
else:
host = host if ":" in host else host + ":443"
if credentials is None:
credentials, _ = auth.default(
scopes=self.AUTH_SCOPES, quota_project_id=quota_project_id
)
# create a new channel. The provided one is ignored.
self._grpc_channel = type(self).create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
ssl_credentials=ssl_channel_credentials,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
options=[
("grpc.max_send_message_length", -1),
("grpc.max_receive_message_length", -1),
],
)
# Run the base constructor.
super().__init__(
host=host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
client_info=client_info,
)
self._stubs = {}
@property
def grpc_channel(self) -> aio.Channel:
"""Create the channel designed to connect to this service.
This property caches on the instance; repeated calls return
the same channel.
"""
# Return the channel from cache.
return self._grpc_channel
@property
def execute_patch_job(
self,
) -> Callable[[patch_jobs.ExecutePatchJobRequest], Awaitable[patch_jobs.PatchJob]]:
r"""Return a callable for the execute patch job method over gRPC.
Patch VM instances by creating and running a patch
job.
Returns:
Callable[[~.ExecutePatchJobRequest],
Awaitable[~.PatchJob]]:
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 "execute_patch_job" not in self._stubs:
self._stubs["execute_patch_job"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/ExecutePatchJob",
request_serializer=patch_jobs.ExecutePatchJobRequest.serialize,
response_deserializer=patch_jobs.PatchJob.deserialize,
)
return self._stubs["execute_patch_job"]
@property
def get_patch_job(
self,
) -> Callable[[patch_jobs.GetPatchJobRequest], Awaitable[patch_jobs.PatchJob]]:
r"""Return a callable for the get patch job method over gRPC.
Get the patch job. This can be used to track the
progress of an ongoing patch job or review the details
of completed jobs.
Returns:
Callable[[~.GetPatchJobRequest],
Awaitable[~.PatchJob]]:
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_patch_job" not in self._stubs:
self._stubs["get_patch_job"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/GetPatchJob",
request_serializer=patch_jobs.GetPatchJobRequest.serialize,
response_deserializer=patch_jobs.PatchJob.deserialize,
)
return self._stubs["get_patch_job"]
@property
def cancel_patch_job(
self,
) -> Callable[[patch_jobs.CancelPatchJobRequest], Awaitable[patch_jobs.PatchJob]]:
r"""Return a callable for the cancel patch job method over gRPC.
Cancel a patch job. The patch job must be active.
Canceled patch jobs cannot be restarted.
Returns:
Callable[[~.CancelPatchJobRequest],
Awaitable[~.PatchJob]]:
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 "cancel_patch_job" not in self._stubs:
self._stubs["cancel_patch_job"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/CancelPatchJob",
request_serializer=patch_jobs.CancelPatchJobRequest.serialize,
response_deserializer=patch_jobs.PatchJob.deserialize,
)
return self._stubs["cancel_patch_job"]
@property
def list_patch_jobs(
self,
) -> Callable[
[patch_jobs.ListPatchJobsRequest], Awaitable[patch_jobs.ListPatchJobsResponse]
]:
r"""Return a callable for the list patch jobs method over gRPC.
Get a list of patch jobs.
Returns:
Callable[[~.ListPatchJobsRequest],
Awaitable[~.ListPatchJobsResponse]]:
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_patch_jobs" not in self._stubs:
self._stubs["list_patch_jobs"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/ListPatchJobs",
request_serializer=patch_jobs.ListPatchJobsRequest.serialize,
response_deserializer=patch_jobs.ListPatchJobsResponse.deserialize,
)
return self._stubs["list_patch_jobs"]
@property
def list_patch_job_instance_details(
self,
) -> Callable[
[patch_jobs.ListPatchJobInstanceDetailsRequest],
Awaitable[patch_jobs.ListPatchJobInstanceDetailsResponse],
]:
r"""Return a callable for the list patch job instance
details method over gRPC.
Get a list of instance details for a given patch job.
Returns:
Callable[[~.ListPatchJobInstanceDetailsRequest],
Awaitable[~.ListPatchJobInstanceDetailsResponse]]:
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_patch_job_instance_details" not in self._stubs:
self._stubs[
"list_patch_job_instance_details"
] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/ListPatchJobInstanceDetails",
request_serializer=patch_jobs.ListPatchJobInstanceDetailsRequest.serialize,
response_deserializer=patch_jobs.ListPatchJobInstanceDetailsResponse.deserialize,
)
return self._stubs["list_patch_job_instance_details"]
@property
def create_patch_deployment(
self,
) -> Callable[
[patch_deployments.CreatePatchDeploymentRequest],
Awaitable[patch_deployments.PatchDeployment],
]:
r"""Return a callable for the create patch deployment method over gRPC.
Create an OS Config patch deployment.
Returns:
Callable[[~.CreatePatchDeploymentRequest],
Awaitable[~.PatchDeployment]]:
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_patch_deployment" not in self._stubs:
self._stubs["create_patch_deployment"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/CreatePatchDeployment",
request_serializer=patch_deployments.CreatePatchDeploymentRequest.serialize,
response_deserializer=patch_deployments.PatchDeployment.deserialize,
)
return self._stubs["create_patch_deployment"]
@property
def get_patch_deployment(
self,
) -> Callable[
[patch_deployments.GetPatchDeploymentRequest],
Awaitable[patch_deployments.PatchDeployment],
]:
r"""Return a callable for the get patch deployment method over gRPC.
Get an OS Config patch deployment.
Returns:
Callable[[~.GetPatchDeploymentRequest],
Awaitable[~.PatchDeployment]]:
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_patch_deployment" not in self._stubs:
self._stubs["get_patch_deployment"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/GetPatchDeployment",
request_serializer=patch_deployments.GetPatchDeploymentRequest.serialize,
response_deserializer=patch_deployments.PatchDeployment.deserialize,
)
return self._stubs["get_patch_deployment"]
@property
def list_patch_deployments(
self,
) -> Callable[
[patch_deployments.ListPatchDeploymentsRequest],
Awaitable[patch_deployments.ListPatchDeploymentsResponse],
]:
r"""Return a callable for the list patch deployments method over gRPC.
Get a page of OS Config patch deployments.
Returns:
Callable[[~.ListPatchDeploymentsRequest],
Awaitable[~.ListPatchDeploymentsResponse]]:
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_patch_deployments" not in self._stubs:
self._stubs["list_patch_deployments"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/ListPatchDeployments",
request_serializer=patch_deployments.ListPatchDeploymentsRequest.serialize,
response_deserializer=patch_deployments.ListPatchDeploymentsResponse.deserialize,
)
return self._stubs["list_patch_deployments"]
@property
def delete_patch_deployment(
self,
) -> Callable[
[patch_deployments.DeletePatchDeploymentRequest], Awaitable[empty.Empty]
]:
r"""Return a callable for the delete patch deployment method over gRPC.
Delete an OS Config patch deployment.
Returns:
Callable[[~.DeletePatchDeploymentRequest],
Awaitable[~.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_patch_deployment" not in self._stubs:
self._stubs["delete_patch_deployment"] = self.grpc_channel.unary_unary(
"/google.cloud.osconfig.v1.OsConfigService/DeletePatchDeployment",
request_serializer=patch_deployments.DeletePatchDeploymentRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["delete_patch_deployment"]
__all__ = ("OsConfigServiceGrpcAsyncIOTransport",)