This repository has been archived by the owner on Sep 18, 2023. It is now read-only.
/
AccessApprovalAdminClient.java
577 lines (529 loc) · 23.4 KB
/
AccessApprovalAdminClient.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
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.accessapproval.v1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.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.cloud.accessapproval.v1.stub.AccessApprovalStub;
import com.google.cloud.accessapproval.v1.stub.AccessApprovalStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
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: This API allows a customer to manage accesses to cloud resources by Google
* personnel. It defines the following resource model:
*
* <p>- The API has a collection of
* [ApprovalRequest][google.cloud.accessapproval.v1.ApprovalRequest] resources, named
* `approvalRequests/{approval_request_id}` - The API has top-level settings per
* Project/Folder/Organization, named `accessApprovalSettings`
*
* <p>The service also periodically emails a list of recipients, defined at the
* Project/Folder/Organization level in the accessApprovalSettings, when there is a pending
* ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a
* Cloud Pub/Sub topic owned by the customer (for Beta, the Pub/Sub setup is managed manually).
*
* <p>ApprovalRequests can be approved or dismissed. Google personel can only access the indicated
* resource or resources if the request is approved (subject to some exclusions:
* https://cloud.google.com/access-approval/docs/overview#exclusions).
*
* <p>Note: Using Access Approval functionality will mean that Google may not be able to meet the
* SLAs for your chosen products, as any support response times may be dramatically increased. As
* such the SLAs do not apply to any service disruption to the extent impacted by Customer's use of
* Access Approval. Do not enable Access Approval for projects where you may require high service
* availability and rapid response by Google Cloud Support.
*
* <p>After a request is approved or dismissed, no further action may be taken on it. Requests with
* the requested_expiration in the past or with no activity for 14 days are considered dismissed.
* When an approval expires, the request is considered dismissed.
*
* <p>If a request is not approved or dismissed, we call it pending.
*
* <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:
*
* <p>Note: close() needs to be called on the AccessApprovalAdminClient 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 AccessApprovalAdminSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* AccessApprovalAdminSettings accessApprovalAdminSettings =
* AccessApprovalAdminSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AccessApprovalAdminClient accessApprovalAdminClient =
* AccessApprovalAdminClient.create(accessApprovalAdminSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* AccessApprovalAdminSettings accessApprovalAdminSettings =
* AccessApprovalAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
* AccessApprovalAdminClient accessApprovalAdminClient =
* AccessApprovalAdminClient.create(accessApprovalAdminSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AccessApprovalAdminClient implements BackgroundResource {
private final AccessApprovalAdminSettings settings;
private final AccessApprovalStub stub;
/** Constructs an instance of AccessApprovalAdminClient with default settings. */
public static final AccessApprovalAdminClient create() throws IOException {
return create(AccessApprovalAdminSettings.newBuilder().build());
}
/**
* Constructs an instance of AccessApprovalAdminClient, 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 AccessApprovalAdminClient create(AccessApprovalAdminSettings settings)
throws IOException {
return new AccessApprovalAdminClient(settings);
}
/**
* Constructs an instance of AccessApprovalAdminClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(AccessApprovalAdminSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final AccessApprovalAdminClient create(AccessApprovalStub stub) {
return new AccessApprovalAdminClient(stub);
}
/**
* Constructs an instance of AccessApprovalAdminClient, 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 AccessApprovalAdminClient(AccessApprovalAdminSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AccessApprovalStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected AccessApprovalAdminClient(AccessApprovalStub stub) {
this.settings = null;
this.stub = stub;
}
public final AccessApprovalAdminSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AccessApprovalStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists approval requests associated with a project, folder, or organization. Approval requests
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
*
* @param parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}",
* or "organizations/{organization_id}".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListApprovalRequestsPagedResponse listApprovalRequests(String parent) {
ListApprovalRequestsMessage request =
ListApprovalRequestsMessage.newBuilder().setParent(parent).build();
return listApprovalRequests(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists approval requests associated with a project, folder, or organization. Approval requests
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
*
* @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 ListApprovalRequestsPagedResponse listApprovalRequests(
ListApprovalRequestsMessage request) {
return listApprovalRequestsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists approval requests associated with a project, folder, or organization. Approval requests
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
*
* <p>Sample code:
*/
public final UnaryCallable<ListApprovalRequestsMessage, ListApprovalRequestsPagedResponse>
listApprovalRequestsPagedCallable() {
return stub.listApprovalRequestsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists approval requests associated with a project, folder, or organization. Approval requests
* can be filtered by state (pending, active, dismissed). The order is reverse chronological.
*
* <p>Sample code:
*/
public final UnaryCallable<ListApprovalRequestsMessage, ListApprovalRequestsResponse>
listApprovalRequestsCallable() {
return stub.listApprovalRequestsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
*
* @param name Name of the approval request to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ApprovalRequest getApprovalRequest(String name) {
GetApprovalRequestMessage request =
GetApprovalRequestMessage.newBuilder().setName(name).build();
return getApprovalRequest(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
*
* @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 ApprovalRequest getApprovalRequest(GetApprovalRequestMessage request) {
return getApprovalRequestCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
*
* <p>Sample code:
*/
public final UnaryCallable<GetApprovalRequestMessage, ApprovalRequest>
getApprovalRequestCallable() {
return stub.getApprovalRequestCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Approves a request and returns the updated ApprovalRequest.
*
* <p>Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state.
*
* @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 ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessage request) {
return approveApprovalRequestCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Approves a request and returns the updated ApprovalRequest.
*
* <p>Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request
* exists but is not in a pending state.
*
* <p>Sample code:
*/
public final UnaryCallable<ApproveApprovalRequestMessage, ApprovalRequest>
approveApprovalRequestCallable() {
return stub.approveApprovalRequestCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Dismisses a request. Returns the updated ApprovalRequest.
*
* <p>NOTE: This does not deny access to the resource if another request has been made and
* approved. It is equivalent in effect to ignoring the request altogether.
*
* <p>Returns NOT_FOUND if the request does not exist.
*
* <p>Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
*
* @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 ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessage request) {
return dismissApprovalRequestCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Dismisses a request. Returns the updated ApprovalRequest.
*
* <p>NOTE: This does not deny access to the resource if another request has been made and
* approved. It is equivalent in effect to ignoring the request altogether.
*
* <p>Returns NOT_FOUND if the request does not exist.
*
* <p>Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
*
* <p>Sample code:
*/
public final UnaryCallable<DismissApprovalRequestMessage, ApprovalRequest>
dismissApprovalRequestCallable() {
return stub.dismissApprovalRequestCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the settings associated with a project, folder, or organization.
*
* @param name Name of the AccessApprovalSettings to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AccessApprovalSettings getAccessApprovalSettings(String name) {
GetAccessApprovalSettingsMessage request =
GetAccessApprovalSettingsMessage.newBuilder().setName(name).build();
return getAccessApprovalSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the settings associated with a project, folder, or organization.
*
* @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 AccessApprovalSettings getAccessApprovalSettings(
GetAccessApprovalSettingsMessage request) {
return getAccessApprovalSettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the settings associated with a project, folder, or organization.
*
* <p>Sample code:
*/
public final UnaryCallable<GetAccessApprovalSettingsMessage, AccessApprovalSettings>
getAccessApprovalSettingsCallable() {
return stub.getAccessApprovalSettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are
* determined by the value of field_mask.
*
* @param settings The new AccessApprovalSettings.
* @param updateMask The update mask applies to the settings. Only the top level fields of
* AccessApprovalSettings (notification_emails & enrolled_services) are supported. For
* each field, if it is included, the currently stored value will be entirely overwritten with
* the value of the field passed in this request.
* <p>For the `FieldMask` definition, see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If
* this field is left unset, only the notification_emails field will be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AccessApprovalSettings updateAccessApprovalSettings(
AccessApprovalSettings settings, FieldMask updateMask) {
UpdateAccessApprovalSettingsMessage request =
UpdateAccessApprovalSettingsMessage.newBuilder()
.setSettings(settings)
.setUpdateMask(updateMask)
.build();
return updateAccessApprovalSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are
* determined by the value of field_mask.
*
* @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 AccessApprovalSettings updateAccessApprovalSettings(
UpdateAccessApprovalSettingsMessage request) {
return updateAccessApprovalSettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are
* determined by the value of field_mask.
*
* <p>Sample code:
*/
public final UnaryCallable<UpdateAccessApprovalSettingsMessage, AccessApprovalSettings>
updateAccessApprovalSettingsCallable() {
return stub.updateAccessApprovalSettingsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the settings associated with a project, folder, or organization. This will have the
* effect of disabling Access Approval for the project, folder, or organization, but only if all
* ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level
* of the hierarchy, then Access Approval will still be enabled at this level as the settings are
* inherited.
*
* @param name Name of the AccessApprovalSettings to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAccessApprovalSettings(String name) {
DeleteAccessApprovalSettingsMessage request =
DeleteAccessApprovalSettingsMessage.newBuilder().setName(name).build();
deleteAccessApprovalSettings(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the settings associated with a project, folder, or organization. This will have the
* effect of disabling Access Approval for the project, folder, or organization, but only if all
* ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level
* of the hierarchy, then Access Approval will still be enabled at this level as the settings are
* inherited.
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request) {
deleteAccessApprovalSettingsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the settings associated with a project, folder, or organization. This will have the
* effect of disabling Access Approval for the project, folder, or organization, but only if all
* ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level
* of the hierarchy, then Access Approval will still be enabled at this level as the settings are
* inherited.
*
* <p>Sample code:
*/
public final UnaryCallable<DeleteAccessApprovalSettingsMessage, Empty>
deleteAccessApprovalSettingsCallable() {
return stub.deleteAccessApprovalSettingsCallable();
}
@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 ListApprovalRequestsPagedResponse
extends AbstractPagedListResponse<
ListApprovalRequestsMessage,
ListApprovalRequestsResponse,
ApprovalRequest,
ListApprovalRequestsPage,
ListApprovalRequestsFixedSizeCollection> {
public static ApiFuture<ListApprovalRequestsPagedResponse> createAsync(
PageContext<ListApprovalRequestsMessage, ListApprovalRequestsResponse, ApprovalRequest>
context,
ApiFuture<ListApprovalRequestsResponse> futureResponse) {
ApiFuture<ListApprovalRequestsPage> futurePage =
ListApprovalRequestsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction<ListApprovalRequestsPage, ListApprovalRequestsPagedResponse>() {
@Override
public ListApprovalRequestsPagedResponse apply(ListApprovalRequestsPage input) {
return new ListApprovalRequestsPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListApprovalRequestsPagedResponse(ListApprovalRequestsPage page) {
super(page, ListApprovalRequestsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListApprovalRequestsPage
extends AbstractPage<
ListApprovalRequestsMessage,
ListApprovalRequestsResponse,
ApprovalRequest,
ListApprovalRequestsPage> {
private ListApprovalRequestsPage(
PageContext<ListApprovalRequestsMessage, ListApprovalRequestsResponse, ApprovalRequest>
context,
ListApprovalRequestsResponse response) {
super(context, response);
}
private static ListApprovalRequestsPage createEmptyPage() {
return new ListApprovalRequestsPage(null, null);
}
@Override
protected ListApprovalRequestsPage createPage(
PageContext<ListApprovalRequestsMessage, ListApprovalRequestsResponse, ApprovalRequest>
context,
ListApprovalRequestsResponse response) {
return new ListApprovalRequestsPage(context, response);
}
@Override
public ApiFuture<ListApprovalRequestsPage> createPageAsync(
PageContext<ListApprovalRequestsMessage, ListApprovalRequestsResponse, ApprovalRequest>
context,
ApiFuture<ListApprovalRequestsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListApprovalRequestsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListApprovalRequestsMessage,
ListApprovalRequestsResponse,
ApprovalRequest,
ListApprovalRequestsPage,
ListApprovalRequestsFixedSizeCollection> {
private ListApprovalRequestsFixedSizeCollection(
List<ListApprovalRequestsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListApprovalRequestsFixedSizeCollection createEmptyCollection() {
return new ListApprovalRequestsFixedSizeCollection(null, 0);
}
@Override
protected ListApprovalRequestsFixedSizeCollection createCollection(
List<ListApprovalRequestsPage> pages, int collectionSize) {
return new ListApprovalRequestsFixedSizeCollection(pages, collectionSize);
}
}
}