/
service.rb
2041 lines (1988 loc) · 132 KB
/
service.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2015 Google Inc.
#
# 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
#
# http://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.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module MonitoringV3
# Cloud Monitoring API
#
# Manages your Cloud Monitoring data and configurations. Most projects must be
# associated with a Workspace, with a few exceptions as noted on the individual
# method pages. The table entries below are presented in alphabetical order, not
# in order of common use. For explanations of the concepts found in the table
# entries, read the Cloud Monitoring documentation.
#
# @example
# require 'google/apis/monitoring_v3'
#
# Monitoring = Google::Apis::MonitoringV3 # Alias the module
# service = Monitoring::MonitoringService.new
#
# @see https://cloud.google.com/monitoring/api/
class MonitoringService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://monitoring.googleapis.com/', '')
@batch_path = 'batch'
end
# Creates a new alerting policy.
# @param [String] name
# Required. The project in which to create the alerting policy. The format is:
# projects/[PROJECT_ID_OR_NUMBER] 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 [Google::Apis::MonitoringV3::AlertPolicy] alert_policy_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::AlertPolicy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::AlertPolicy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_alert_policy(name, alert_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/alertPolicies', options)
command.request_representation = Google::Apis::MonitoringV3::AlertPolicy::Representation
command.request_object = alert_policy_object
command.response_representation = Google::Apis::MonitoringV3::AlertPolicy::Representation
command.response_class = Google::Apis::MonitoringV3::AlertPolicy
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an alerting policy.
# @param [String] name
# Required. The alerting policy to delete. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information,
# see AlertPolicy.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_alert_policy(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single alerting policy.
# @param [String] name
# Required. The alerting policy to retrieve. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::AlertPolicy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::AlertPolicy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_alert_policy(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::AlertPolicy::Representation
command.response_class = Google::Apis::MonitoringV3::AlertPolicy
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the existing alerting policies for the workspace.
# @param [String] name
# Required. The project whose alert policies are to be listed. The format is:
# projects/[PROJECT_ID_OR_NUMBER] 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 operation, instead.
# @param [String] filter
# If provided, this field specifies the criteria that must be met by alert
# policies to be included in the response.For more details, see sorting and
# filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
# @param [String] order_by
# A comma-separated list of fields by which to sort the result. Supports the
# same set of field references as the filter field. Entries can be prefixed with
# a minus sign to sort by the field in descending order.For more details, see
# sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-
# filtering).
# @param [Fixnum] page_size
# The maximum number of results to return in a single response.
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return more results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListAlertPoliciesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListAlertPoliciesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_alert_policies(name, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/alertPolicies', options)
command.response_representation = Google::Apis::MonitoringV3::ListAlertPoliciesResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListAlertPoliciesResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] name
# Required if the policy exists. The resource name for this policy. The format
# is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [
# ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is
# created. When calling the alertPolicies.create method, do not include the name
# field in the alerting policy passed as part of the request.
# @param [Google::Apis::MonitoringV3::AlertPolicy] alert_policy_object
# @param [String] update_mask
# 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.Examples of valid field masks include
# display_name, documentation, documentation.content, documentation.mime_type,
# user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.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: 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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::AlertPolicy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::AlertPolicy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_project_alert_policy(name, alert_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v3/{+name}', options)
command.request_representation = Google::Apis::MonitoringV3::AlertPolicy::Representation
command.request_object = alert_policy_object
command.response_representation = Google::Apis::MonitoringV3::AlertPolicy::Representation
command.response_class = Google::Apis::MonitoringV3::AlertPolicy
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Stackdriver Monitoring Agent only: Creates a new time series.This method is
# only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.
# create instead.
# @param [String] name
# The project in which to create the time series. The format is: projects/[
# PROJECT_ID_OR_NUMBER]
# @param [Google::Apis::MonitoringV3::CreateCollectdTimeSeriesRequest] create_collectd_time_series_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::CreateCollectdTimeSeriesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::CreateCollectdTimeSeriesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_collectd_time_series(name, create_collectd_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/collectdTimeSeries', options)
command.request_representation = Google::Apis::MonitoringV3::CreateCollectdTimeSeriesRequest::Representation
command.request_object = create_collectd_time_series_request_object
command.response_representation = Google::Apis::MonitoringV3::CreateCollectdTimeSeriesResponse::Representation
command.response_class = Google::Apis::MonitoringV3::CreateCollectdTimeSeriesResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new group.
# @param [String] name
# Required. The project in which to create the group. The format is: projects/[
# PROJECT_ID_OR_NUMBER]
# @param [Google::Apis::MonitoringV3::Group] group_object
# @param [Boolean] validate_only
# If true, validate this request but do not create the group.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_group(name, group_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/groups', options)
command.request_representation = Google::Apis::MonitoringV3::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::MonitoringV3::Group::Representation
command.response_class = Google::Apis::MonitoringV3::Group
command.params['name'] = name unless name.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an existing group.
# @param [String] name
# Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/
# groups/[GROUP_ID]
# @param [Boolean] recursive
# If this field is true, then the request means to delete a group with all its
# descendants. Otherwise, the request means to delete a group only when it has
# no descendants. The default value is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_group(name, recursive: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['recursive'] = recursive unless recursive.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single group.
# @param [String] name
# Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]
# /groups/[GROUP_ID]
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_group(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::Group::Representation
command.response_class = Google::Apis::MonitoringV3::Group
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the existing groups.
# @param [String] name
# Required. The project whose groups are to be listed. The format is: projects/[
# PROJECT_ID_OR_NUMBER]
# @param [String] ancestors_of_group
# A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# Returns groups that are ancestors of the specified group. The groups are
# returned in order, starting with the immediate parent and ending with the most
# distant ancestor. If the specified group has no immediate parent, the results
# are empty.
# @param [String] children_of_group
# A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# Returns groups whose parent_name field contains the group name. If no groups
# have this parent, the results are empty.
# @param [String] descendants_of_group
# A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# Returns the descendants of the specified group. This is a superset of the
# results returned by the children_of_group filter, and includes children-of-
# children, and so forth.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] page_token
# If this field is not empty then it must contain the next_page_token value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_groups(name, ancestors_of_group: nil, children_of_group: nil, descendants_of_group: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/groups', options)
command.response_representation = Google::Apis::MonitoringV3::ListGroupsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListGroupsResponse
command.params['name'] = name unless name.nil?
command.query['ancestorsOfGroup'] = ancestors_of_group unless ancestors_of_group.nil?
command.query['childrenOfGroup'] = children_of_group unless children_of_group.nil?
command.query['descendantsOfGroup'] = descendants_of_group unless descendants_of_group.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing group. You can change any group attributes except name.
# @param [String] name
# Output only. The name of this group. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is
# ignored and a new name is created consisting of the project specified in the
# call to CreateGroup and a unique [GROUP_ID] that is generated automatically.
# @param [Google::Apis::MonitoringV3::Group] group_object
# @param [Boolean] validate_only
# If true, validate this request but do not update the existing group.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_group(name, group_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v3/{+name}', options)
command.request_representation = Google::Apis::MonitoringV3::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::MonitoringV3::Group::Representation
command.response_class = Google::Apis::MonitoringV3::Group
command.params['name'] = name unless name.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the monitored resources that are members of a group.
# @param [String] name
# Required. The group whose members are listed. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# @param [String] filter
# An optional list filter (https://cloud.google.com/monitoring/api/learn_more#
# filtering) describing the members to be returned. The filter may reference the
# type, labels, and metadata of monitored resources that comprise the group. For
# example, to return only resources representing Compute Engine VM instances,
# use this filter: `resource.type = "gce_instance"`
# @param [String] interval_end_time
# Required. The end of the time interval.
# @param [String] interval_start_time
# Optional. The beginning of the time interval. The default value for the start
# time is the end time. The start time must not be later than the end time.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] page_token
# If this field is not empty then it must contain the next_page_token value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListGroupMembersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListGroupMembersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_group_members(name, filter: nil, interval_end_time: nil, interval_start_time: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/members', options)
command.response_representation = Google::Apis::MonitoringV3::ListGroupMembersResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListGroupMembersResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new metric descriptor. User-created metric descriptors define custom
# metrics (https://cloud.google.com/monitoring/custom-metrics).
# @param [String] name
# Required. The project on which to execute the request. The format is: projects/
# [PROJECT_ID_OR_NUMBER]
# @param [Google::Apis::MonitoringV3::MetricDescriptor] metric_descriptor_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::MetricDescriptor] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::MetricDescriptor]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_metric_descriptor(name, metric_descriptor_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/metricDescriptors', options)
command.request_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
command.request_object = metric_descriptor_object
command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
command.response_class = Google::Apis::MonitoringV3::MetricDescriptor
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a metric descriptor. Only user-created custom metrics (https://cloud.
# google.com/monitoring/custom-metrics) can be deleted.
# @param [String] name
# Required. The metric descriptor on which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [
# METRIC_ID] is: "custom.googleapis.com/my_test_metric".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_metric_descriptor(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single metric descriptor. This method does not require a Workspace.
# @param [String] name
# Required. The metric descriptor on which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example
# value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count"
# .
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::MetricDescriptor] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::MetricDescriptor]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_metric_descriptor(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation
command.response_class = Google::Apis::MonitoringV3::MetricDescriptor
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists metric descriptors that match a filter. This method does not require a
# Workspace.
# @param [String] name
# Required. The project on which to execute the request. The format is: projects/
# [PROJECT_ID_OR_NUMBER]
# @param [String] filter
# If this field is empty, all custom and system-defined metric descriptors are
# returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/
# filters) specifies which metric descriptors are to be returned. For example,
# the following filter matches all custom metrics (https://cloud.google.com/
# monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/")
#
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListMetricDescriptorsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListMetricDescriptorsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_metric_descriptors(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/metricDescriptors', options)
command.response_representation = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single monitored resource descriptor. This method does not require a
# Workspace.
# @param [String] name
# Required. The monitored resource descriptor to get. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The [
# RESOURCE_TYPE] is a predefined type, such as cloudsql_database.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::MonitoredResourceDescriptor] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::MonitoredResourceDescriptor]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_monitored_resource_descriptor(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::MonitoredResourceDescriptor::Representation
command.response_class = Google::Apis::MonitoringV3::MonitoredResourceDescriptor
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists monitored resource descriptors that match a filter. This method does not
# require a Workspace.
# @param [String] name
# Required. The project on which to execute the request. The format is: projects/
# [PROJECT_ID_OR_NUMBER]
# @param [String] filter
# An optional filter (https://cloud.google.com/monitoring/api/v3/filters)
# describing the descriptors to be returned. The filter can reference the
# descriptor's type and labels. For example, the following filter returns only
# Google Compute Engine descriptors that have an id label: resource.type =
# starts_with("gce_") AND resource.label:id
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_monitored_resource_descriptors(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/monitoredResourceDescriptors', options)
command.response_representation = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single channel descriptor. The descriptor indicates which fields are
# expected / permitted for a notification channel of the given type.
# @param [String] name
# Required. The channel type for which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::NotificationChannelDescriptor] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::NotificationChannelDescriptor]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_notification_channel_descriptor(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::NotificationChannelDescriptor::Representation
command.response_class = Google::Apis::MonitoringV3::NotificationChannelDescriptor
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the descriptors for supported channel types. The use of descriptors
# makes it possible for new channel types to be dynamically added.
# @param [String] name
# Required. The REST resource name of the parent from which to retrieve the
# notification channel descriptors. The expected syntax is: projects/[
# PROJECT_ID_OR_NUMBER] Note that this names the parent container in which to
# look for the descriptors; to retrieve a single descriptor by name, use the
# GetNotificationChannelDescriptor operation, instead.
# @param [Fixnum] page_size
# The maximum number of results to return in a single response. If not set to a
# positive number, a reasonable value will be chosen by the service.
# @param [String] page_token
# If non-empty, page_token must contain a value returned as the next_page_token
# in a previous response to request the next set of results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::ListNotificationChannelDescriptorsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::ListNotificationChannelDescriptorsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_notification_channel_descriptors(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/notificationChannelDescriptors', options)
command.response_representation = Google::Apis::MonitoringV3::ListNotificationChannelDescriptorsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListNotificationChannelDescriptorsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new notification channel, representing a single notification
# endpoint such as an email address, SMS number, or PagerDuty service.
# @param [String] name
# Required. The project on which to execute the request. The format is: projects/
# [PROJECT_ID_OR_NUMBER] This names the container into which the channel will be
# written, this does not name the newly created channel. The resulting channel's
# name will have a normalized version of this field as a prefix, but will add /
# notificationChannels/[CHANNEL_ID] to identify the channel.
# @param [Google::Apis::MonitoringV3::NotificationChannel] notification_channel_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::NotificationChannel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::NotificationChannel]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_notification_channel(name, notification_channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/notificationChannels', options)
command.request_representation = Google::Apis::MonitoringV3::NotificationChannel::Representation
command.request_object = notification_channel_object
command.response_representation = Google::Apis::MonitoringV3::NotificationChannel::Representation
command.response_class = Google::Apis::MonitoringV3::NotificationChannel
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a notification channel.
# @param [String] name
# Required. The channel for which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
# @param [Boolean] force
# If true, the notification channel will be deleted regardless of its use in
# alert policies (the policies will be updated to remove the channel). If false,
# channels that are still referenced by an existing alerting policy will fail to
# be deleted in a delete operation.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_notification_channel(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['force'] = force unless force.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a single notification channel. The channel includes the relevant
# configuration details with which the channel was created. However, the
# response may truncate or omit passwords, API keys, or other private key matter
# and thus the response may not be 100% identical to the information that was
# supplied in the call to the create method.
# @param [String] name
# Required. The channel for which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::NotificationChannel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::NotificationChannel]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_notification_channel(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}', options)
command.response_representation = Google::Apis::MonitoringV3::NotificationChannel::Representation
command.response_class = Google::Apis::MonitoringV3::NotificationChannel
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Requests a verification code for an already verified channel that can then be
# used in a call to VerifyNotificationChannel() on a different channel with an
# equivalent identity in the same or in a different project. This makes it
# possible to copy a channel between projects without requiring manual
# reverification of the channel. If the channel is not in the verified state,
# this method will fail (in other words, this may only be used if the
# SendNotificationChannelVerificationCode and VerifyNotificationChannel paths
# have already been used to put the given channel into the verified state).There
# is no guarantee that the verification codes returned by this method will be of
# a similar structure or form as the ones that are delivered to the channel via
# SendNotificationChannelVerificationCode; while VerifyNotificationChannel()
# will recognize both the codes delivered via
# SendNotificationChannelVerificationCode() and returned from
# GetNotificationChannelVerificationCode(), it is typically the case that the
# verification codes delivered via SendNotificationChannelVerificationCode()
# will be shorter and also have a shorter expiration (e.g. codes such as "G-
# 123456") whereas GetVerificationCode() will typically return a much longer,
# websafe base 64 encoded string that has a longer expiration time.
# @param [String] name
# Required. The notification channel for which a verification code is to be
# generated and retrieved. This must name a channel that is already verified; if
# the specified channel is not verified, the request will fail.
# @param [Google::Apis::MonitoringV3::GetNotificationChannelVerificationCodeRequest] get_notification_channel_verification_code_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#