This repository has been archived by the owner on Nov 29, 2023. It is now read-only.
/
grpc_asyncio.py
922 lines (804 loc) · 38.9 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
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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
# -*- 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.bigquery.reservation_v1.types import reservation
from google.cloud.bigquery.reservation_v1.types import reservation as gcbr_reservation
from google.protobuf import empty_pb2 as empty # type: ignore
from .base import ReservationServiceTransport, DEFAULT_CLIENT_INFO
from .grpc import ReservationServiceGrpcTransport
class ReservationServiceGrpcAsyncIOTransport(ReservationServiceTransport):
"""gRPC AsyncIO backend transport for ReservationService.
This API allows users to manage their flat-rate BigQuery
reservations.
A reservation provides computational resource guarantees, in the
form of `slots <https://cloud.google.com/bigquery/docs/slots>`__, to
users. A slot is a unit of computational power in BigQuery, and
serves as the basic unit of parallelism. In a scan of a
multi-partitioned table, a single slot operates on a single
partition of the table. A reservation resource exists as a child
resource of the admin project and location, e.g.:
``projects/myproject/locations/US/reservations/reservationName``.
A capacity commitment is a way to purchase compute capacity for
BigQuery jobs (in the form of slots) with some committed period of
usage. A capacity commitment resource exists as a child resource of
the admin project and location, e.g.:
``projects/myproject/locations/US/capacityCommitments/id``.
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 = "bigqueryreservation.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 = "bigqueryreservation.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.
"""
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
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,
)
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,
)
# 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 create_reservation(
self,
) -> Callable[
[gcbr_reservation.CreateReservationRequest],
Awaitable[gcbr_reservation.Reservation],
]:
r"""Return a callable for the create reservation method over gRPC.
Creates a new reservation resource.
Returns:
Callable[[~.CreateReservationRequest],
Awaitable[~.Reservation]]:
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_reservation" not in self._stubs:
self._stubs["create_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/CreateReservation",
request_serializer=gcbr_reservation.CreateReservationRequest.serialize,
response_deserializer=gcbr_reservation.Reservation.deserialize,
)
return self._stubs["create_reservation"]
@property
def list_reservations(
self,
) -> Callable[
[reservation.ListReservationsRequest],
Awaitable[reservation.ListReservationsResponse],
]:
r"""Return a callable for the list reservations method over gRPC.
Lists all the reservations for the project in the
specified location.
Returns:
Callable[[~.ListReservationsRequest],
Awaitable[~.ListReservationsResponse]]:
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_reservations" not in self._stubs:
self._stubs["list_reservations"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/ListReservations",
request_serializer=reservation.ListReservationsRequest.serialize,
response_deserializer=reservation.ListReservationsResponse.deserialize,
)
return self._stubs["list_reservations"]
@property
def get_reservation(
self,
) -> Callable[
[reservation.GetReservationRequest], Awaitable[reservation.Reservation]
]:
r"""Return a callable for the get reservation method over gRPC.
Returns information about the reservation.
Returns:
Callable[[~.GetReservationRequest],
Awaitable[~.Reservation]]:
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_reservation" not in self._stubs:
self._stubs["get_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/GetReservation",
request_serializer=reservation.GetReservationRequest.serialize,
response_deserializer=reservation.Reservation.deserialize,
)
return self._stubs["get_reservation"]
@property
def delete_reservation(
self,
) -> Callable[[reservation.DeleteReservationRequest], Awaitable[empty.Empty]]:
r"""Return a callable for the delete reservation method over gRPC.
Deletes a reservation. Returns
``google.rpc.Code.FAILED_PRECONDITION`` when reservation has
assignments.
Returns:
Callable[[~.DeleteReservationRequest],
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_reservation" not in self._stubs:
self._stubs["delete_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/DeleteReservation",
request_serializer=reservation.DeleteReservationRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["delete_reservation"]
@property
def update_reservation(
self,
) -> Callable[
[gcbr_reservation.UpdateReservationRequest],
Awaitable[gcbr_reservation.Reservation],
]:
r"""Return a callable for the update reservation method over gRPC.
Updates an existing reservation resource.
Returns:
Callable[[~.UpdateReservationRequest],
Awaitable[~.Reservation]]:
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_reservation" not in self._stubs:
self._stubs["update_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/UpdateReservation",
request_serializer=gcbr_reservation.UpdateReservationRequest.serialize,
response_deserializer=gcbr_reservation.Reservation.deserialize,
)
return self._stubs["update_reservation"]
@property
def create_capacity_commitment(
self,
) -> Callable[
[reservation.CreateCapacityCommitmentRequest],
Awaitable[reservation.CapacityCommitment],
]:
r"""Return a callable for the create capacity commitment method over gRPC.
Creates a new capacity commitment resource.
Returns:
Callable[[~.CreateCapacityCommitmentRequest],
Awaitable[~.CapacityCommitment]]:
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_capacity_commitment" not in self._stubs:
self._stubs["create_capacity_commitment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/CreateCapacityCommitment",
request_serializer=reservation.CreateCapacityCommitmentRequest.serialize,
response_deserializer=reservation.CapacityCommitment.deserialize,
)
return self._stubs["create_capacity_commitment"]
@property
def list_capacity_commitments(
self,
) -> Callable[
[reservation.ListCapacityCommitmentsRequest],
Awaitable[reservation.ListCapacityCommitmentsResponse],
]:
r"""Return a callable for the list capacity commitments method over gRPC.
Lists all the capacity commitments for the admin
project.
Returns:
Callable[[~.ListCapacityCommitmentsRequest],
Awaitable[~.ListCapacityCommitmentsResponse]]:
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_capacity_commitments" not in self._stubs:
self._stubs["list_capacity_commitments"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/ListCapacityCommitments",
request_serializer=reservation.ListCapacityCommitmentsRequest.serialize,
response_deserializer=reservation.ListCapacityCommitmentsResponse.deserialize,
)
return self._stubs["list_capacity_commitments"]
@property
def get_capacity_commitment(
self,
) -> Callable[
[reservation.GetCapacityCommitmentRequest],
Awaitable[reservation.CapacityCommitment],
]:
r"""Return a callable for the get capacity commitment method over gRPC.
Returns information about the capacity commitment.
Returns:
Callable[[~.GetCapacityCommitmentRequest],
Awaitable[~.CapacityCommitment]]:
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_capacity_commitment" not in self._stubs:
self._stubs["get_capacity_commitment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/GetCapacityCommitment",
request_serializer=reservation.GetCapacityCommitmentRequest.serialize,
response_deserializer=reservation.CapacityCommitment.deserialize,
)
return self._stubs["get_capacity_commitment"]
@property
def delete_capacity_commitment(
self,
) -> Callable[
[reservation.DeleteCapacityCommitmentRequest], Awaitable[empty.Empty]
]:
r"""Return a callable for the delete capacity commitment method over gRPC.
Deletes a capacity commitment. Attempting to delete capacity
commitment before its commitment_end_time will fail with the
error code ``google.rpc.Code.FAILED_PRECONDITION``.
Returns:
Callable[[~.DeleteCapacityCommitmentRequest],
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_capacity_commitment" not in self._stubs:
self._stubs["delete_capacity_commitment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/DeleteCapacityCommitment",
request_serializer=reservation.DeleteCapacityCommitmentRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["delete_capacity_commitment"]
@property
def update_capacity_commitment(
self,
) -> Callable[
[reservation.UpdateCapacityCommitmentRequest],
Awaitable[reservation.CapacityCommitment],
]:
r"""Return a callable for the update capacity commitment method over gRPC.
Updates an existing capacity commitment.
Only ``plan`` and ``renewal_plan`` fields can be updated.
Plan can only be changed to a plan of a longer commitment
period. Attempting to change to a plan with shorter commitment
period will fail with the error code
``google.rpc.Code.FAILED_PRECONDITION``.
Returns:
Callable[[~.UpdateCapacityCommitmentRequest],
Awaitable[~.CapacityCommitment]]:
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_capacity_commitment" not in self._stubs:
self._stubs["update_capacity_commitment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/UpdateCapacityCommitment",
request_serializer=reservation.UpdateCapacityCommitmentRequest.serialize,
response_deserializer=reservation.CapacityCommitment.deserialize,
)
return self._stubs["update_capacity_commitment"]
@property
def split_capacity_commitment(
self,
) -> Callable[
[reservation.SplitCapacityCommitmentRequest],
Awaitable[reservation.SplitCapacityCommitmentResponse],
]:
r"""Return a callable for the split capacity commitment method over gRPC.
Splits capacity commitment to two commitments of the same plan
and ``commitment_end_time``.
A common use case is to enable downgrading commitments.
For example, in order to downgrade from 10000 slots to 8000, you
might split a 10000 capacity commitment into commitments of 2000
and 8000. Then, you would change the plan of the first one to
``FLEX`` and then delete it.
Returns:
Callable[[~.SplitCapacityCommitmentRequest],
Awaitable[~.SplitCapacityCommitmentResponse]]:
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 "split_capacity_commitment" not in self._stubs:
self._stubs["split_capacity_commitment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/SplitCapacityCommitment",
request_serializer=reservation.SplitCapacityCommitmentRequest.serialize,
response_deserializer=reservation.SplitCapacityCommitmentResponse.deserialize,
)
return self._stubs["split_capacity_commitment"]
@property
def merge_capacity_commitments(
self,
) -> Callable[
[reservation.MergeCapacityCommitmentsRequest],
Awaitable[reservation.CapacityCommitment],
]:
r"""Return a callable for the merge capacity commitments method over gRPC.
Merges capacity commitments of the same plan into a single
commitment.
The resulting capacity commitment has the greater
commitment_end_time out of the to-be-merged capacity
commitments.
Attempting to merge capacity commitments of different plan will
fail with the error code
``google.rpc.Code.FAILED_PRECONDITION``.
Returns:
Callable[[~.MergeCapacityCommitmentsRequest],
Awaitable[~.CapacityCommitment]]:
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 "merge_capacity_commitments" not in self._stubs:
self._stubs["merge_capacity_commitments"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/MergeCapacityCommitments",
request_serializer=reservation.MergeCapacityCommitmentsRequest.serialize,
response_deserializer=reservation.CapacityCommitment.deserialize,
)
return self._stubs["merge_capacity_commitments"]
@property
def create_assignment(
self,
) -> Callable[
[reservation.CreateAssignmentRequest], Awaitable[reservation.Assignment]
]:
r"""Return a callable for the create assignment method over gRPC.
Creates an assignment object which allows the given project to
submit jobs of a certain type using slots from the specified
reservation.
Currently a resource (project, folder, organization) can only
have one assignment per each (job_type, location) combination,
and that reservation will be used for all jobs of the matching
type.
Different assignments can be created on different levels of the
projects, folders or organization hierarchy. During query
execution, the assignment is looked up at the project, folder
and organization levels in that order. The first assignment
found is applied to the query.
When creating assignments, it does not matter if other
assignments exist at higher levels.
Example:
- The organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Assignments for all three entities (``organizationA``,
``project1``, and ``project2``) could all be created and
mapped to the same or different reservations.
Returns ``google.rpc.Code.PERMISSION_DENIED`` if user does not
have 'bigquery.admin' permissions on the project using the
reservation and the project that owns this reservation.
Returns ``google.rpc.Code.INVALID_ARGUMENT`` when location of
the assignment does not match location of the reservation.
Returns:
Callable[[~.CreateAssignmentRequest],
Awaitable[~.Assignment]]:
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_assignment" not in self._stubs:
self._stubs["create_assignment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/CreateAssignment",
request_serializer=reservation.CreateAssignmentRequest.serialize,
response_deserializer=reservation.Assignment.deserialize,
)
return self._stubs["create_assignment"]
@property
def list_assignments(
self,
) -> Callable[
[reservation.ListAssignmentsRequest],
Awaitable[reservation.ListAssignmentsResponse],
]:
r"""Return a callable for the list assignments method over gRPC.
Lists assignments.
Only explicitly created assignments will be returned.
Example:
- Organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Reservation ``res1`` exists and was created previously.
- CreateAssignment was used previously to define the following
associations between entities and reservations:
``<organizationA, res1>`` and ``<project1, res1>``
In this example, ListAssignments will just return the above two
assignments for reservation ``res1``, and no expansion/merge
will happen.
The wildcard "-" can be used for reservations in the request. In
that case all assignments belongs to the specified project and
location will be listed.
**Note** "-" cannot be used for projects nor locations.
Returns:
Callable[[~.ListAssignmentsRequest],
Awaitable[~.ListAssignmentsResponse]]:
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_assignments" not in self._stubs:
self._stubs["list_assignments"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/ListAssignments",
request_serializer=reservation.ListAssignmentsRequest.serialize,
response_deserializer=reservation.ListAssignmentsResponse.deserialize,
)
return self._stubs["list_assignments"]
@property
def delete_assignment(
self,
) -> Callable[[reservation.DeleteAssignmentRequest], Awaitable[empty.Empty]]:
r"""Return a callable for the delete assignment method over gRPC.
Deletes a assignment. No expansion will happen.
Example:
- Organization ``organizationA`` contains two projects,
``project1`` and ``project2``.
- Reservation ``res1`` exists and was created previously.
- CreateAssignment was used previously to define the following
associations between entities and reservations:
``<organizationA, res1>`` and ``<project1, res1>``
In this example, deletion of the ``<organizationA, res1>``
assignment won't affect the other assignment
``<project1, res1>``. After said deletion, queries from
``project1`` will still use ``res1`` while queries from
``project2`` will switch to use on-demand mode.
Returns:
Callable[[~.DeleteAssignmentRequest],
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_assignment" not in self._stubs:
self._stubs["delete_assignment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/DeleteAssignment",
request_serializer=reservation.DeleteAssignmentRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["delete_assignment"]
@property
def search_assignments(
self,
) -> Callable[
[reservation.SearchAssignmentsRequest],
Awaitable[reservation.SearchAssignmentsResponse],
]:
r"""Return a callable for the search assignments method over gRPC.
Looks up assignments for a specified resource for a particular
region. If the request is about a project:
1. Assignments created on the project will be returned if they
exist.
2. Otherwise assignments created on the closest ancestor will be
returned.
3. Assignments for different JobTypes will all be returned.
The same logic applies if the request is about a folder.
If the request is about an organization, then assignments
created on the organization will be returned (organization
doesn't have ancestors).
Comparing to ListAssignments, there are some behavior
differences:
1. permission on the assignee will be verified in this API.
2. Hierarchy lookup (project->folder->organization) happens in
this API.
3. Parent here is ``projects/*/locations/*``, instead of
``projects/*/locations/*reservations/*``.
**Note** "-" cannot be used for projects nor locations.
Returns:
Callable[[~.SearchAssignmentsRequest],
Awaitable[~.SearchAssignmentsResponse]]:
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 "search_assignments" not in self._stubs:
self._stubs["search_assignments"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/SearchAssignments",
request_serializer=reservation.SearchAssignmentsRequest.serialize,
response_deserializer=reservation.SearchAssignmentsResponse.deserialize,
)
return self._stubs["search_assignments"]
@property
def move_assignment(
self,
) -> Callable[
[reservation.MoveAssignmentRequest], Awaitable[reservation.Assignment]
]:
r"""Return a callable for the move assignment method over gRPC.
Moves an assignment under a new reservation.
This differs from removing an existing assignment and
recreating a new one by providing a transactional change
that ensures an assignee always has an associated
reservation.
Returns:
Callable[[~.MoveAssignmentRequest],
Awaitable[~.Assignment]]:
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 "move_assignment" not in self._stubs:
self._stubs["move_assignment"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/MoveAssignment",
request_serializer=reservation.MoveAssignmentRequest.serialize,
response_deserializer=reservation.Assignment.deserialize,
)
return self._stubs["move_assignment"]
@property
def get_bi_reservation(
self,
) -> Callable[
[reservation.GetBiReservationRequest], Awaitable[reservation.BiReservation]
]:
r"""Return a callable for the get bi reservation method over gRPC.
Retrieves a BI reservation.
Returns:
Callable[[~.GetBiReservationRequest],
Awaitable[~.BiReservation]]:
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_bi_reservation" not in self._stubs:
self._stubs["get_bi_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/GetBiReservation",
request_serializer=reservation.GetBiReservationRequest.serialize,
response_deserializer=reservation.BiReservation.deserialize,
)
return self._stubs["get_bi_reservation"]
@property
def update_bi_reservation(
self,
) -> Callable[
[reservation.UpdateBiReservationRequest], Awaitable[reservation.BiReservation]
]:
r"""Return a callable for the update bi reservation method over gRPC.
Updates a BI reservation.
Only fields specified in the ``field_mask`` are updated.
A singleton BI reservation always exists with default size 0. In
order to reserve BI capacity it needs to be updated to an amount
greater than 0. In order to release BI capacity reservation size
must be set to 0.
Returns:
Callable[[~.UpdateBiReservationRequest],
Awaitable[~.BiReservation]]:
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_bi_reservation" not in self._stubs:
self._stubs["update_bi_reservation"] = self.grpc_channel.unary_unary(
"/google.cloud.bigquery.reservation.v1.ReservationService/UpdateBiReservation",
request_serializer=reservation.UpdateBiReservationRequest.serialize,
response_deserializer=reservation.BiReservation.deserialize,
)
return self._stubs["update_bi_reservation"]
__all__ = ("ReservationServiceGrpcAsyncIOTransport",)