This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
CloudChannelServiceClient.java
5133 lines (4892 loc) · 208 KB
/
CloudChannelServiceClient.java
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
/*
* 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
*
* https://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.
*/
package com.google.cloud.channel.v1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.channel.v1.stub.CloudChannelServiceStub;
import com.google.cloud.channel.v1.stub.CloudChannelServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: CloudChannelService enables Google cloud resellers and distributors to
* manage their customers, channel partners, entitlements and reports.
*
* <p>Using this service: 1. Resellers or distributors can manage a customer entity. 2. Distributors
* can register an authorized reseller in their channel and then enable delegated admin access for
* the reseller. 3. Resellers or distributors can manage entitlements for their customers.
*
* <p>The service primarily exposes the following resources: -
* [Customer][google.cloud.channel.v1.Customer]s: A Customer represents an entity managed by a
* reseller or distributor. A customer typically represents an enterprise. In an n-tier resale
* channel hierarchy, customers are generally represented as leaf nodes. Customers primarily have an
* Entitlement sub-resource discussed below.
*
* <p>- [Entitlement][google.cloud.channel.v1.Entitlement]s: An Entitlement represents an entity
* which provides a customer means to start using a service. Entitlements are created or updated as
* a result of a successful fulfillment.
*
* <p>- [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: A ChannelPartnerLink is
* an entity that identifies links between distributors and their indirect resellers in a channel.
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
* Customer response = cloudChannelServiceClient.getCustomer(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the CloudChannelServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
* <p>This class can be customized by passing in a custom instance of CloudChannelServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* CloudChannelServiceSettings cloudChannelServiceSettings =
* CloudChannelServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* CloudChannelServiceClient cloudChannelServiceClient =
* CloudChannelServiceClient.create(cloudChannelServiceSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* CloudChannelServiceSettings cloudChannelServiceSettings =
* CloudChannelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* CloudChannelServiceClient cloudChannelServiceClient =
* CloudChannelServiceClient.create(cloudChannelServiceSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class CloudChannelServiceClient implements BackgroundResource {
private final CloudChannelServiceSettings settings;
private final CloudChannelServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of CloudChannelServiceClient with default settings. */
public static final CloudChannelServiceClient create() throws IOException {
return create(CloudChannelServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of CloudChannelServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final CloudChannelServiceClient create(CloudChannelServiceSettings settings)
throws IOException {
return new CloudChannelServiceClient(settings);
}
/**
* Constructs an instance of CloudChannelServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(CloudChannelServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final CloudChannelServiceClient create(CloudChannelServiceStub stub) {
return new CloudChannelServiceClient(stub);
}
/**
* Constructs an instance of CloudChannelServiceClient, using the given settings. This is
* protected so that it is easy to make a subclass, but otherwise, the static factory methods
* should be preferred.
*/
protected CloudChannelServiceClient(CloudChannelServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((CloudChannelServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected CloudChannelServiceClient(CloudChannelServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final CloudChannelServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public CloudChannelServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List downstream [Customer][google.cloud.channel.v1.Customer]s.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* </ul>
*
* <p>Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the
* reseller or empty list if there are none.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ListCustomersRequest request =
* ListCustomersRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Customer element : cloudChannelServiceClient.listCustomers(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListCustomersPagedResponse listCustomers(ListCustomersRequest request) {
return listCustomersPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List downstream [Customer][google.cloud.channel.v1.Customer]s.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* </ul>
*
* <p>Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the
* reseller or empty list if there are none.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ListCustomersRequest request =
* ListCustomersRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture<Customer> future =
* cloudChannelServiceClient.listCustomersPagedCallable().futureCall(request);
* // Do something.
* for (Customer element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListCustomersRequest, ListCustomersPagedResponse>
listCustomersPagedCallable() {
return stub.listCustomersPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List downstream [Customer][google.cloud.channel.v1.Customer]s.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* </ul>
*
* <p>Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the
* reseller or empty list if there are none.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* while (true) {
* ListCustomersResponse response =
* cloudChannelServiceClient.listCustomersCallable().call(request);
* for (Customer element : response.getResponsesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListCustomersRequest, ListCustomersResponse> listCustomersCallable() {
return stub.listCustomersCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name
* parameter.
* </ul>
*
* <p>Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error
* otherwise.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
* Customer response = cloudChannelServiceClient.getCustomer(name);
* }
* }</pre>
*
* @param name Required. The resource name of the customer to retrieve. The name takes the format:
* accounts/{account_id}/customers/{customer_id}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Customer getCustomer(CustomerName name) {
GetCustomerRequest request =
GetCustomerRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getCustomer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name
* parameter.
* </ul>
*
* <p>Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error
* otherwise.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString();
* Customer response = cloudChannelServiceClient.getCustomer(name);
* }
* }</pre>
*
* @param name Required. The resource name of the customer to retrieve. The name takes the format:
* accounts/{account_id}/customers/{customer_id}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Customer getCustomer(String name) {
GetCustomerRequest request = GetCustomerRequest.newBuilder().setName(name).build();
return getCustomer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name
* parameter.
* </ul>
*
* <p>Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error
* otherwise.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* GetCustomerRequest request =
* GetCustomerRequest.newBuilder()
* .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .build();
* Customer response = cloudChannelServiceClient.getCustomer(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Customer getCustomer(GetCustomerRequest request) {
return getCustomerCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name
* parameter.
* </ul>
*
* <p>Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error
* otherwise.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* GetCustomerRequest request =
* GetCustomerRequest.newBuilder()
* .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .build();
* ApiFuture<Customer> future =
* cloudChannelServiceClient.getCustomerCallable().futureCall(request);
* // Do something.
* Customer response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetCustomerRequest, Customer> getCustomerCallable() {
return stub.getCustomerCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud
* Identity accounts are owned by the reseller.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>INVALID_VALUE: Invalid domain value in the request.
* </ul>
*
* <p>Return Value: List of
* [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources
* for the domain. List may be empty. Note: in the v1alpha1 version of the API, a NOT_FOUND error
* is returned if no
* [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resource
* match the domain.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CheckCloudIdentityAccountsExistRequest request =
* CheckCloudIdentityAccountsExistRequest.newBuilder()
* .setParent("parent-995424086")
* .setDomain("domain-1326197564")
* .build();
* CheckCloudIdentityAccountsExistResponse response =
* cloudChannelServiceClient.checkCloudIdentityAccountsExist(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CheckCloudIdentityAccountsExistResponse checkCloudIdentityAccountsExist(
CheckCloudIdentityAccountsExistRequest request) {
return checkCloudIdentityAccountsExistCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud
* Identity accounts are owned by the reseller.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>INVALID_VALUE: Invalid domain value in the request.
* </ul>
*
* <p>Return Value: List of
* [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources
* for the domain. List may be empty. Note: in the v1alpha1 version of the API, a NOT_FOUND error
* is returned if no
* [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resource
* match the domain.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CheckCloudIdentityAccountsExistRequest request =
* CheckCloudIdentityAccountsExistRequest.newBuilder()
* .setParent("parent-995424086")
* .setDomain("domain-1326197564")
* .build();
* ApiFuture<CheckCloudIdentityAccountsExistResponse> future =
* cloudChannelServiceClient.checkCloudIdentityAccountsExistCallable().futureCall(request);
* // Do something.
* CheckCloudIdentityAccountsExistResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<
CheckCloudIdentityAccountsExistRequest, CheckCloudIdentityAccountsExistResponse>
checkCloudIdentityAccountsExistCallable() {
return stub.checkCloudIdentityAccountsExistCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or
* distributor account.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: It can happen in following scenarios - * Missing or invalid
* required parameters in the request. * Domain field value doesn't match the domain
* specified in primary email.
* </ul>
*
* <p>Return Value: If successful, the newly created [Customer][google.cloud.channel.v1.Customer]
* resource, otherwise returns an error.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CreateCustomerRequest request =
* CreateCustomerRequest.newBuilder()
* .setParent("parent-995424086")
* .setCustomer(Customer.newBuilder().build())
* .build();
* Customer response = cloudChannelServiceClient.createCustomer(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Customer createCustomer(CreateCustomerRequest request) {
return createCustomerCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or
* distributor account.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: It can happen in following scenarios - * Missing or invalid
* required parameters in the request. * Domain field value doesn't match the domain
* specified in primary email.
* </ul>
*
* <p>Return Value: If successful, the newly created [Customer][google.cloud.channel.v1.Customer]
* resource, otherwise returns an error.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CreateCustomerRequest request =
* CreateCustomerRequest.newBuilder()
* .setParent("parent-995424086")
* .setCustomer(Customer.newBuilder().build())
* .build();
* ApiFuture<Customer> future =
* cloudChannelServiceClient.createCustomerCallable().futureCall(request);
* // Do something.
* Customer response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateCustomerRequest, Customer> createCustomerCallable() {
return stub.createCustomerCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the
* reseller or distributor.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Return Value: If successful, the updated [Customer][google.cloud.channel.v1.Customer]
* resource, otherwise returns an error.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* UpdateCustomerRequest request =
* UpdateCustomerRequest.newBuilder()
* .setCustomer(Customer.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Customer response = cloudChannelServiceClient.updateCustomer(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Customer updateCustomer(UpdateCustomerRequest request) {
return updateCustomerCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing [Customer][google.cloud.channel.v1.Customer] resource belonging to the
* reseller or distributor.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the reseller account making the request and the reseller account
* being queried for are different.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Return Value: If successful, the updated [Customer][google.cloud.channel.v1.Customer]
* resource, otherwise returns an error.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* UpdateCustomerRequest request =
* UpdateCustomerRequest.newBuilder()
* .setCustomer(Customer.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<Customer> future =
* cloudChannelServiceClient.updateCustomerCallable().futureCall(request);
* // Do something.
* Customer response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateCustomerRequest, Customer> updateCustomerCallable() {
return stub.updateCustomerCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the account making the request does not own this customer.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>FAILED_PRECONDITION: If the customer has existing entitlements.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
* cloudChannelServiceClient.deleteCustomer(name);
* }
* }</pre>
*
* @param name Required. The resource name of the customer to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteCustomer(CustomerName name) {
DeleteCustomerRequest request =
DeleteCustomerRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteCustomer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the account making the request does not own this customer.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>FAILED_PRECONDITION: If the customer has existing entitlements.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString();
* cloudChannelServiceClient.deleteCustomer(name);
* }
* }</pre>
*
* @param name Required. The resource name of the customer to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteCustomer(String name) {
DeleteCustomerRequest request = DeleteCustomerRequest.newBuilder().setName(name).build();
deleteCustomer(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the account making the request does not own this customer.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>FAILED_PRECONDITION: If the customer has existing entitlements.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* DeleteCustomerRequest request =
* DeleteCustomerRequest.newBuilder()
* .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .build();
* cloudChannelServiceClient.deleteCustomer(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteCustomer(DeleteCustomerRequest request) {
deleteCustomerCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the account making the request does not own this customer.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>FAILED_PRECONDITION: If the customer has existing entitlements.
* <li>NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name
* specified in the request.
* </ul>
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* DeleteCustomerRequest request =
* DeleteCustomerRequest.newBuilder()
* .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .build();
* ApiFuture<Empty> future =
* cloudChannelServiceClient.deleteCustomerCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteCustomerRequest, Empty> deleteCustomerCallable() {
return stub.deleteCustomerCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Cloud Identity for the given customer using the customer's information or the
* information provided here, if present.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the customer doesn't belong to the reseller.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer is not found for the reseller.
* <li>ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after
* changing the customer's primary contact email.
* <li>INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* <li>UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* </ul>
*
* <p>Return Value: Long Running Operation ID.
*
* <p>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].
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ProvisionCloudIdentityRequest request =
* ProvisionCloudIdentityRequest.newBuilder()
* .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
* .setUser(AdminUser.newBuilder().build())
* .setValidateOnly(true)
* .build();
* Customer response = cloudChannelServiceClient.provisionCloudIdentityAsync(request).get();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Customer, OperationMetadata> provisionCloudIdentityAsync(
ProvisionCloudIdentityRequest request) {
return provisionCloudIdentityOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Cloud Identity for the given customer using the customer's information or the
* information provided here, if present.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the customer doesn't belong to the reseller.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer is not found for the reseller.
* <li>ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after
* changing the customer's primary contact email.
* <li>INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* <li>UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* </ul>
*
* <p>Return Value: Long Running Operation ID.
*
* <p>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].
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ProvisionCloudIdentityRequest request =
* ProvisionCloudIdentityRequest.newBuilder()
* .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
* .setUser(AdminUser.newBuilder().build())
* .setValidateOnly(true)
* .build();
* OperationFuture<Customer, OperationMetadata> future =
* cloudChannelServiceClient.provisionCloudIdentityOperationCallable().futureCall(request);
* // Do something.
* Customer response = future.get();
* }
* }</pre>
*/
public final OperationCallable<ProvisionCloudIdentityRequest, Customer, OperationMetadata>
provisionCloudIdentityOperationCallable() {
return stub.provisionCloudIdentityOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Cloud Identity for the given customer using the customer's information or the
* information provided here, if present.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the customer doesn't belong to the reseller.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* <li>NOT_FOUND: If the customer is not found for the reseller.
* <li>ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after
* changing the customer's primary contact email.
* <li>INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* <li>UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud
* Channel support in this case.
* </ul>
*
* <p>Return Value: Long Running Operation ID.
*
* <p>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].
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ProvisionCloudIdentityRequest request =
* ProvisionCloudIdentityRequest.newBuilder()
* .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
* .setUser(AdminUser.newBuilder().build())
* .setValidateOnly(true)
* .build();
* ApiFuture<Operation> future =
* cloudChannelServiceClient.provisionCloudIdentityCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<ProvisionCloudIdentityRequest, Operation>
provisionCloudIdentityCallable() {
return stub.provisionCloudIdentityCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
*
* <p>Possible Error Codes:
*
* <ul>
* <li>PERMISSION_DENIED: If the customer doesn't belong to the reseller.
* <li>INVALID_ARGUMENT: Missing or invalid required parameters in the request.
* </ul>
*
* <p>Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the
* customer, or empty list if there are none.
*
* <p>Sample code:
*
* <pre>{@code
* try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
* ListEntitlementsRequest request =
* ListEntitlementsRequest.newBuilder()
* .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Entitlement element : cloudChannelServiceClient.listEntitlements(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntitlementsPagedResponse listEntitlements(ListEntitlementsRequest request) {
return listEntitlementsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
*
* <p>Possible Error Codes:
*
* <ul>