This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
FirewallClient.java
597 lines (556 loc) · 21.3 KB
/
FirewallClient.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
/*
* 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.appengine.v1;
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.appengine.v1.firewall.FirewallRule;
import com.google.appengine.v1.stub.FirewallStub;
import com.google.appengine.v1.stub.FirewallStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Firewall resources are used to define a collection of access control rules
* for an Application. Each rule is defined with a position which specifies the rule's order in the
* sequence of rules, an IP range to be matched against requests, and an action to take upon
* matching requests.
*
* <p>Every request is evaluated against the Firewall rules in priority order. Processesing stops at
* the first rule which matches the request's IP address. A final rule always specifies an action
* that applies to all remaining IP addresses. The default final rule for a newly-created
* application will be set to "allow" if not otherwise specified by the user.
*
* <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 (FirewallClient firewallClient = FirewallClient.create()) {
* BatchUpdateIngressRulesRequest request =
* BatchUpdateIngressRulesRequest.newBuilder()
* .setName("name3373707")
* .addAllIngressRules(new ArrayList<FirewallRule>())
* .build();
* BatchUpdateIngressRulesResponse response = firewallClient.batchUpdateIngressRules(request);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the FirewallClient 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 FirewallSettings to create().
* For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* FirewallSettings firewallSettings =
* FirewallSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* FirewallClient firewallClient = FirewallClient.create(firewallSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* FirewallSettings firewallSettings =
* FirewallSettings.newBuilder().setEndpoint(myEndpoint).build();
* FirewallClient firewallClient = FirewallClient.create(firewallSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class FirewallClient implements BackgroundResource {
private final FirewallSettings settings;
private final FirewallStub stub;
/** Constructs an instance of FirewallClient with default settings. */
public static final FirewallClient create() throws IOException {
return create(FirewallSettings.newBuilder().build());
}
/**
* Constructs an instance of FirewallClient, 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 FirewallClient create(FirewallSettings settings) throws IOException {
return new FirewallClient(settings);
}
/**
* Constructs an instance of FirewallClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(FirewallSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final FirewallClient create(FirewallStub stub) {
return new FirewallClient(stub);
}
/**
* Constructs an instance of FirewallClient, 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 FirewallClient(FirewallSettings settings) throws IOException {
this.settings = settings;
this.stub = ((FirewallStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected FirewallClient(FirewallStub stub) {
this.settings = null;
this.stub = stub;
}
public final FirewallSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public FirewallStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the firewall rules of an application.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* ListIngressRulesRequest request =
* ListIngressRulesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setMatchingAddress("matchingAddress861962551")
* .build();
* for (FirewallRule element : firewallClient.listIngressRules(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 ListIngressRulesPagedResponse listIngressRules(ListIngressRulesRequest request) {
return listIngressRulesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the firewall rules of an application.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* ListIngressRulesRequest request =
* ListIngressRulesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setMatchingAddress("matchingAddress861962551")
* .build();
* ApiFuture<FirewallRule> future =
* firewallClient.listIngressRulesPagedCallable().futureCall(request);
* // Do something.
* for (FirewallRule element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListIngressRulesRequest, ListIngressRulesPagedResponse>
listIngressRulesPagedCallable() {
return stub.listIngressRulesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the firewall rules of an application.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* ListIngressRulesRequest request =
* ListIngressRulesRequest.newBuilder()
* .setParent("parent-995424086")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setMatchingAddress("matchingAddress861962551")
* .build();
* while (true) {
* ListIngressRulesResponse response = firewallClient.listIngressRulesCallable().call(request);
* for (FirewallRule 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<ListIngressRulesRequest, ListIngressRulesResponse>
listIngressRulesCallable() {
return stub.listIngressRulesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the
* rules of an existing firewall with the new rules.
*
* <p>If the final rule does not match traffic with the '*' wildcard IP range, then an "allow
* all" rule is explicitly added to the end of the list.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* BatchUpdateIngressRulesRequest request =
* BatchUpdateIngressRulesRequest.newBuilder()
* .setName("name3373707")
* .addAllIngressRules(new ArrayList<FirewallRule>())
* .build();
* BatchUpdateIngressRulesResponse response = firewallClient.batchUpdateIngressRules(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 BatchUpdateIngressRulesResponse batchUpdateIngressRules(
BatchUpdateIngressRulesRequest request) {
return batchUpdateIngressRulesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the
* rules of an existing firewall with the new rules.
*
* <p>If the final rule does not match traffic with the '*' wildcard IP range, then an "allow
* all" rule is explicitly added to the end of the list.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* BatchUpdateIngressRulesRequest request =
* BatchUpdateIngressRulesRequest.newBuilder()
* .setName("name3373707")
* .addAllIngressRules(new ArrayList<FirewallRule>())
* .build();
* ApiFuture<BatchUpdateIngressRulesResponse> future =
* firewallClient.batchUpdateIngressRulesCallable().futureCall(request);
* // Do something.
* BatchUpdateIngressRulesResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<BatchUpdateIngressRulesRequest, BatchUpdateIngressRulesResponse>
batchUpdateIngressRulesCallable() {
return stub.batchUpdateIngressRulesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a firewall rule for the application.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* CreateIngressRuleRequest request =
* CreateIngressRuleRequest.newBuilder()
* .setParent("parent-995424086")
* .setRule(FirewallRule.newBuilder().build())
* .build();
* FirewallRule response = firewallClient.createIngressRule(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 FirewallRule createIngressRule(CreateIngressRuleRequest request) {
return createIngressRuleCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a firewall rule for the application.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* CreateIngressRuleRequest request =
* CreateIngressRuleRequest.newBuilder()
* .setParent("parent-995424086")
* .setRule(FirewallRule.newBuilder().build())
* .build();
* ApiFuture<FirewallRule> future =
* firewallClient.createIngressRuleCallable().futureCall(request);
* // Do something.
* FirewallRule response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateIngressRuleRequest, FirewallRule> createIngressRuleCallable() {
return stub.createIngressRuleCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* GetIngressRuleRequest request =
* GetIngressRuleRequest.newBuilder().setName("name3373707").build();
* FirewallRule response = firewallClient.getIngressRule(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 FirewallRule getIngressRule(GetIngressRuleRequest request) {
return getIngressRuleCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* GetIngressRuleRequest request =
* GetIngressRuleRequest.newBuilder().setName("name3373707").build();
* ApiFuture<FirewallRule> future = firewallClient.getIngressRuleCallable().futureCall(request);
* // Do something.
* FirewallRule response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetIngressRuleRequest, FirewallRule> getIngressRuleCallable() {
return stub.getIngressRuleCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* UpdateIngressRuleRequest request =
* UpdateIngressRuleRequest.newBuilder()
* .setName("name3373707")
* .setRule(FirewallRule.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* FirewallRule response = firewallClient.updateIngressRule(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 FirewallRule updateIngressRule(UpdateIngressRuleRequest request) {
return updateIngressRuleCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* UpdateIngressRuleRequest request =
* UpdateIngressRuleRequest.newBuilder()
* .setName("name3373707")
* .setRule(FirewallRule.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<FirewallRule> future =
* firewallClient.updateIngressRuleCallable().futureCall(request);
* // Do something.
* FirewallRule response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateIngressRuleRequest, FirewallRule> updateIngressRuleCallable() {
return stub.updateIngressRuleCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* DeleteIngressRuleRequest request =
* DeleteIngressRuleRequest.newBuilder().setName("name3373707").build();
* firewallClient.deleteIngressRule(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteIngressRule(DeleteIngressRuleRequest request) {
deleteIngressRuleCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified firewall rule.
*
* <p>Sample code:
*
* <pre>{@code
* try (FirewallClient firewallClient = FirewallClient.create()) {
* DeleteIngressRuleRequest request =
* DeleteIngressRuleRequest.newBuilder().setName("name3373707").build();
* ApiFuture<Empty> future = firewallClient.deleteIngressRuleCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteIngressRuleRequest, Empty> deleteIngressRuleCallable() {
return stub.deleteIngressRuleCallable();
}
@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 ListIngressRulesPagedResponse
extends AbstractPagedListResponse<
ListIngressRulesRequest,
ListIngressRulesResponse,
FirewallRule,
ListIngressRulesPage,
ListIngressRulesFixedSizeCollection> {
public static ApiFuture<ListIngressRulesPagedResponse> createAsync(
PageContext<ListIngressRulesRequest, ListIngressRulesResponse, FirewallRule> context,
ApiFuture<ListIngressRulesResponse> futureResponse) {
ApiFuture<ListIngressRulesPage> futurePage =
ListIngressRulesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListIngressRulesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListIngressRulesPagedResponse(ListIngressRulesPage page) {
super(page, ListIngressRulesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListIngressRulesPage
extends AbstractPage<
ListIngressRulesRequest, ListIngressRulesResponse, FirewallRule, ListIngressRulesPage> {
private ListIngressRulesPage(
PageContext<ListIngressRulesRequest, ListIngressRulesResponse, FirewallRule> context,
ListIngressRulesResponse response) {
super(context, response);
}
private static ListIngressRulesPage createEmptyPage() {
return new ListIngressRulesPage(null, null);
}
@Override
protected ListIngressRulesPage createPage(
PageContext<ListIngressRulesRequest, ListIngressRulesResponse, FirewallRule> context,
ListIngressRulesResponse response) {
return new ListIngressRulesPage(context, response);
}
@Override
public ApiFuture<ListIngressRulesPage> createPageAsync(
PageContext<ListIngressRulesRequest, ListIngressRulesResponse, FirewallRule> context,
ApiFuture<ListIngressRulesResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListIngressRulesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListIngressRulesRequest,
ListIngressRulesResponse,
FirewallRule,
ListIngressRulesPage,
ListIngressRulesFixedSizeCollection> {
private ListIngressRulesFixedSizeCollection(
List<ListIngressRulesPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListIngressRulesFixedSizeCollection createEmptyCollection() {
return new ListIngressRulesFixedSizeCollection(null, 0);
}
@Override
protected ListIngressRulesFixedSizeCollection createCollection(
List<ListIngressRulesPage> pages, int collectionSize) {
return new ListIngressRulesFixedSizeCollection(pages, collectionSize);
}
}
}