This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
/
OrganizationsClient.java
855 lines (807 loc) · 33.7 KB
/
OrganizationsClient.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
/*
* Copyright 2021 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.resourcemanager.v3;
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.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.resourcemanager.v3.stub.OrganizationsStub;
import com.google.cloud.resourcemanager.v3.stub.OrganizationsStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Allows users to manage their organization resources.
*
* <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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* OrganizationName name = OrganizationName.of("[ORGANIZATION]");
* Organization response = organizationsClient.getOrganization(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the OrganizationsClient 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 OrganizationsSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* OrganizationsSettings organizationsSettings =
* OrganizationsSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* OrganizationsSettings organizationsSettings =
* OrganizationsSettings.newBuilder().setEndpoint(myEndpoint).build();
* OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class OrganizationsClient implements BackgroundResource {
private final OrganizationsSettings settings;
private final OrganizationsStub stub;
/** Constructs an instance of OrganizationsClient with default settings. */
public static final OrganizationsClient create() throws IOException {
return create(OrganizationsSettings.newBuilder().build());
}
/**
* Constructs an instance of OrganizationsClient, 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 OrganizationsClient create(OrganizationsSettings settings)
throws IOException {
return new OrganizationsClient(settings);
}
/**
* Constructs an instance of OrganizationsClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(OrganizationsSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final OrganizationsClient create(OrganizationsStub stub) {
return new OrganizationsClient(stub);
}
/**
* Constructs an instance of OrganizationsClient, 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 OrganizationsClient(OrganizationsSettings settings) throws IOException {
this.settings = settings;
this.stub = ((OrganizationsStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected OrganizationsClient(OrganizationsStub stub) {
this.settings = null;
this.stub = stub;
}
public final OrganizationsSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public OrganizationsStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* OrganizationName name = OrganizationName.of("[ORGANIZATION]");
* Organization response = organizationsClient.getOrganization(name);
* }
* }</pre>
*
* @param name Required. The resource name of the Organization to fetch. This is the
* organization's relative path in the API, formatted as "organizations/[organizationId]". For
* example, "organizations/1234".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Organization getOrganization(OrganizationName name) {
GetOrganizationRequest request =
GetOrganizationRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getOrganization(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* String name = OrganizationName.of("[ORGANIZATION]").toString();
* Organization response = organizationsClient.getOrganization(name);
* }
* }</pre>
*
* @param name Required. The resource name of the Organization to fetch. This is the
* organization's relative path in the API, formatted as "organizations/[organizationId]". For
* example, "organizations/1234".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Organization getOrganization(String name) {
GetOrganizationRequest request = GetOrganizationRequest.newBuilder().setName(name).build();
return getOrganization(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* GetOrganizationRequest request =
* GetOrganizationRequest.newBuilder()
* .setName(OrganizationName.of("[ORGANIZATION]").toString())
* .build();
* Organization response = organizationsClient.getOrganization(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 Organization getOrganization(GetOrganizationRequest request) {
return getOrganizationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Fetches an organization resource identified by the specified resource name.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* GetOrganizationRequest request =
* GetOrganizationRequest.newBuilder()
* .setName(OrganizationName.of("[ORGANIZATION]").toString())
* .build();
* ApiFuture<Organization> future =
* organizationsClient.getOrganizationCallable().futureCall(request);
* // Do something.
* Organization response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetOrganizationRequest, Organization> getOrganizationCallable() {
return stub.getOrganizationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches organization resources that are visible to the user and satisfy the specified filter.
* This method returns organizations in an unspecified order. New organizations do not necessarily
* appear at the end of the results, and may take a small amount of time to appear.
*
* <p>Search will only return organizations on which the user has the permission
* `resourcemanager.organizations.get`
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* String query = "query107944136";
* for (Organization element : organizationsClient.searchOrganizations(query).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param query Optional. An optional query string used to filter the Organizations to return in
* the response. Query rules are case-insensitive.
* <p>| Field | Description |
* |------------------|--------------------------------------------| | directoryCustomerId,
* owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by
* domain. |
* <p>Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain
* is a G Suite domain, for example:
* <ul>
* <li>Query `directorycustomerid:123456789` returns Organization resources with
* `owner.directory_customer_id` equal to `123456789`.
* <li>Query `domain:google.com` returns Organization resources corresponding to the domain
* `google.com`.
* </ul>
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchOrganizationsPagedResponse searchOrganizations(String query) {
SearchOrganizationsRequest request =
SearchOrganizationsRequest.newBuilder().setQuery(query).build();
return searchOrganizations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches organization resources that are visible to the user and satisfy the specified filter.
* This method returns organizations in an unspecified order. New organizations do not necessarily
* appear at the end of the results, and may take a small amount of time to appear.
*
* <p>Search will only return organizations on which the user has the permission
* `resourcemanager.organizations.get`
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* SearchOrganizationsRequest request =
* SearchOrganizationsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* for (Organization element : organizationsClient.searchOrganizations(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 SearchOrganizationsPagedResponse searchOrganizations(
SearchOrganizationsRequest request) {
return searchOrganizationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches organization resources that are visible to the user and satisfy the specified filter.
* This method returns organizations in an unspecified order. New organizations do not necessarily
* appear at the end of the results, and may take a small amount of time to appear.
*
* <p>Search will only return organizations on which the user has the permission
* `resourcemanager.organizations.get`
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* SearchOrganizationsRequest request =
* SearchOrganizationsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* ApiFuture<Organization> future =
* organizationsClient.searchOrganizationsPagedCallable().futureCall(request);
* // Do something.
* for (Organization element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<SearchOrganizationsRequest, SearchOrganizationsPagedResponse>
searchOrganizationsPagedCallable() {
return stub.searchOrganizationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches organization resources that are visible to the user and satisfy the specified filter.
* This method returns organizations in an unspecified order. New organizations do not necessarily
* appear at the end of the results, and may take a small amount of time to appear.
*
* <p>Search will only return organizations on which the user has the permission
* `resourcemanager.organizations.get`
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* SearchOrganizationsRequest request =
* SearchOrganizationsRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* while (true) {
* SearchOrganizationsResponse response =
* organizationsClient.searchOrganizationsCallable().call(request);
* for (Organization 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<SearchOrganizationsRequest, SearchOrganizationsResponse>
searchOrganizationsCallable() {
return stub.searchOrganizationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an organization resource. The policy may be empty if no such
* policy or resource exists. The `resource` field should be the organization's resource name, for
* example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* ResourceName resource = TagValueName.of("[TAG_VALUE]");
* Policy response = organizationsClient.getIamPolicy(resource);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(ResourceName resource) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an organization resource. The policy may be empty if no such
* policy or resource exists. The `resource` field should be the organization's resource name, for
* example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* String resource = TagValueName.of("[TAG_VALUE]").toString();
* Policy response = organizationsClient.getIamPolicy(resource);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an organization resource. The policy may be empty if no such
* policy or resource exists. The `resource` field should be the organization's resource name, for
* example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = organizationsClient.getIamPolicy(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 Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an organization resource. The policy may be empty if no such
* policy or resource exists. The `resource` field should be the organization's resource name, for
* example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture<Policy> future = organizationsClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetIamPolicyRequest, Policy> getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an organization resource. Replaces any existing policy. The
* `resource` field should be the organization's resource name, for example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* ResourceName resource = TagValueName.of("[TAG_VALUE]");
* Policy response = organizationsClient.setIamPolicy(resource);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an organization resource. Replaces any existing policy. The
* `resource` field should be the organization's resource name, for example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* String resource = TagValueName.of("[TAG_VALUE]").toString();
* Policy response = organizationsClient.setIamPolicy(resource);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource) {
SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder().setResource(resource).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an organization resource. Replaces any existing policy. The
* `resource` field should be the organization's resource name, for example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .build();
* Policy response = organizationsClient.setIamPolicy(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 Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an organization resource. Replaces any existing policy. The
* `resource` field should be the organization's resource name, for example: "organizations/123".
*
* <p>Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on
* the specified organization.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .build();
* ApiFuture<Policy> future = organizationsClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<SetIamPolicyRequest, Policy> setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the permissions that a caller has on the specified organization. The `resource` field
* should be the organization's resource name, for example: "organizations/123".
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* ResourceName resource = TagValueName.of("[TAG_VALUE]");
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* organizationsClient.testIamPermissions(resource, permissions);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
ResourceName resource, List<String> permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the permissions that a caller has on the specified organization. The `resource` field
* should be the organization's resource name, for example: "organizations/123".
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* String resource = TagValueName.of("[TAG_VALUE]").toString();
* List<String> permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* organizationsClient.testIamPermissions(resource, permissions);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, List<String> permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource)
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the permissions that a caller has on the specified organization. The `resource` field
* should be the organization's resource name, for example: "organizations/123".
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* TestIamPermissionsResponse response = organizationsClient.testIamPermissions(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 TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the permissions that a caller has on the specified organization. The `resource` field
* should be the organization's resource name, for example: "organizations/123".
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@code
* try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(TagValueName.of("[TAG_VALUE]").toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* ApiFuture<TestIamPermissionsResponse> future =
* organizationsClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<TestIamPermissionsRequest, TestIamPermissionsResponse>
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class SearchOrganizationsPagedResponse
extends AbstractPagedListResponse<
SearchOrganizationsRequest,
SearchOrganizationsResponse,
Organization,
SearchOrganizationsPage,
SearchOrganizationsFixedSizeCollection> {
public static ApiFuture<SearchOrganizationsPagedResponse> createAsync(
PageContext<SearchOrganizationsRequest, SearchOrganizationsResponse, Organization> context,
ApiFuture<SearchOrganizationsResponse> futureResponse) {
ApiFuture<SearchOrganizationsPage> futurePage =
SearchOrganizationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new SearchOrganizationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private SearchOrganizationsPagedResponse(SearchOrganizationsPage page) {
super(page, SearchOrganizationsFixedSizeCollection.createEmptyCollection());
}
}
public static class SearchOrganizationsPage
extends AbstractPage<
SearchOrganizationsRequest,
SearchOrganizationsResponse,
Organization,
SearchOrganizationsPage> {
private SearchOrganizationsPage(
PageContext<SearchOrganizationsRequest, SearchOrganizationsResponse, Organization> context,
SearchOrganizationsResponse response) {
super(context, response);
}
private static SearchOrganizationsPage createEmptyPage() {
return new SearchOrganizationsPage(null, null);
}
@Override
protected SearchOrganizationsPage createPage(
PageContext<SearchOrganizationsRequest, SearchOrganizationsResponse, Organization> context,
SearchOrganizationsResponse response) {
return new SearchOrganizationsPage(context, response);
}
@Override
public ApiFuture<SearchOrganizationsPage> createPageAsync(
PageContext<SearchOrganizationsRequest, SearchOrganizationsResponse, Organization> context,
ApiFuture<SearchOrganizationsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class SearchOrganizationsFixedSizeCollection
extends AbstractFixedSizeCollection<
SearchOrganizationsRequest,
SearchOrganizationsResponse,
Organization,
SearchOrganizationsPage,
SearchOrganizationsFixedSizeCollection> {
private SearchOrganizationsFixedSizeCollection(
List<SearchOrganizationsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static SearchOrganizationsFixedSizeCollection createEmptyCollection() {
return new SearchOrganizationsFixedSizeCollection(null, 0);
}
@Override
protected SearchOrganizationsFixedSizeCollection createCollection(
List<SearchOrganizationsPage> pages, int collectionSize) {
return new SearchOrganizationsFixedSizeCollection(pages, collectionSize);
}
}
}