This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
/
FoldersClient.java
1954 lines (1863 loc) · 85.6 KB
/
FoldersClient.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 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.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.api.resourcenames.ResourceName;
import com.google.cloud.resourcemanager.v3.stub.FoldersStub;
import com.google.cloud.resourcemanager.v3.stub.FoldersStubSettings;
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 com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Manages Cloud Platform folder resources. Folders can be used to organize the
* resources under an organization and to control the policies applied to groups of 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 (FoldersClient foldersClient = FoldersClient.create()) {
* FolderName name = FolderName.of("[FOLDER]");
* Folder response = foldersClient.getFolder(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the FoldersClient 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 FoldersSettings to create().
* For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* FoldersSettings foldersSettings =
* FoldersSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* FoldersClient foldersClient = FoldersClient.create(foldersSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* FoldersSettings foldersSettings = FoldersSettings.newBuilder().setEndpoint(myEndpoint).build();
* FoldersClient foldersClient = FoldersClient.create(foldersSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class FoldersClient implements BackgroundResource {
private final FoldersSettings settings;
private final FoldersStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of FoldersClient with default settings. */
public static final FoldersClient create() throws IOException {
return create(FoldersSettings.newBuilder().build());
}
/**
* Constructs an instance of FoldersClient, 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 FoldersClient create(FoldersSettings settings) throws IOException {
return new FoldersClient(settings);
}
/**
* Constructs an instance of FoldersClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(FoldersSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final FoldersClient create(FoldersStub stub) {
return new FoldersClient(stub);
}
/**
* Constructs an instance of FoldersClient, 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 FoldersClient(FoldersSettings settings) throws IOException {
this.settings = settings;
this.stub = ((FoldersStubSettings) 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 FoldersClient(FoldersStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final FoldersSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public FoldersStub 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.
/**
* Retrieves a folder identified by the supplied resource name. Valid folder resource names have
* the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have
* `resourcemanager.folders.get` permission on the identified folder.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* FolderName name = FolderName.of("[FOLDER]");
* Folder response = foldersClient.getFolder(name);
* }
* }</pre>
*
* @param name Required. The resource name of the folder to retrieve. Must be of the form
* `folders/{folder_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Folder getFolder(FolderName name) {
GetFolderRequest request =
GetFolderRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getFolder(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a folder identified by the supplied resource name. Valid folder resource names have
* the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have
* `resourcemanager.folders.get` permission on the identified folder.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* String name = FolderName.of("[FOLDER]").toString();
* Folder response = foldersClient.getFolder(name);
* }
* }</pre>
*
* @param name Required. The resource name of the folder to retrieve. Must be of the form
* `folders/{folder_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Folder getFolder(String name) {
GetFolderRequest request = GetFolderRequest.newBuilder().setName(name).build();
return getFolder(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a folder identified by the supplied resource name. Valid folder resource names have
* the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have
* `resourcemanager.folders.get` permission on the identified folder.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* GetFolderRequest request =
* GetFolderRequest.newBuilder().setName(FolderName.of("[FOLDER]").toString()).build();
* Folder response = foldersClient.getFolder(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 Folder getFolder(GetFolderRequest request) {
return getFolderCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a folder identified by the supplied resource name. Valid folder resource names have
* the format `folders/{folder_id}` (for example, `folders/1234`). The caller must have
* `resourcemanager.folders.get` permission on the identified folder.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* GetFolderRequest request =
* GetFolderRequest.newBuilder().setName(FolderName.of("[FOLDER]").toString()).build();
* ApiFuture<Folder> future = foldersClient.getFolderCallable().futureCall(request);
* // Do something.
* Folder response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetFolderRequest, Folder> getFolderCallable() {
return stub.getFolderCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the folders that are direct descendants of supplied parent resource. `list()` provides a
* strongly consistent view of the folders underneath the specified parent resource. `list()`
* returns folders sorted based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* ResourceName parent = FolderName.of("[FOLDER]");
* for (Folder element : foldersClient.listFolders(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the organization or folder whose folders are being
* listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to
* this method is controlled by checking the `resourcemanager.folders.list` permission on the
* `parent`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFoldersPagedResponse listFolders(ResourceName parent) {
ListFoldersRequest request =
ListFoldersRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listFolders(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the folders that are direct descendants of supplied parent resource. `list()` provides a
* strongly consistent view of the folders underneath the specified parent resource. `list()`
* returns folders sorted based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* String parent = FolderName.of("[FOLDER]").toString();
* for (Folder element : foldersClient.listFolders(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the organization or folder whose folders are being
* listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to
* this method is controlled by checking the `resourcemanager.folders.list` permission on the
* `parent`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListFoldersPagedResponse listFolders(String parent) {
ListFoldersRequest request = ListFoldersRequest.newBuilder().setParent(parent).build();
return listFolders(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the folders that are direct descendants of supplied parent resource. `list()` provides a
* strongly consistent view of the folders underneath the specified parent resource. `list()`
* returns folders sorted based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* ListFoldersRequest request =
* ListFoldersRequest.newBuilder()
* .setParent(FolderName.of("[FOLDER]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* for (Folder element : foldersClient.listFolders(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 ListFoldersPagedResponse listFolders(ListFoldersRequest request) {
return listFoldersPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the folders that are direct descendants of supplied parent resource. `list()` provides a
* strongly consistent view of the folders underneath the specified parent resource. `list()`
* returns folders sorted based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* ListFoldersRequest request =
* ListFoldersRequest.newBuilder()
* .setParent(FolderName.of("[FOLDER]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* ApiFuture<Folder> future = foldersClient.listFoldersPagedCallable().futureCall(request);
* // Do something.
* for (Folder element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListFoldersRequest, ListFoldersPagedResponse>
listFoldersPagedCallable() {
return stub.listFoldersPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the folders that are direct descendants of supplied parent resource. `list()` provides a
* strongly consistent view of the folders underneath the specified parent resource. `list()`
* returns folders sorted based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* ListFoldersRequest request =
* ListFoldersRequest.newBuilder()
* .setParent(FolderName.of("[FOLDER]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* while (true) {
* ListFoldersResponse response = foldersClient.listFoldersCallable().call(request);
* for (Folder 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<ListFoldersRequest, ListFoldersResponse> listFoldersCallable() {
return stub.listFoldersCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Search for folders that match specific filter criteria. `search()` provides an eventually
* consistent view of the folders a user has access to which meet the specified filter criteria.
*
* <p>This will only return folders on which the caller has the permission
* `resourcemanager.folders.get`.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* String query = "query107944136";
* for (Folder element : foldersClient.searchFolders(query).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param query Optional. Search criteria used to select the folders to return. If no search
* criteria is specified then all accessible folders will be returned.
* <p>Query expressions can be used to restrict results based upon displayName, state and
* parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the
* suffix wildcard symbol `*`.
* <p>The `displayName` field in a query expression should use escaped quotes for values that
* include whitespace to prevent unexpected behavior.
* <p>``` | Field | Description |
* |-------------------------|----------------------------------------| | displayName |
* Filters by displayName. | | parent | Filters by parent (for example: folders/123). | |
* state, lifecycleState | Filters by state. | ```
* <p>Some example queries are:
* <ul>
* <li>Query `displayName=Test*` returns Folder resources whose display name starts with
* "Test".
* <li>Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`.
* <li>Query `parent=folders/123` returns Folder resources that have `folders/123` as a
* parent resource.
* <li>Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have
* `folders/123` as a parent resource.
* <li>Query `displayName=\\\\"Test String\\\\"` returns Folder resources with display names
* that include both "Test" and "String".
* </ul>
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchFoldersPagedResponse searchFolders(String query) {
SearchFoldersRequest request = SearchFoldersRequest.newBuilder().setQuery(query).build();
return searchFolders(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Search for folders that match specific filter criteria. `search()` provides an eventually
* consistent view of the folders a user has access to which meet the specified filter criteria.
*
* <p>This will only return folders on which the caller has the permission
* `resourcemanager.folders.get`.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* SearchFoldersRequest request =
* SearchFoldersRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* for (Folder element : foldersClient.searchFolders(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 SearchFoldersPagedResponse searchFolders(SearchFoldersRequest request) {
return searchFoldersPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Search for folders that match specific filter criteria. `search()` provides an eventually
* consistent view of the folders a user has access to which meet the specified filter criteria.
*
* <p>This will only return folders on which the caller has the permission
* `resourcemanager.folders.get`.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* SearchFoldersRequest request =
* SearchFoldersRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* ApiFuture<Folder> future = foldersClient.searchFoldersPagedCallable().futureCall(request);
* // Do something.
* for (Folder element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<SearchFoldersRequest, SearchFoldersPagedResponse>
searchFoldersPagedCallable() {
return stub.searchFoldersPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Search for folders that match specific filter criteria. `search()` provides an eventually
* consistent view of the folders a user has access to which meet the specified filter criteria.
*
* <p>This will only return folders on which the caller has the permission
* `resourcemanager.folders.get`.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* SearchFoldersRequest request =
* SearchFoldersRequest.newBuilder()
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setQuery("query107944136")
* .build();
* while (true) {
* SearchFoldersResponse response = foldersClient.searchFoldersCallable().call(request);
* for (Folder 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<SearchFoldersRequest, SearchFoldersResponse> searchFoldersCallable() {
return stub.searchFoldersCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track
* the progress of the folder creation workflow. Upon success, the `Operation.response` field will
* be populated with the created Folder.
*
* <p>In order to succeed, the addition of this new folder must not violate the folder naming,
* height, or fanout constraints.
*
* <p>+ The folder's `display_name` must be distinct from all other folders that share its parent.
* + The addition of the folder must not cause the active folder hierarchy to exceed a height of
* 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this
* provides additional headroom when moving folders that contain deleted folders. + The addition
* of the folder must not cause the total number of folders under its parent to exceed 300.
*
* <p>If the operation fails due to a folder constraint violation, some errors may be returned by
* the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description.
* Other folder constraint violations will be communicated in the `Operation`, with the specific
* `PreconditionFailure` returned in the details list in the `Operation.error` field.
*
* <p>The caller must have `resourcemanager.folders.create` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* Folder folder = Folder.newBuilder().build();
* Folder response = foldersClient.createFolderAsync(folder).get();
* }
* }</pre>
*
* @param folder Required. The folder being created, only the display name and parent will be
* consulted. All other fields will be ignored.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Folder, CreateFolderMetadata> createFolderAsync(Folder folder) {
CreateFolderRequest request = CreateFolderRequest.newBuilder().setFolder(folder).build();
return createFolderAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track
* the progress of the folder creation workflow. Upon success, the `Operation.response` field will
* be populated with the created Folder.
*
* <p>In order to succeed, the addition of this new folder must not violate the folder naming,
* height, or fanout constraints.
*
* <p>+ The folder's `display_name` must be distinct from all other folders that share its parent.
* + The addition of the folder must not cause the active folder hierarchy to exceed a height of
* 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this
* provides additional headroom when moving folders that contain deleted folders. + The addition
* of the folder must not cause the total number of folders under its parent to exceed 300.
*
* <p>If the operation fails due to a folder constraint violation, some errors may be returned by
* the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description.
* Other folder constraint violations will be communicated in the `Operation`, with the specific
* `PreconditionFailure` returned in the details list in the `Operation.error` field.
*
* <p>The caller must have `resourcemanager.folders.create` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* CreateFolderRequest request =
* CreateFolderRequest.newBuilder().setFolder(Folder.newBuilder().build()).build();
* Folder response = foldersClient.createFolderAsync(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<Folder, CreateFolderMetadata> createFolderAsync(
CreateFolderRequest request) {
return createFolderOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track
* the progress of the folder creation workflow. Upon success, the `Operation.response` field will
* be populated with the created Folder.
*
* <p>In order to succeed, the addition of this new folder must not violate the folder naming,
* height, or fanout constraints.
*
* <p>+ The folder's `display_name` must be distinct from all other folders that share its parent.
* + The addition of the folder must not cause the active folder hierarchy to exceed a height of
* 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this
* provides additional headroom when moving folders that contain deleted folders. + The addition
* of the folder must not cause the total number of folders under its parent to exceed 300.
*
* <p>If the operation fails due to a folder constraint violation, some errors may be returned by
* the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description.
* Other folder constraint violations will be communicated in the `Operation`, with the specific
* `PreconditionFailure` returned in the details list in the `Operation.error` field.
*
* <p>The caller must have `resourcemanager.folders.create` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* CreateFolderRequest request =
* CreateFolderRequest.newBuilder().setFolder(Folder.newBuilder().build()).build();
* OperationFuture<Folder, CreateFolderMetadata> future =
* foldersClient.createFolderOperationCallable().futureCall(request);
* // Do something.
* Folder response = future.get();
* }
* }</pre>
*/
public final OperationCallable<CreateFolderRequest, Folder, CreateFolderMetadata>
createFolderOperationCallable() {
return stub.createFolderOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track
* the progress of the folder creation workflow. Upon success, the `Operation.response` field will
* be populated with the created Folder.
*
* <p>In order to succeed, the addition of this new folder must not violate the folder naming,
* height, or fanout constraints.
*
* <p>+ The folder's `display_name` must be distinct from all other folders that share its parent.
* + The addition of the folder must not cause the active folder hierarchy to exceed a height of
* 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this
* provides additional headroom when moving folders that contain deleted folders. + The addition
* of the folder must not cause the total number of folders under its parent to exceed 300.
*
* <p>If the operation fails due to a folder constraint violation, some errors may be returned by
* the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description.
* Other folder constraint violations will be communicated in the `Operation`, with the specific
* `PreconditionFailure` returned in the details list in the `Operation.error` field.
*
* <p>The caller must have `resourcemanager.folders.create` permission on the identified parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* CreateFolderRequest request =
* CreateFolderRequest.newBuilder().setFolder(Folder.newBuilder().build()).build();
* ApiFuture<Operation> future = foldersClient.createFolderCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateFolderRequest, Operation> createFolderCallable() {
return stub.createFolderCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be
* rejected if they violate either the `display_name` formatting rules or the naming constraints
* described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder]
* documentation.
*
* <p>The folder's `display_name` must start and end with a letter or digit, may contain letters,
* digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is
* captured by the regular expression: `[\\p{L}\\p{N}][\\p{L}\\p{N}_- ]{1,28}[\\p{L}\\p{N}]`. The
* caller must have `resourcemanager.folders.update` permission on the identified folder.
*
* <p>If the update fails due to the unique name constraint then a `PreconditionFailure`
* explaining this violation will be returned in the Status.details field.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* Folder folder = Folder.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Folder response = foldersClient.updateFolderAsync(folder, updateMask).get();
* }
* }</pre>
*
* @param folder Required. The new definition of the Folder. It must include the `name` field,
* which cannot be changed.
* @param updateMask Required. Fields to be updated. Only the `display_name` can be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Folder, UpdateFolderMetadata> updateFolderAsync(
Folder folder, FieldMask updateMask) {
UpdateFolderRequest request =
UpdateFolderRequest.newBuilder().setFolder(folder).setUpdateMask(updateMask).build();
return updateFolderAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be
* rejected if they violate either the `display_name` formatting rules or the naming constraints
* described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder]
* documentation.
*
* <p>The folder's `display_name` must start and end with a letter or digit, may contain letters,
* digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is
* captured by the regular expression: `[\\p{L}\\p{N}][\\p{L}\\p{N}_- ]{1,28}[\\p{L}\\p{N}]`. The
* caller must have `resourcemanager.folders.update` permission on the identified folder.
*
* <p>If the update fails due to the unique name constraint then a `PreconditionFailure`
* explaining this violation will be returned in the Status.details field.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* UpdateFolderRequest request =
* UpdateFolderRequest.newBuilder()
* .setFolder(Folder.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Folder response = foldersClient.updateFolderAsync(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<Folder, UpdateFolderMetadata> updateFolderAsync(
UpdateFolderRequest request) {
return updateFolderOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be
* rejected if they violate either the `display_name` formatting rules or the naming constraints
* described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder]
* documentation.
*
* <p>The folder's `display_name` must start and end with a letter or digit, may contain letters,
* digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is
* captured by the regular expression: `[\\p{L}\\p{N}][\\p{L}\\p{N}_- ]{1,28}[\\p{L}\\p{N}]`. The
* caller must have `resourcemanager.folders.update` permission on the identified folder.
*
* <p>If the update fails due to the unique name constraint then a `PreconditionFailure`
* explaining this violation will be returned in the Status.details field.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* UpdateFolderRequest request =
* UpdateFolderRequest.newBuilder()
* .setFolder(Folder.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* OperationFuture<Folder, UpdateFolderMetadata> future =
* foldersClient.updateFolderOperationCallable().futureCall(request);
* // Do something.
* Folder response = future.get();
* }
* }</pre>
*/
public final OperationCallable<UpdateFolderRequest, Folder, UpdateFolderMetadata>
updateFolderOperationCallable() {
return stub.updateFolderOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be
* rejected if they violate either the `display_name` formatting rules or the naming constraints
* described in the [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder]
* documentation.
*
* <p>The folder's `display_name` must start and end with a letter or digit, may contain letters,
* digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is
* captured by the regular expression: `[\\p{L}\\p{N}][\\p{L}\\p{N}_- ]{1,28}[\\p{L}\\p{N}]`. The
* caller must have `resourcemanager.folders.update` permission on the identified folder.
*
* <p>If the update fails due to the unique name constraint then a `PreconditionFailure`
* explaining this violation will be returned in the Status.details field.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* UpdateFolderRequest request =
* UpdateFolderRequest.newBuilder()
* .setFolder(Folder.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<Operation> future = foldersClient.updateFolderCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateFolderRequest, Operation> updateFolderCallable() {
return stub.updateFolderCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves a folder under a new resource parent. Returns an `Operation` which can be used to track
* the progress of the folder move workflow. Upon success, the `Operation.response` field will be
* populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the
* failure cause will be returned - if the failure occurs synchronously then the
* `FolderOperationError` will be returned in the `Status.details` field. If it occurs
* asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In
* addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as
* an aid to stateless clients. Folder moves will be rejected if they violate either the naming,
* height, or fanout constraints described in the
* [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller
* must have `resourcemanager.folders.move` permission on the folder's current and proposed new
* parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* FolderName name = FolderName.of("[FOLDER]");
* ResourceName destinationParent = FolderName.of("[FOLDER]");
* Folder response = foldersClient.moveFolderAsync(name, destinationParent).get();
* }
* }</pre>
*
* @param name Required. The resource name of the Folder to move. Must be of the form
* folders/{folder_id}
* @param destinationParent Required. The resource name of the folder or organization which should
* be the folder's new parent. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Folder, MoveFolderMetadata> moveFolderAsync(
FolderName name, ResourceName destinationParent) {
MoveFolderRequest request =
MoveFolderRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setDestinationParent(destinationParent == null ? null : destinationParent.toString())
.build();
return moveFolderAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves a folder under a new resource parent. Returns an `Operation` which can be used to track
* the progress of the folder move workflow. Upon success, the `Operation.response` field will be
* populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the
* failure cause will be returned - if the failure occurs synchronously then the
* `FolderOperationError` will be returned in the `Status.details` field. If it occurs
* asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In
* addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as
* an aid to stateless clients. Folder moves will be rejected if they violate either the naming,
* height, or fanout constraints described in the
* [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller
* must have `resourcemanager.folders.move` permission on the folder's current and proposed new
* parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* FolderName name = FolderName.of("[FOLDER]");
* String destinationParent = FolderName.of("[FOLDER]").toString();
* Folder response = foldersClient.moveFolderAsync(name, destinationParent).get();
* }
* }</pre>
*
* @param name Required. The resource name of the Folder to move. Must be of the form
* folders/{folder_id}
* @param destinationParent Required. The resource name of the folder or organization which should
* be the folder's new parent. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Folder, MoveFolderMetadata> moveFolderAsync(
FolderName name, String destinationParent) {
MoveFolderRequest request =
MoveFolderRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setDestinationParent(destinationParent)
.build();
return moveFolderAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves a folder under a new resource parent. Returns an `Operation` which can be used to track
* the progress of the folder move workflow. Upon success, the `Operation.response` field will be
* populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the
* failure cause will be returned - if the failure occurs synchronously then the
* `FolderOperationError` will be returned in the `Status.details` field. If it occurs
* asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In
* addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as
* an aid to stateless clients. Folder moves will be rejected if they violate either the naming,
* height, or fanout constraints described in the
* [CreateFolder][google.cloud.resourcemanager.v3.Folders.CreateFolder] documentation. The caller
* must have `resourcemanager.folders.move` permission on the folder's current and proposed new
* parent.
*
* <p>Sample code:
*
* <pre>{@code
* try (FoldersClient foldersClient = FoldersClient.create()) {
* String name = FolderName.of("[FOLDER]").toString();
* ResourceName destinationParent = FolderName.of("[FOLDER]");
* Folder response = foldersClient.moveFolderAsync(name, destinationParent).get();
* }
* }</pre>
*
* @param name Required. The resource name of the Folder to move. Must be of the form
* folders/{folder_id}
* @param destinationParent Required. The resource name of the folder or organization which should
* be the folder's new parent. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Folder, MoveFolderMetadata> moveFolderAsync(
String name, ResourceName destinationParent) {
MoveFolderRequest request =
MoveFolderRequest.newBuilder()
.setName(name)
.setDestinationParent(destinationParent == null ? null : destinationParent.toString())
.build();
return moveFolderAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**