Skip to content
This repository was archived by the owner on Sep 18, 2023. It is now read-only.

Commit 706f853

Browse files
yoshi-automationyoshi-automation
authored
Merge 2ca486e into d67e613 
2 parents d67e613 + 2ca486e commit 706f853

File tree

4 files changed

+266
-7
lines changed

4 files changed

+266
-7
lines changed

‎google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java‎

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@
7070
* <p>This class provides the ability to make remote calls to the backing service through method
7171
* calls that map to API methods. Sample code to get started:
7272
*
73+
* <pre>{@code
74+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
75+
* String name = "name3373707";
76+
* ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
77+
* }
78+
* }</pre>
79+
*
7380
* <p>Note: close() needs to be called on the AccessApprovalAdminClient object to clean up resources
7481
* such as threads. In the example above, try-with-resources is used, which automatically calls
7582
* close().
@@ -177,6 +184,18 @@ public AccessApprovalStub getStub() {
177184
* Lists approval requests associated with a project, folder, or organization. Approval requests
178185
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
179186
*
187+
* <p>Sample code:
188+
*
189+
* <pre>{@code
190+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
191+
* String parent = "parent-995424086";
192+
* for (ApprovalRequest element :
193+
* accessApprovalAdminClient.listApprovalRequests(parent).iterateAll()) {
194+
* // doThingsWith(element);
195+
* }
196+
* }
197+
* }</pre>
198+
*
180199
* @param parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}",
181200
* or "organizations/{organization_id}".
182201
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -192,6 +211,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests(String paren
192211
* Lists approval requests associated with a project, folder, or organization. Approval requests
193212
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
194213
*
214+
* <p>Sample code:
215+
*
216+
* <pre>{@code
217+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
218+
* ListApprovalRequestsMessage request =
219+
* ListApprovalRequestsMessage.newBuilder()
220+
* .setParent("parent-995424086")
221+
* .setFilter("filter-1274492040")
222+
* .setPageSize(883849137)
223+
* .setPageToken("pageToken873572522")
224+
* .build();
225+
* for (ApprovalRequest element :
226+
* accessApprovalAdminClient.listApprovalRequests(request).iterateAll()) {
227+
* // doThingsWith(element);
228+
* }
229+
* }
230+
* }</pre>
231+
*
195232
* @param request The request object containing all of the parameters for the API call.
196233
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
197234
*/
@@ -206,6 +243,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests(
206243
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
207244
*
208245
* <p>Sample code:
246+
*
247+
* <pre>{@code
248+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
249+
* ListApprovalRequestsMessage request =
250+
* ListApprovalRequestsMessage.newBuilder()
251+
* .setParent("parent-995424086")
252+
* .setFilter("filter-1274492040")
253+
* .setPageSize(883849137)
254+
* .setPageToken("pageToken873572522")
255+
* .build();
256+
* ApiFuture<ApprovalRequest> future =
257+
* accessApprovalAdminClient.listApprovalRequestsPagedCallable().futureCall(request);
258+
* // Do something.
259+
* for (ApprovalRequest element : future.get().iterateAll()) {
260+
* // doThingsWith(element);
261+
* }
262+
* }
263+
* }</pre>
209264
*/
210265
public final UnaryCallable<ListApprovalRequestsMessage, ListApprovalRequestsPagedResponse>
211266
listApprovalRequestsPagedCallable() {
@@ -218,6 +273,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests(
218273
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
219274
*
220275
* <p>Sample code:
276+
*
277+
* <pre>{@code
278+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
279+
* while (true) {
280+
* ListApprovalRequestsResponse response =
281+
* accessApprovalAdminClient.listApprovalRequestsCallable().call(request);
282+
* for (ApprovalRequest element : response.getResponsesList()) {
283+
* // doThingsWith(element);
284+
* }
285+
* String nextPageToken = response.getNextPageToken();
286+
* if (!Strings.isNullOrEmpty(nextPageToken)) {
287+
* request = request.toBuilder().setPageToken(nextPageToken).build();
288+
* } else {
289+
* break;
290+
* }
291+
* }
292+
* }
293+
* }</pre>
221294
*/
222295
public final UnaryCallable<ListApprovalRequestsMessage, ListApprovalRequestsResponse>
223296
listApprovalRequestsCallable() {
@@ -228,6 +301,15 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests(
228301
/**
229302
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
230303
*
304+
* <p>Sample code:
305+
*
306+
* <pre>{@code
307+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
308+
* String name = "name3373707";
309+
* ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
310+
* }
311+
* }</pre>
312+
*
231313
* @param name Name of the approval request to retrieve.
232314
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
233315
*/
@@ -241,6 +323,16 @@ public final ApprovalRequest getApprovalRequest(String name) {
241323
/**
242324
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
243325
*
326+
* <p>Sample code:
327+
*
328+
* <pre>{@code
329+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
330+
* GetApprovalRequestMessage request =
331+
* GetApprovalRequestMessage.newBuilder().setName("name3373707").build();
332+
* ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(request);
333+
* }
334+
* }</pre>
335+
*
244336
* @param request The request object containing all of the parameters for the API call.
245337
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
246338
*/
@@ -253,6 +345,17 @@ public final ApprovalRequest getApprovalRequest(GetApprovalRequestMessage reques
253345
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
254346
*
255347
* <p>Sample code:
348+
*
349+
* <pre>{@code
350+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
351+
* GetApprovalRequestMessage request =
352+
* GetApprovalRequestMessage.newBuilder().setName("name3373707").build();
353+
* ApiFuture<ApprovalRequest> future =
354+
* accessApprovalAdminClient.getApprovalRequestCallable().futureCall(request);
355+
* // Do something.
356+
* ApprovalRequest response = future.get();
357+
* }
358+
* }</pre>
256359
*/
257360
public final UnaryCallable<GetApprovalRequestMessage, ApprovalRequest>
258361
getApprovalRequestCallable() {
@@ -266,6 +369,19 @@ public final ApprovalRequest getApprovalRequest(GetApprovalRequestMessage reques
266369
* <p>Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request
267370
* exists but is not in a pending state.
268371
*
372+
* <p>Sample code:
373+
*
374+
* <pre>{@code
375+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
376+
* ApproveApprovalRequestMessage request =
377+
* ApproveApprovalRequestMessage.newBuilder()
378+
* .setName("name3373707")
379+
* .setExpireTime(Timestamp.newBuilder().build())
380+
* .build();
381+
* ApprovalRequest response = accessApprovalAdminClient.approveApprovalRequest(request);
382+
* }
383+
* }</pre>
384+
*
269385
* @param request The request object containing all of the parameters for the API call.
270386
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
271387
*/
@@ -281,6 +397,20 @@ public final ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessag
281397
* exists but is not in a pending state.
282398
*
283399
* <p>Sample code:
400+
*
401+
* <pre>{@code
402+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
403+
* ApproveApprovalRequestMessage request =
404+
* ApproveApprovalRequestMessage.newBuilder()
405+
* .setName("name3373707")
406+
* .setExpireTime(Timestamp.newBuilder().build())
407+
* .build();
408+
* ApiFuture<ApprovalRequest> future =
409+
* accessApprovalAdminClient.approveApprovalRequestCallable().futureCall(request);
410+
* // Do something.
411+
* ApprovalRequest response = future.get();
412+
* }
413+
* }</pre>
284414
*/
285415
public final UnaryCallable<ApproveApprovalRequestMessage, ApprovalRequest>
286416
approveApprovalRequestCallable() {
@@ -298,6 +428,16 @@ public final ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessag
298428
*
299429
* <p>Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
300430
*
431+
* <p>Sample code:
432+
*
433+
* <pre>{@code
434+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
435+
* DismissApprovalRequestMessage request =
436+
* DismissApprovalRequestMessage.newBuilder().setName("name3373707").build();
437+
* ApprovalRequest response = accessApprovalAdminClient.dismissApprovalRequest(request);
438+
* }
439+
* }</pre>
440+
*
301441
* @param request The request object containing all of the parameters for the API call.
302442
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
303443
*/
@@ -317,6 +457,17 @@ public final ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessag
317457
* <p>Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
318458
*
319459
* <p>Sample code:
460+
*
461+
* <pre>{@code
462+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
463+
* DismissApprovalRequestMessage request =
464+
* DismissApprovalRequestMessage.newBuilder().setName("name3373707").build();
465+
* ApiFuture<ApprovalRequest> future =
466+
* accessApprovalAdminClient.dismissApprovalRequestCallable().futureCall(request);
467+
* // Do something.
468+
* ApprovalRequest response = future.get();
469+
* }
470+
* }</pre>
320471
*/
321472
public final UnaryCallable<DismissApprovalRequestMessage, ApprovalRequest>
322473
dismissApprovalRequestCallable() {
@@ -327,6 +478,15 @@ public final ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessag
327478
/**
328479
* Gets the settings associated with a project, folder, or organization.
329480
*
481+
* <p>Sample code:
482+
*
483+
* <pre>{@code
484+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
485+
* String name = "name3373707";
486+
* AccessApprovalSettings response = accessApprovalAdminClient.getAccessApprovalSettings(name);
487+
* }
488+
* }</pre>
489+
*
330490
* @param name Name of the AccessApprovalSettings to retrieve.
331491
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
332492
*/
@@ -340,6 +500,17 @@ public final AccessApprovalSettings getAccessApprovalSettings(String name) {
340500
/**
341501
* Gets the settings associated with a project, folder, or organization.
342502
*
503+
* <p>Sample code:
504+
*
505+
* <pre>{@code
506+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
507+
* GetAccessApprovalSettingsMessage request =
508+
* GetAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
509+
* AccessApprovalSettings response =
510+
* accessApprovalAdminClient.getAccessApprovalSettings(request);
511+
* }
512+
* }</pre>
513+
*
343514
* @param request The request object containing all of the parameters for the API call.
344515
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
345516
*/
@@ -353,6 +524,17 @@ public final AccessApprovalSettings getAccessApprovalSettings(
353524
* Gets the settings associated with a project, folder, or organization.
354525
*
355526
* <p>Sample code:
527+
*
528+
* <pre>{@code
529+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
530+
* GetAccessApprovalSettingsMessage request =
531+
* GetAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
532+
* ApiFuture<AccessApprovalSettings> future =
533+
* accessApprovalAdminClient.getAccessApprovalSettingsCallable().futureCall(request);
534+
* // Do something.
535+
* AccessApprovalSettings response = future.get();
536+
* }
537+
* }</pre>
356538
*/
357539
public final UnaryCallable<GetAccessApprovalSettingsMessage, AccessApprovalSettings>
358540
getAccessApprovalSettingsCallable() {
@@ -364,6 +546,17 @@ public final AccessApprovalSettings getAccessApprovalSettings(
364546
* Updates the settings associated with a project, folder, or organization. Settings to update are
365547
* determined by the value of field_mask.
366548
*
549+
* <p>Sample code:
550+
*
551+
* <pre>{@code
552+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
553+
* AccessApprovalSettings settings = AccessApprovalSettings.newBuilder().build();
554+
* FieldMask updateMask = FieldMask.newBuilder().build();
555+
* AccessApprovalSettings response =
556+
* accessApprovalAdminClient.updateAccessApprovalSettings(settings, updateMask);
557+
* }
558+
* }</pre>
559+
*
367560
* @param settings The new AccessApprovalSettings.
368561
* @param updateMask The update mask applies to the settings. Only the top level fields of
369562
* AccessApprovalSettings (notification_emails &amp; enrolled_services) are supported. For
@@ -389,6 +582,20 @@ public final AccessApprovalSettings updateAccessApprovalSettings(
389582
* Updates the settings associated with a project, folder, or organization. Settings to update are
390583
* determined by the value of field_mask.
391584
*
585+
* <p>Sample code:
586+
*
587+
* <pre>{@code
588+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
589+
* UpdateAccessApprovalSettingsMessage request =
590+
* UpdateAccessApprovalSettingsMessage.newBuilder()
591+
* .setSettings(AccessApprovalSettings.newBuilder().build())
592+
* .setUpdateMask(FieldMask.newBuilder().build())
593+
* .build();
594+
* AccessApprovalSettings response =
595+
* accessApprovalAdminClient.updateAccessApprovalSettings(request);
596+
* }
597+
* }</pre>
598+
*
392599
* @param request The request object containing all of the parameters for the API call.
393600
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
394601
*/
@@ -403,6 +610,20 @@ public final AccessApprovalSettings updateAccessApprovalSettings(
403610
* determined by the value of field_mask.
404611
*
405612
* <p>Sample code:
613+
*
614+
* <pre>{@code
615+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
616+
* UpdateAccessApprovalSettingsMessage request =
617+
* UpdateAccessApprovalSettingsMessage.newBuilder()
618+
* .setSettings(AccessApprovalSettings.newBuilder().build())
619+
* .setUpdateMask(FieldMask.newBuilder().build())
620+
* .build();
621+
* ApiFuture<AccessApprovalSettings> future =
622+
* accessApprovalAdminClient.updateAccessApprovalSettingsCallable().futureCall(request);
623+
* // Do something.
624+
* AccessApprovalSettings response = future.get();
625+
* }
626+
* }</pre>
406627
*/
407628
public final UnaryCallable<UpdateAccessApprovalSettingsMessage, AccessApprovalSettings>
408629
updateAccessApprovalSettingsCallable() {
@@ -417,6 +638,15 @@ public final AccessApprovalSettings updateAccessApprovalSettings(
417638
* of the hierarchy, then Access Approval will still be enabled at this level as the settings are
418639
* inherited.
419640
*
641+
* <p>Sample code:
642+
*
643+
* <pre>{@code
644+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
645+
* String name = "name3373707";
646+
* accessApprovalAdminClient.deleteAccessApprovalSettings(name);
647+
* }
648+
* }</pre>
649+
*
420650
* @param name Name of the AccessApprovalSettings to delete.
421651
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
422652
*/
@@ -434,6 +664,16 @@ public final void deleteAccessApprovalSettings(String name) {
434664
* of the hierarchy, then Access Approval will still be enabled at this level as the settings are
435665
* inherited.
436666
*
667+
* <p>Sample code:
668+
*
669+
* <pre>{@code
670+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
671+
* DeleteAccessApprovalSettingsMessage request =
672+
* DeleteAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
673+
* accessApprovalAdminClient.deleteAccessApprovalSettings(request);
674+
* }
675+
* }</pre>
676+
*
437677
* @param request The request object containing all of the parameters for the API call.
438678
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
439679
*/
@@ -450,6 +690,17 @@ public final void deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessa
450690
* inherited.
451691
*
452692
* <p>Sample code:
693+
*
694+
* <pre>{@code
695+
* try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
696+
* DeleteAccessApprovalSettingsMessage request =
697+
* DeleteAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
698+
* ApiFuture<Empty> future =
699+
* accessApprovalAdminClient.deleteAccessApprovalSettingsCallable().futureCall(request);
700+
* // Do something.
701+
* future.get();
702+
* }
703+
* }</pre>
453704
*/
454705
public final UnaryCallable<DeleteAccessApprovalSettingsMessage, Empty>
455706
deleteAccessApprovalSettingsCallable() {

0 commit comments

Comments
 (0)