This repository has been archived by the owner on Oct 2, 2023. It is now read-only.
/
AlertPolicyServiceClient.java
996 lines (944 loc) · 40.3 KB
/
AlertPolicyServiceClient.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
/*
* 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.monitoring.v3;
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.api.resourcenames.ResourceName;
import com.google.cloud.monitoring.v3.stub.AlertPolicyServiceStub;
import com.google.cloud.monitoring.v3.stub.AlertPolicyServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.monitoring.v3.AlertPolicy;
import com.google.monitoring.v3.AlertPolicyName;
import com.google.monitoring.v3.CreateAlertPolicyRequest;
import com.google.monitoring.v3.DeleteAlertPolicyRequest;
import com.google.monitoring.v3.GetAlertPolicyRequest;
import com.google.monitoring.v3.ListAlertPoliciesRequest;
import com.google.monitoring.v3.ListAlertPoliciesResponse;
import com.google.monitoring.v3.OrganizationName;
import com.google.monitoring.v3.ProjectName;
import com.google.monitoring.v3.UpdateAlertPolicyRequest;
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: The AlertPolicyService API is used to manage (list, create, delete, edit)
* alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions
* under which some aspect of your system is considered to be "unhealthy" and the ways to notify
* people or services about this state. In addition to using this API, alert policies can also be
* managed through [Stackdriver Monitoring](https://cloud.google.com/monitoring/docs/), which can be
* reached by clicking the "Monitoring" tab in [Cloud Console](https://console.cloud.google.com/).
*
* <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 (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* AlertPolicyName name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]");
* AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the AlertPolicyServiceClient 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 AlertPolicyServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* AlertPolicyServiceSettings alertPolicyServiceSettings =
* AlertPolicyServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AlertPolicyServiceClient alertPolicyServiceClient =
* AlertPolicyServiceClient.create(alertPolicyServiceSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* AlertPolicyServiceSettings alertPolicyServiceSettings =
* AlertPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* AlertPolicyServiceClient alertPolicyServiceClient =
* AlertPolicyServiceClient.create(alertPolicyServiceSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AlertPolicyServiceClient implements BackgroundResource {
private final AlertPolicyServiceSettings settings;
private final AlertPolicyServiceStub stub;
/** Constructs an instance of AlertPolicyServiceClient with default settings. */
public static final AlertPolicyServiceClient create() throws IOException {
return create(AlertPolicyServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of AlertPolicyServiceClient, 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 AlertPolicyServiceClient create(AlertPolicyServiceSettings settings)
throws IOException {
return new AlertPolicyServiceClient(settings);
}
/**
* Constructs an instance of AlertPolicyServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(AlertPolicyServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final AlertPolicyServiceClient create(AlertPolicyServiceStub stub) {
return new AlertPolicyServiceClient(stub);
}
/**
* Constructs an instance of AlertPolicyServiceClient, 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 AlertPolicyServiceClient(AlertPolicyServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AlertPolicyServiceStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected AlertPolicyServiceClient(AlertPolicyServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final AlertPolicyServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AlertPolicyServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ResourceName name = ResourceName.of("[FOLDER]");
* for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
* instead.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAlertPoliciesPagedResponse listAlertPolicies(ResourceName name) {
ListAlertPoliciesRequest request =
ListAlertPoliciesRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return listAlertPolicies(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* OrganizationName name = OrganizationName.of("[ORGANIZATION]");
* for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
* instead.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAlertPoliciesPagedResponse listAlertPolicies(OrganizationName name) {
ListAlertPoliciesRequest request =
ListAlertPoliciesRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return listAlertPolicies(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ProjectName name = ProjectName.of("[PROJECT]");
* for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
* instead.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAlertPoliciesPagedResponse listAlertPolicies(ProjectName name) {
ListAlertPoliciesRequest request =
ListAlertPoliciesRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return listAlertPolicies(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* String name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
* for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param name Required. The project whose alert policies are to be listed. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policies to be
* listed are stored. To retrieve a single alerting policy by name, use the
* [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation,
* instead.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAlertPoliciesPagedResponse listAlertPolicies(String name) {
ListAlertPoliciesRequest request = ListAlertPoliciesRequest.newBuilder().setName(name).build();
return listAlertPolicies(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ListAlertPoliciesRequest request =
* ListAlertPoliciesRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(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 ListAlertPoliciesPagedResponse listAlertPolicies(ListAlertPoliciesRequest request) {
return listAlertPoliciesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ListAlertPoliciesRequest request =
* ListAlertPoliciesRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture<AlertPolicy> future =
* alertPolicyServiceClient.listAlertPoliciesPagedCallable().futureCall(request);
* // Do something.
* for (AlertPolicy element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListAlertPoliciesRequest, ListAlertPoliciesPagedResponse>
listAlertPoliciesPagedCallable() {
return stub.listAlertPoliciesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the existing alerting policies for the workspace.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ListAlertPoliciesRequest request =
* ListAlertPoliciesRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListAlertPoliciesResponse response =
* alertPolicyServiceClient.listAlertPoliciesCallable().call(request);
* for (AlertPolicy 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<ListAlertPoliciesRequest, ListAlertPoliciesResponse>
listAlertPoliciesCallable() {
return stub.listAlertPoliciesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* AlertPolicyName name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]");
* AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(name);
* }
* }</pre>
*
* @param name Required. The alerting policy to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy getAlertPolicy(AlertPolicyName name) {
GetAlertPolicyRequest request =
GetAlertPolicyRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* String name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
* AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(name);
* }
* }</pre>
*
* @param name Required. The alerting policy to retrieve. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy getAlertPolicy(String name) {
GetAlertPolicyRequest request = GetAlertPolicyRequest.newBuilder().setName(name).build();
return getAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* GetAlertPolicyRequest request =
* GetAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .build();
* AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(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 AlertPolicy getAlertPolicy(GetAlertPolicyRequest request) {
return getAlertPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a single alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* GetAlertPolicyRequest request =
* GetAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .build();
* ApiFuture<AlertPolicy> future =
* alertPolicyServiceClient.getAlertPolicyCallable().futureCall(request);
* // Do something.
* AlertPolicy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetAlertPolicyRequest, AlertPolicy> getAlertPolicyCallable() {
return stub.getAlertPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ResourceName name = ResourceName.of("[FOLDER]");
* AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
* AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
* }
* }</pre>
*
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. |name| must be a host project of a workspace,
* otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will
* have a name that contains a normalized representation of this name as a prefix but adds a
* suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
* container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(ResourceName name, AlertPolicy alertPolicy) {
CreateAlertPolicyRequest request =
CreateAlertPolicyRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setAlertPolicy(alertPolicy)
.build();
return createAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* OrganizationName name = OrganizationName.of("[ORGANIZATION]");
* AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
* AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
* }
* }</pre>
*
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. |name| must be a host project of a workspace,
* otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will
* have a name that contains a normalized representation of this name as a prefix but adds a
* suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
* container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(OrganizationName name, AlertPolicy alertPolicy) {
CreateAlertPolicyRequest request =
CreateAlertPolicyRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setAlertPolicy(alertPolicy)
.build();
return createAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* ProjectName name = ProjectName.of("[PROJECT]");
* AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
* AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
* }
* }</pre>
*
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. |name| must be a host project of a workspace,
* otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will
* have a name that contains a normalized representation of this name as a prefix but adds a
* suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
* container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(ProjectName name, AlertPolicy alertPolicy) {
CreateAlertPolicyRequest request =
CreateAlertPolicyRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setAlertPolicy(alertPolicy)
.build();
return createAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* String name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
* AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
* AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
* }
* }</pre>
*
* @param name Required. The project in which to create the alerting policy. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]
* <p>Note that this field names the parent container in which the alerting policy will be
* written, not the name of the created policy. |name| must be a host project of a workspace,
* otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will
* have a name that contains a normalized representation of this name as a prefix but adds a
* suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
* container.
* @param alertPolicy Required. The requested alerting policy. You should omit the `name` field in
* this policy. The name will be returned in the new policy, including a new
* `[ALERT_POLICY_ID]` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy createAlertPolicy(String name, AlertPolicy alertPolicy) {
CreateAlertPolicyRequest request =
CreateAlertPolicyRequest.newBuilder().setName(name).setAlertPolicy(alertPolicy).build();
return createAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* CreateAlertPolicyRequest request =
* CreateAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .setAlertPolicy(AlertPolicy.newBuilder().build())
* .build();
* AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(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 AlertPolicy createAlertPolicy(CreateAlertPolicyRequest request) {
return createAlertPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* CreateAlertPolicyRequest request =
* CreateAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .setAlertPolicy(AlertPolicy.newBuilder().build())
* .build();
* ApiFuture<AlertPolicy> future =
* alertPolicyServiceClient.createAlertPolicyCallable().futureCall(request);
* // Do something.
* AlertPolicy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateAlertPolicyRequest, AlertPolicy> createAlertPolicyCallable() {
return stub.createAlertPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* AlertPolicyName name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]");
* alertPolicyServiceClient.deleteAlertPolicy(name);
* }
* }</pre>
*
* @param name Required. The alerting policy to delete. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAlertPolicy(AlertPolicyName name) {
DeleteAlertPolicyRequest request =
DeleteAlertPolicyRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* String name =
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
* alertPolicyServiceClient.deleteAlertPolicy(name);
* }
* }</pre>
*
* @param name Required. The alerting policy to delete. The format is:
* <p>projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
* <p>For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAlertPolicy(String name) {
DeleteAlertPolicyRequest request = DeleteAlertPolicyRequest.newBuilder().setName(name).build();
deleteAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* DeleteAlertPolicyRequest request =
* DeleteAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .build();
* alertPolicyServiceClient.deleteAlertPolicy(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 deleteAlertPolicy(DeleteAlertPolicyRequest request) {
deleteAlertPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* DeleteAlertPolicyRequest request =
* DeleteAlertPolicyRequest.newBuilder()
* .setName(
* AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
* .toString())
* .build();
* ApiFuture<Empty> future =
* alertPolicyServiceClient.deleteAlertPolicyCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteAlertPolicyRequest, Empty> deleteAlertPolicyCallable() {
return stub.deleteAlertPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an alerting policy. You can either replace the entire policy with a new one or replace
* only certain fields in the current alerting policy by specifying the fields to be updated via
* `updateMask`. Returns the updated alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* FieldMask updateMask = FieldMask.newBuilder().build();
* AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
* AlertPolicy response = alertPolicyServiceClient.updateAlertPolicy(updateMask, alertPolicy);
* }
* }</pre>
*
* @param updateMask Optional. A list of alerting policy field names. If this field is not empty,
* each listed field in the existing alerting policy is set to the value of the corresponding
* field in the supplied policy (`alert_policy`), or to the field's default value if the field
* is not in the supplied alerting policy. Fields not listed retain their previous value.
* <p>Examples of valid field masks include `display_name`, `documentation`,
* `documentation.content`, `documentation.mime_type`, `user_labels`, `user_label.nameofkey`,
* `enabled`, `conditions`, `combiner`, etc.
* <p>If this field is empty, then the supplied alerting policy replaces the existing policy.
* It is the same as deleting the existing policy and adding the supplied policy, except for
* the following:
* <p>+ The new policy will have the same `[ALERT_POLICY_ID]` as the former policy. This gives
* you continuity with the former policy in your notifications and incidents. + Conditions in
* the new policy will keep their former `[CONDITION_ID]` if the supplied condition includes
* the `name` field with that `[CONDITION_ID]`. If the supplied condition omits the `name`
* field, then a new `[CONDITION_ID]` is created.
* @param alertPolicy Required. The updated alerting policy or the updated values for the fields
* listed in `update_mask`. If `update_mask` is not empty, any fields in this policy that are
* not in `update_mask` are ignored.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AlertPolicy updateAlertPolicy(FieldMask updateMask, AlertPolicy alertPolicy) {
UpdateAlertPolicyRequest request =
UpdateAlertPolicyRequest.newBuilder()
.setUpdateMask(updateMask)
.setAlertPolicy(alertPolicy)
.build();
return updateAlertPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an alerting policy. You can either replace the entire policy with a new one or replace
* only certain fields in the current alerting policy by specifying the fields to be updated via
* `updateMask`. Returns the updated alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* UpdateAlertPolicyRequest request =
* UpdateAlertPolicyRequest.newBuilder()
* .setUpdateMask(FieldMask.newBuilder().build())
* .setAlertPolicy(AlertPolicy.newBuilder().build())
* .build();
* AlertPolicy response = alertPolicyServiceClient.updateAlertPolicy(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 AlertPolicy updateAlertPolicy(UpdateAlertPolicyRequest request) {
return updateAlertPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an alerting policy. You can either replace the entire policy with a new one or replace
* only certain fields in the current alerting policy by specifying the fields to be updated via
* `updateMask`. Returns the updated alerting policy.
*
* <p>Sample code:
*
* <pre>{@code
* try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
* UpdateAlertPolicyRequest request =
* UpdateAlertPolicyRequest.newBuilder()
* .setUpdateMask(FieldMask.newBuilder().build())
* .setAlertPolicy(AlertPolicy.newBuilder().build())
* .build();
* ApiFuture<AlertPolicy> future =
* alertPolicyServiceClient.updateAlertPolicyCallable().futureCall(request);
* // Do something.
* AlertPolicy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateAlertPolicyRequest, AlertPolicy> updateAlertPolicyCallable() {
return stub.updateAlertPolicyCallable();
}
@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 ListAlertPoliciesPagedResponse
extends AbstractPagedListResponse<
ListAlertPoliciesRequest,
ListAlertPoliciesResponse,
AlertPolicy,
ListAlertPoliciesPage,
ListAlertPoliciesFixedSizeCollection> {
public static ApiFuture<ListAlertPoliciesPagedResponse> createAsync(
PageContext<ListAlertPoliciesRequest, ListAlertPoliciesResponse, AlertPolicy> context,
ApiFuture<ListAlertPoliciesResponse> futureResponse) {
ApiFuture<ListAlertPoliciesPage> futurePage =
ListAlertPoliciesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
new ApiFunction<ListAlertPoliciesPage, ListAlertPoliciesPagedResponse>() {
@Override
public ListAlertPoliciesPagedResponse apply(ListAlertPoliciesPage input) {
return new ListAlertPoliciesPagedResponse(input);
}
},
MoreExecutors.directExecutor());
}
private ListAlertPoliciesPagedResponse(ListAlertPoliciesPage page) {
super(page, ListAlertPoliciesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListAlertPoliciesPage
extends AbstractPage<
ListAlertPoliciesRequest, ListAlertPoliciesResponse, AlertPolicy, ListAlertPoliciesPage> {
private ListAlertPoliciesPage(
PageContext<ListAlertPoliciesRequest, ListAlertPoliciesResponse, AlertPolicy> context,
ListAlertPoliciesResponse response) {
super(context, response);
}
private static ListAlertPoliciesPage createEmptyPage() {
return new ListAlertPoliciesPage(null, null);
}
@Override
protected ListAlertPoliciesPage createPage(
PageContext<ListAlertPoliciesRequest, ListAlertPoliciesResponse, AlertPolicy> context,
ListAlertPoliciesResponse response) {
return new ListAlertPoliciesPage(context, response);
}
@Override
public ApiFuture<ListAlertPoliciesPage> createPageAsync(
PageContext<ListAlertPoliciesRequest, ListAlertPoliciesResponse, AlertPolicy> context,
ApiFuture<ListAlertPoliciesResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListAlertPoliciesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListAlertPoliciesRequest,
ListAlertPoliciesResponse,
AlertPolicy,
ListAlertPoliciesPage,
ListAlertPoliciesFixedSizeCollection> {
private ListAlertPoliciesFixedSizeCollection(
List<ListAlertPoliciesPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListAlertPoliciesFixedSizeCollection createEmptyCollection() {
return new ListAlertPoliciesFixedSizeCollection(null, 0);
}
@Override
protected ListAlertPoliciesFixedSizeCollection createCollection(
List<ListAlertPoliciesPage> pages, int collectionSize) {
return new ListAlertPoliciesFixedSizeCollection(pages, collectionSize);
}
}
}