This repository has been archived by the owner on Jul 6, 2023. It is now read-only.
/
grpc_asyncio.py
1914 lines (1631 loc) · 80.5 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
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- 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, Union
from google.api_core import gapic_v1 # type: ignore
from google.api_core import grpc_helpers_async # type: ignore
from google.api_core import operations_v1 # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
import packaging.version
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
from google.cloud.channel_v1.types import channel_partner_links
from google.cloud.channel_v1.types import customers
from google.cloud.channel_v1.types import entitlements
from google.cloud.channel_v1.types import offers
from google.cloud.channel_v1.types import service
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from .base import CloudChannelServiceTransport, DEFAULT_CLIENT_INFO
from .grpc import CloudChannelServiceGrpcTransport
class CloudChannelServiceGrpcAsyncIOTransport(CloudChannelServiceTransport):
"""gRPC AsyncIO backend transport for CloudChannelService.
CloudChannelService lets Google cloud resellers and distributors
manage their customers, channel partners, entitlements, and reports.
Using this service:
1. Resellers and distributors can manage a customer entity.
2. Distributors can register an authorized reseller in their channel
and provide them with delegated admin access.
3. Resellers and distributors can manage customer entitlements.
CloudChannelService exposes the following resources:
- [Customer][google.cloud.channel.v1.Customer]s: An entity—usually
an enterprise—managed by a reseller or distributor.
- [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity
that provides a customer with the means to use a service.
Entitlements are created or updated as a result of a successful
fulfillment.
- [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s:
An entity that identifies links between distributors and their
indirect resellers in a channel.
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 = "cloudchannel.googleapis.com",
credentials: ga_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:
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 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.
"""
return grpc_helpers_async.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,
)
def __init__(
self,
*,
host: str = "cloudchannel.googleapis.com",
credentials: ga_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,
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id=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 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 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] = {}
self._operations_client = None
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)
@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 operations_client(self) -> operations_v1.OperationsAsyncClient:
"""Create the client designed to process long-running operations.
This property caches on the instance; repeated calls return the same
client.
"""
# Sanity check: Only create a new client if we do not already have one.
if self._operations_client is None:
self._operations_client = operations_v1.OperationsAsyncClient(
self.grpc_channel
)
# Return the client from cache.
return self._operations_client
@property
def list_customers(
self,
) -> Callable[
[service.ListCustomersRequest], Awaitable[service.ListCustomersResponse]
]:
r"""Return a callable for the list customers method over gRPC.
List [Customer][google.cloud.channel.v1.Customer]s.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
Return value: List of
[Customer][google.cloud.channel.v1.Customer]s, or an empty list
if there are no customers.
Returns:
Callable[[~.ListCustomersRequest],
Awaitable[~.ListCustomersResponse]]:
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_customers" not in self._stubs:
self._stubs["list_customers"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ListCustomers",
request_serializer=service.ListCustomersRequest.serialize,
response_deserializer=service.ListCustomersResponse.deserialize,
)
return self._stubs["list_customers"]
@property
def get_customer(
self,
) -> Callable[[service.GetCustomerRequest], Awaitable[customers.Customer]]:
r"""Return a callable for the get customer method over gRPC.
Returns the requested
[Customer][google.cloud.channel.v1.Customer] resource.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: The customer resource doesn't exist. Usually the
result of an invalid name parameter.
Return value: The [Customer][google.cloud.channel.v1.Customer]
resource.
Returns:
Callable[[~.GetCustomerRequest],
Awaitable[~.Customer]]:
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_customer" not in self._stubs:
self._stubs["get_customer"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/GetCustomer",
request_serializer=service.GetCustomerRequest.serialize,
response_deserializer=customers.Customer.deserialize,
)
return self._stubs["get_customer"]
@property
def check_cloud_identity_accounts_exist(
self,
) -> Callable[
[service.CheckCloudIdentityAccountsExistRequest],
Awaitable[service.CheckCloudIdentityAccountsExistResponse],
]:
r"""Return a callable for the check cloud identity accounts
exist method over gRPC.
Confirms the existence of Cloud Identity accounts based on the
domain and if the Cloud Identity accounts are owned by the
reseller.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- INVALID_VALUE: Invalid domain value in the request.
Return value: A list of
[CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount]
resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error
returns if no
[CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount]
resources match the domain.
Returns:
Callable[[~.CheckCloudIdentityAccountsExistRequest],
Awaitable[~.CheckCloudIdentityAccountsExistResponse]]:
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 "check_cloud_identity_accounts_exist" not in self._stubs:
self._stubs[
"check_cloud_identity_accounts_exist"
] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/CheckCloudIdentityAccountsExist",
request_serializer=service.CheckCloudIdentityAccountsExistRequest.serialize,
response_deserializer=service.CheckCloudIdentityAccountsExistResponse.deserialize,
)
return self._stubs["check_cloud_identity_accounts_exist"]
@property
def create_customer(
self,
) -> Callable[[service.CreateCustomerRequest], Awaitable[customers.Customer]]:
r"""Return a callable for the create customer method over gRPC.
Creates a new [Customer][google.cloud.channel.v1.Customer]
resource under the reseller or distributor account.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Domain field value doesn't match the primary email domain.
Return value: The newly created
[Customer][google.cloud.channel.v1.Customer] resource.
Returns:
Callable[[~.CreateCustomerRequest],
Awaitable[~.Customer]]:
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_customer" not in self._stubs:
self._stubs["create_customer"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/CreateCustomer",
request_serializer=service.CreateCustomerRequest.serialize,
response_deserializer=customers.Customer.deserialize,
)
return self._stubs["create_customer"]
@property
def update_customer(
self,
) -> Callable[[service.UpdateCustomerRequest], Awaitable[customers.Customer]]:
r"""Return a callable for the update customer method over gRPC.
Updates an existing [Customer][google.cloud.channel.v1.Customer]
resource for the reseller or distributor.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer]
resource found for the name in the request.
Return value: The updated
[Customer][google.cloud.channel.v1.Customer] resource.
Returns:
Callable[[~.UpdateCustomerRequest],
Awaitable[~.Customer]]:
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_customer" not in self._stubs:
self._stubs["update_customer"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/UpdateCustomer",
request_serializer=service.UpdateCustomerRequest.serialize,
response_deserializer=customers.Customer.deserialize,
)
return self._stubs["update_customer"]
@property
def delete_customer(
self,
) -> Callable[[service.DeleteCustomerRequest], Awaitable[empty_pb2.Empty]]:
r"""Return a callable for the delete customer method over gRPC.
Deletes the given [Customer][google.cloud.channel.v1.Customer]
permanently.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not
own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- FAILED_PRECONDITION: The customer has existing entitlements.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer]
resource found for the name in the request.
Returns:
Callable[[~.DeleteCustomerRequest],
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_customer" not in self._stubs:
self._stubs["delete_customer"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/DeleteCustomer",
request_serializer=service.DeleteCustomerRequest.serialize,
response_deserializer=empty_pb2.Empty.FromString,
)
return self._stubs["delete_customer"]
@property
def import_customer(
self,
) -> Callable[[service.ImportCustomerRequest], Awaitable[customers.Customer]]:
r"""Return a callable for the import customer method over gRPC.
Imports a [Customer][google.cloud.channel.v1.Customer] from the
Cloud Identity associated with the provided Cloud Identity ID or
domain before a TransferEntitlements call. If a linked Customer
already exists and overwrite_if_exists is true, it will update
that Customer's data.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is
different from the reseller account in the API request.
- NOT_FOUND: Cloud Identity doesn't exist or was deleted.
- INVALID_ARGUMENT: Required parameters are missing, or the
auth_token is expired or invalid.
- ALREADY_EXISTS: A customer already exists and has conflicting
critical fields. Requires an overwrite.
Return value: The [Customer][google.cloud.channel.v1.Customer].
Returns:
Callable[[~.ImportCustomerRequest],
Awaitable[~.Customer]]:
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 "import_customer" not in self._stubs:
self._stubs["import_customer"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ImportCustomer",
request_serializer=service.ImportCustomerRequest.serialize,
response_deserializer=customers.Customer.deserialize,
)
return self._stubs["import_customer"]
@property
def provision_cloud_identity(
self,
) -> Callable[
[service.ProvisionCloudIdentityRequest], Awaitable[operations_pb2.Operation]
]:
r"""Return a callable for the provision cloud identity method over gRPC.
Creates a Cloud Identity for the given customer using the
customer's information, or the information provided here.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists.
Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation
method of CloudChannelOperationsService. The Operation metadata
contains an instance of
[OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Returns:
Callable[[~.ProvisionCloudIdentityRequest],
Awaitable[~.Operation]]:
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 "provision_cloud_identity" not in self._stubs:
self._stubs["provision_cloud_identity"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ProvisionCloudIdentity",
request_serializer=service.ProvisionCloudIdentityRequest.serialize,
response_deserializer=operations_pb2.Operation.FromString,
)
return self._stubs["provision_cloud_identity"]
@property
def list_entitlements(
self,
) -> Callable[
[service.ListEntitlementsRequest], Awaitable[service.ListEntitlementsResponse]
]:
r"""Return a callable for the list entitlements method over gRPC.
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s
belonging to a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
Return value: A list of the customer's
[Entitlement][google.cloud.channel.v1.Entitlement]s.
Returns:
Callable[[~.ListEntitlementsRequest],
Awaitable[~.ListEntitlementsResponse]]:
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_entitlements" not in self._stubs:
self._stubs["list_entitlements"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ListEntitlements",
request_serializer=service.ListEntitlementsRequest.serialize,
response_deserializer=service.ListEntitlementsResponse.deserialize,
)
return self._stubs["list_entitlements"]
@property
def list_transferable_skus(
self,
) -> Callable[
[service.ListTransferableSkusRequest],
Awaitable[service.ListTransferableSkusResponse],
]:
r"""Return a callable for the list transferable skus method over gRPC.
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s
of a customer based on the Cloud Identity ID or Customer Name in
the request.
Use this method to list the entitlements information of an
unowned customer. You should provide the customer's Cloud
Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no
auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from
the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
Return value: A list of the customer's
[TransferableSku][google.cloud.channel.v1.TransferableSku].
Returns:
Callable[[~.ListTransferableSkusRequest],
Awaitable[~.ListTransferableSkusResponse]]:
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_transferable_skus" not in self._stubs:
self._stubs["list_transferable_skus"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ListTransferableSkus",
request_serializer=service.ListTransferableSkusRequest.serialize,
response_deserializer=service.ListTransferableSkusResponse.deserialize,
)
return self._stubs["list_transferable_skus"]
@property
def list_transferable_offers(
self,
) -> Callable[
[service.ListTransferableOffersRequest],
Awaitable[service.ListTransferableOffersResponse],
]:
r"""Return a callable for the list transferable offers method over gRPC.
List
[TransferableOffer][google.cloud.channel.v1.TransferableOffer]s
of a customer based on Cloud Identity ID or Customer Name in the
request.
Use this method when a reseller gets the entitlement information
of an unowned customer. The reseller should provide the
customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no
auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from
the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
Return value: List of
[TransferableOffer][google.cloud.channel.v1.TransferableOffer]
for the given customer and SKU.
Returns:
Callable[[~.ListTransferableOffersRequest],
Awaitable[~.ListTransferableOffersResponse]]:
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_transferable_offers" not in self._stubs:
self._stubs["list_transferable_offers"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ListTransferableOffers",
request_serializer=service.ListTransferableOffersRequest.serialize,
response_deserializer=service.ListTransferableOffersResponse.deserialize,
)
return self._stubs["list_transferable_offers"]
@property
def get_entitlement(
self,
) -> Callable[[service.GetEntitlementRequest], Awaitable[entitlements.Entitlement]]:
r"""Return a callable for the get entitlement method over gRPC.
Returns the requested
[Entitlement][google.cloud.channel.v1.Entitlement] resource.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: The customer entitlement was not found.
Return value: The requested
[Entitlement][google.cloud.channel.v1.Entitlement] resource.
Returns:
Callable[[~.GetEntitlementRequest],
Awaitable[~.Entitlement]]:
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_entitlement" not in self._stubs:
self._stubs["get_entitlement"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/GetEntitlement",
request_serializer=service.GetEntitlementRequest.serialize,
response_deserializer=entitlements.Entitlement.deserialize,
)
return self._stubs["get_entitlement"]
@property
def create_entitlement(
self,
) -> Callable[
[service.CreateEntitlementRequest], Awaitable[operations_pb2.Operation]
]:
r"""Return a callable for the create entitlement method over gRPC.
Creates an entitlement for a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- There is already a customer entitlement for a SKU from the
same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is,
contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS:
- The SKU was already purchased for the customer.
- The customer's primary email already exists. Retry after
changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been
verified.
- A pre-requisite SKU required to purchase an Add-On SKU is
missing. For example, Google Workspace Business Starter is
required to purchase Vault or Drive.
- (Developer accounts only) Reseller and resold domain must
meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation
method of CloudChannelOperationsService. The Operation metadata
will contain an instance of
[OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Returns:
Callable[[~.CreateEntitlementRequest],
Awaitable[~.Operation]]:
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_entitlement" not in self._stubs:
self._stubs["create_entitlement"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/CreateEntitlement",
request_serializer=service.CreateEntitlementRequest.serialize,
response_deserializer=operations_pb2.Operation.FromString,
)
return self._stubs["create_entitlement"]
@property
def change_parameters(
self,
) -> Callable[
[service.ChangeParametersRequest], Awaitable[operations_pb2.Operation]
]:
r"""Return a callable for the change parameters method over gRPC.
Change parameters of the entitlement.
An entitlement update is a long-running operation and it updates
the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid. For example, the number of seats being changed is
greater than the allowed number of max seats, or decreasing
seats for a commitment based plan.
- NOT_FOUND: Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation
method of CloudChannelOperationsService. The Operation metadata
will contain an instance of
[OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Returns:
Callable[[~.ChangeParametersRequest],
Awaitable[~.Operation]]:
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 "change_parameters" not in self._stubs:
self._stubs["change_parameters"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ChangeParameters",
request_serializer=service.ChangeParametersRequest.serialize,
response_deserializer=operations_pb2.Operation.FromString,
)
return self._stubs["change_parameters"]
@property
def change_renewal_settings(
self,
) -> Callable[
[service.ChangeRenewalSettingsRequest], Awaitable[operations_pb2.Operation]
]:
r"""Return a callable for the change renewal settings method over gRPC.
Updates the renewal settings for an existing customer
entitlement.
An entitlement update is a long-running operation and it updates
the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: Entitlement resource not found.
- NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for
a commitment plan. Can't enable or disable renewals for
non-commitment plans.
- INTERNAL: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation
method of CloudChannelOperationsService. The Operation metadata
will contain an instance of
[OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Returns:
Callable[[~.ChangeRenewalSettingsRequest],
Awaitable[~.Operation]]:
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 "change_renewal_settings" not in self._stubs:
self._stubs["change_renewal_settings"] = self.grpc_channel.unary_unary(
"/google.cloud.channel.v1.CloudChannelService/ChangeRenewalSettings",
request_serializer=service.ChangeRenewalSettingsRequest.serialize,
response_deserializer=operations_pb2.Operation.FromString,
)
return self._stubs["change_renewal_settings"]
@property
def change_offer(
self,
) -> Callable[[service.ChangeOfferRequest], Awaitable[operations_pb2.Operation]]:
r"""Return a callable for the change offer method over gRPC.
Updates the Offer for an existing customer entitlement.
An entitlement update is a long-running operation and it updates
the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the
reseller.
- INVALID_ARGUMENT: Required request parameters are missing or
invalid.
- NOT_FOUND: Offer or Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in
the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation
method of CloudChannelOperationsService. The Operation metadata
will contain an instance of
[OperationMetadata][google.cloud.channel.v1.OperationMetadata].