-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
alertcenter-gen.go
3699 lines (3435 loc) · 154 KB
/
alertcenter-gen.go
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 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package alertcenter provides access to the Google Workspace Alert Center API.
//
// For product documentation, see: https://developers.google.com/admin-sdk/alertcenter/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/alertcenter/v1beta1"
// ...
// ctx := context.Background()
// alertcenterService, err := alertcenter.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// alertcenterService, err := alertcenter.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// alertcenterService, err := alertcenter.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package alertcenter // import "google.golang.org/api/alertcenter/v1beta1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "alertcenter:v1beta1"
const apiName = "alertcenter"
const apiVersion = "v1beta1"
const basePath = "https://alertcenter.googleapis.com/"
const basePathTemplate = "https://alertcenter.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://alertcenter.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See and delete your domain's G Suite alerts, and send alert feedback
AppsAlertsScope = "https://www.googleapis.com/auth/apps.alerts"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/apps.alerts",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Alerts = NewAlertsService(s)
s.V1beta1 = NewV1beta1Service(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Alerts *AlertsService
V1beta1 *V1beta1Service
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewAlertsService(s *Service) *AlertsService {
rs := &AlertsService{s: s}
rs.Feedback = NewAlertsFeedbackService(s)
return rs
}
type AlertsService struct {
s *Service
Feedback *AlertsFeedbackService
}
func NewAlertsFeedbackService(s *Service) *AlertsFeedbackService {
rs := &AlertsFeedbackService{s: s}
return rs
}
type AlertsFeedbackService struct {
s *Service
}
func NewV1beta1Service(s *Service) *V1beta1Service {
rs := &V1beta1Service{s: s}
return rs
}
type V1beta1Service struct {
s *Service
}
// AbuseDetected: A generic alert for abusive user activity occurring with a
// customer.
type AbuseDetected struct {
// AdditionalDetails: List of abusive users/entities to be displayed in a table
// in the alert.
AdditionalDetails *EntityList `json:"additionalDetails,omitempty"`
// Product: Product that the abuse is originating from.
Product string `json:"product,omitempty"`
// SubAlertId: Unique identifier of each sub alert that is onboarded.
SubAlertId string `json:"subAlertId,omitempty"`
// VariationType: Variation of AbuseDetected alerts. The variation_type
// determines the texts displayed the alert details. This differs from
// sub_alert_id because each sub alert can have multiple variation_types,
// representing different stages of the alert.
//
// Possible values:
// "ABUSE_DETECTED_VARIATION_TYPE_UNSPECIFIED" - AbuseDetected alert
// variation type unspecified. No alert should be unspecified.
// "DRIVE_ABUSIVE_CONTENT" - Variation displayed for Drive abusive content
// alerts.
// "LIMITED_DISABLE" - Variation displayed for Limited Disable alerts, when a
// Google service is disabled for a user, totally or partially, due to the
// user's abusive behavior.
VariationType string `json:"variationType,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdditionalDetails") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdditionalDetails") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AbuseDetected) MarshalJSON() ([]byte, error) {
type NoMethod AbuseDetected
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AccessApproval: Alert that is triggered when Google support requests to
// access customer data.
type AccessApproval struct {
// JustificationReason: Justification for data access based on justification
// enums.
//
// Possible values:
// "JUSTIFICATION_UNSPECIFIED" - Justification unspecified
// "CUSTOMER_INITIATED_SUPPORT" - Customer Initiated Support
// "GOOGLE_INITIATED_REVIEW" - Google Initiated Review
// "GOOGLE_INITIATED_SERVICE" - Google Initiated Service
// "THIRD_PARTY_DATA_REQUEST" - Third Party Data Request
// "GOOGLE_RESPONSE_TO_PRODUCTION_ALERT" - Google Response to Production
// Alert
JustificationReason []string `json:"justificationReason,omitempty"`
// OfficeLocation: Office location of Google staff requesting access such as
// "US".
OfficeLocation string `json:"officeLocation,omitempty"`
// Products: Products within scope of the Access Approvals request.
Products []string `json:"products,omitempty"`
// RequestId: ID of the Access Approvals request. This is a helpful field when
// requesting support from Google.
RequestId string `json:"requestId,omitempty"`
// Scope: Scope of access, also known as a resource. This is further narrowed
// down by the product field.
Scope string `json:"scope,omitempty"`
// Tickets: Support tickets related to this Access Approvals request. Populated
// if there is an associated case number.
Tickets []*SupportTicket `json:"tickets,omitempty"`
// ForceSendFields is a list of field names (e.g. "JustificationReason") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "JustificationReason") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AccessApproval) MarshalJSON() ([]byte, error) {
type NoMethod AccessApproval
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AccountSuspensionDetails: Details about why an account is receiving an
// account suspension warning.
type AccountSuspensionDetails struct {
// AbuseReason: The reason why this account is receiving an account suspension
// warning.
//
// Possible values:
// "ACCOUNT_SUSPENSION_ABUSE_REASON_UNSPECIFIED" - Abuse reason is
// unspecified.
// "TOS_VIOLATION" - This account is being suspended for a Terms of Service
// violation.
// "SPAM" - This account is being suspended for spam.
// "PHISHING" - This account is being suspended for phishing.
// "TRAFFIC_PUMPING" - This account is being suspended for artificially
// boosting traffic to a website.
// "FRAUD" - This account is being suspended for fraud.
// "NUMBER_HARVESTING" - This account is being suspended for number
// harvesting.
// "PAYMENTS_FRAUD" - This account is being suspended for payments fraud.
// "UNWANTED_CONTENT" - This account is being suspended for unwanted content.
AbuseReason string `json:"abuseReason,omitempty"`
// ProductName: The name of the product being abused. This is restricted to
// only the following values: "Gmail" "Google Workspace" "Payments" "Voice"
// "YouTube" "Other"
ProductName string `json:"productName,omitempty"`
// ForceSendFields is a list of field names (e.g. "AbuseReason") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AbuseReason") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AccountSuspensionDetails) MarshalJSON() ([]byte, error) {
type NoMethod AccountSuspensionDetails
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AccountSuspensionWarning: A warning that the customer's account is about to
// be suspended.
type AccountSuspensionWarning struct {
// AppealWindow: The amount of time remaining to appeal an imminent suspension.
// After this window has elapsed, the account will be suspended. Only populated
// if the account suspension is in WARNING state.
AppealWindow string `json:"appealWindow,omitempty"`
// State: Account suspension warning state.
//
// Possible values:
// "ACCOUNT_SUSPENSION_WARNING_STATE_UNSPECIFIED" - State is unspecified.
// "WARNING" - Customer is receiving a warning about imminent suspension.
// "SUSPENDED" - Customer is being notified that their account has been
// suspended.
// "APPEAL_APPROVED" - Customer is being notified that their suspension
// appeal was approved.
// "APPEAL_SUBMITTED" - Customer has submitted their appeal, which is pending
// review.
State string `json:"state,omitempty"`
// SuspensionDetails: Details about why an account is being suspended.
SuspensionDetails []*AccountSuspensionDetails `json:"suspensionDetails,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppealWindow") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppealWindow") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AccountSuspensionWarning) MarshalJSON() ([]byte, error) {
type NoMethod AccountSuspensionWarning
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AccountWarning: Alerts for user account warning events.
type AccountWarning struct {
// Email: Required. The email of the user that this event belongs to.
Email string `json:"email,omitempty"`
// LoginDetails: Optional. Details of the login action associated with the
// warning event. This is only available for: * Suspicious login * Suspicious
// login (less secure app) * Suspicious programmatic login * User suspended
// (suspicious activity)
LoginDetails *LoginDetails `json:"loginDetails,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AccountWarning) MarshalJSON() ([]byte, error) {
type NoMethod AccountWarning
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ActionInfo: Metadata related to the action.
type ActionInfo struct {
}
// ActivityRule: Alerts from Google Workspace Security Center rules service
// configured by an admin.
type ActivityRule struct {
// ActionNames: List of action names associated with the rule threshold.
ActionNames []string `json:"actionNames,omitempty"`
// CreateTime: Rule create timestamp.
CreateTime string `json:"createTime,omitempty"`
// Description: Description of the rule.
Description string `json:"description,omitempty"`
// DisplayName: Alert display name.
DisplayName string `json:"displayName,omitempty"`
// Name: Rule name.
Name string `json:"name,omitempty"`
// Query: Query that is used to get the data from the associated source.
Query string `json:"query,omitempty"`
// SupersededAlerts: List of alert IDs superseded by this alert. It is used to
// indicate that this alert is essentially extension of superseded alerts and
// we found the relationship after creating these alerts.
SupersededAlerts []string `json:"supersededAlerts,omitempty"`
// SupersedingAlert: Alert ID superseding this alert. It is used to indicate
// that superseding alert is essentially extension of this alert and we found
// the relationship after creating both alerts.
SupersedingAlert string `json:"supersedingAlert,omitempty"`
// Threshold: Alert threshold is for example “COUNT > 5”.
Threshold string `json:"threshold,omitempty"`
// TriggerSource: The trigger sources for this rule. * GMAIL_EVENTS *
// DEVICE_EVENTS * USER_EVENTS
TriggerSource string `json:"triggerSource,omitempty"`
// UpdateTime: The timestamp of the last update to the rule.
UpdateTime string `json:"updateTime,omitempty"`
// WindowSize: Rule window size. Possible values are 1 hour or 24 hours.
WindowSize string `json:"windowSize,omitempty"`
// ForceSendFields is a list of field names (e.g. "ActionNames") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ActionNames") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ActivityRule) MarshalJSON() ([]byte, error) {
type NoMethod ActivityRule
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Alert: An alert affecting a customer.
type Alert struct {
// AlertId: Output only. The unique identifier for the alert.
AlertId string `json:"alertId,omitempty"`
// CreateTime: Output only. The time this alert was created.
CreateTime string `json:"createTime,omitempty"`
// CustomerId: Output only. The unique identifier of the Google Workspace
// account of the customer.
CustomerId string `json:"customerId,omitempty"`
// Data: Optional. The data associated with this alert, for example
// google.apps.alertcenter.type.DeviceCompromised.
Data googleapi.RawMessage `json:"data,omitempty"`
// Deleted: Output only. `True` if this alert is marked for deletion.
Deleted bool `json:"deleted,omitempty"`
// EndTime: Optional. The time the event that caused this alert ceased being
// active. If provided, the end time must not be earlier than the start time.
// If not provided, it indicates an ongoing alert.
EndTime string `json:"endTime,omitempty"`
// Etag: Optional. `etag` is used for optimistic concurrency control as a way
// to help prevent simultaneous updates of an alert from overwriting each
// other. It is strongly suggested that systems make use of the `etag` in the
// read-modify-write cycle to perform alert updates in order to avoid race
// conditions: An `etag` is returned in the response which contains alerts, and
// systems are expected to put that etag in the request to update alert to
// ensure that their change will be applied to the same version of the alert.
// If no `etag` is provided in the call to update alert, then the existing
// alert is overwritten blindly.
Etag string `json:"etag,omitempty"`
// Metadata: Output only. The metadata associated with this alert.
Metadata *AlertMetadata `json:"metadata,omitempty"`
// SecurityInvestigationToolLink: Output only. An optional Security
// Investigation Tool (https://support.google.com/a/answer/7575955) query for
// this alert.
SecurityInvestigationToolLink string `json:"securityInvestigationToolLink,omitempty"`
// Source: Required. A unique identifier for the system that reported the
// alert. This is output only after alert is created. Supported sources are any
// of the following: * Google Operations * Mobile device management * Gmail
// phishing * Data Loss Prevention * Domain wide takeout * State sponsored
// attack * Google identity * Apps outage
Source string `json:"source,omitempty"`
// StartTime: Required. The time the event that caused this alert was started
// or detected.
StartTime string `json:"startTime,omitempty"`
// Type: Required. The type of the alert. This is output only after alert is
// created. For a list of available alert types see Google Workspace Alert
// types
// (https://developers.google.com/admin-sdk/alertcenter/reference/alert-types).
Type string `json:"type,omitempty"`
// UpdateTime: Output only. The time this alert was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlertId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Alert) MarshalJSON() ([]byte, error) {
type NoMethod Alert
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AlertFeedback: A customer feedback about an alert.
type AlertFeedback struct {
// AlertId: Output only. The alert identifier.
AlertId string `json:"alertId,omitempty"`
// CreateTime: Output only. The time this feedback was created.
CreateTime string `json:"createTime,omitempty"`
// CustomerId: Output only. The unique identifier of the Google Workspace
// account of the customer.
CustomerId string `json:"customerId,omitempty"`
// Email: Output only. The email of the user that provided the feedback.
Email string `json:"email,omitempty"`
// FeedbackId: Output only. The unique identifier for the feedback.
FeedbackId string `json:"feedbackId,omitempty"`
// Type: Required. The type of the feedback.
//
// Possible values:
// "ALERT_FEEDBACK_TYPE_UNSPECIFIED" - The feedback type is not specified.
// "NOT_USEFUL" - The alert report is not useful.
// "SOMEWHAT_USEFUL" - The alert report is somewhat useful.
// "VERY_USEFUL" - The alert report is very useful.
Type string `json:"type,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlertId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AlertFeedback) MarshalJSON() ([]byte, error) {
type NoMethod AlertFeedback
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AlertMetadata: An alert metadata.
type AlertMetadata struct {
// AlertId: Output only. The alert identifier.
AlertId string `json:"alertId,omitempty"`
// Assignee: The email address of the user assigned to the alert.
Assignee string `json:"assignee,omitempty"`
// CustomerId: Output only. The unique identifier of the Google Workspace
// account of the customer.
CustomerId string `json:"customerId,omitempty"`
// Etag: Optional. `etag` is used for optimistic concurrency control as a way
// to help prevent simultaneous updates of an alert metadata from overwriting
// each other. It is strongly suggested that systems make use of the `etag` in
// the read-modify-write cycle to perform metadata updates in order to avoid
// race conditions: An `etag` is returned in the response which contains alert
// metadata, and systems are expected to put that etag in the request to update
// alert metadata to ensure that their change will be applied to the same
// version of the alert metadata. If no `etag` is provided in the call to
// update alert metadata, then the existing alert metadata is overwritten
// blindly.
Etag string `json:"etag,omitempty"`
// Severity: The severity value of the alert. Alert Center will set this field
// at alert creation time, default's to an empty string when it could not be
// determined. The supported values for update actions on this field are the
// following: * HIGH * MEDIUM * LOW
Severity string `json:"severity,omitempty"`
// Status: The current status of the alert. The supported values are the
// following: * NOT_STARTED * IN_PROGRESS * CLOSED
Status string `json:"status,omitempty"`
// UpdateTime: Output only. The time this metadata was last updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AlertId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AlertMetadata) MarshalJSON() ([]byte, error) {
type NoMethod AlertMetadata
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// ApnsCertificateExpirationInfo: The explanation message associated with "APNS
// certificate is expiring soon" and "APNS certificate has expired" alerts.
type ApnsCertificateExpirationInfo struct {
// AppleId: The Apple ID used to create the certificate. It may be blank if
// admins didn't enter it.
AppleId string `json:"appleId,omitempty"`
// ExpirationTime: The expiration date of the APNS certificate.
ExpirationTime string `json:"expirationTime,omitempty"`
// Uid: The UID of the certificate.
Uid string `json:"uid,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppleId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AppleId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ApnsCertificateExpirationInfo) MarshalJSON() ([]byte, error) {
type NoMethod ApnsCertificateExpirationInfo
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AppMakerSqlSetupNotification: Alerts from App Maker to notify admins to set
// up default SQL instance.
type AppMakerSqlSetupNotification struct {
// RequestInfo: List of applications with requests for default SQL set up.
RequestInfo []*RequestInfo `json:"requestInfo,omitempty"`
// ForceSendFields is a list of field names (e.g. "RequestInfo") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequestInfo") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppMakerSqlSetupNotification) MarshalJSON() ([]byte, error) {
type NoMethod AppMakerSqlSetupNotification
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AppSettingsChanged: Alerts from AppSettingsChanged bucket Rules configured
// by Admin which contain the below rules. Calendar settings changed Drive
// settings changed Email settings changed Mobile settings changed
type AppSettingsChanged struct {
// AlertDetails: Any other associated alert details, for example,
// AlertConfiguration.
AlertDetails string `json:"alertDetails,omitempty"`
// Name: Rule name
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "AlertDetails") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertDetails") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppSettingsChanged) MarshalJSON() ([]byte, error) {
type NoMethod AppSettingsChanged
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// AppsOutage: An outage incident reported for a Google Workspace service.
type AppsOutage struct {
// DashboardUri: Link to the outage event in Google Workspace Status Dashboard
DashboardUri string `json:"dashboardUri,omitempty"`
// IncidentTrackingId: Incident tracking ID.
IncidentTrackingId string `json:"incidentTrackingId,omitempty"`
// MergeInfo: Indicates new alert details under which the outage is
// communicated. Only populated when Status is MERGED.
MergeInfo *MergeInfo `json:"mergeInfo,omitempty"`
// NextUpdateTime: Timestamp by which the next update is expected to arrive.
NextUpdateTime string `json:"nextUpdateTime,omitempty"`
// Products: List of products impacted by the outage.
Products []string `json:"products,omitempty"`
// ResolutionTime: Timestamp when the outage is expected to be resolved, or has
// confirmed resolution. Provided only when known.
ResolutionTime string `json:"resolutionTime,omitempty"`
// Status: Current outage status.
//
// Possible values:
// "STATUS_UNSPECIFIED" - Status is unspecified.
// "NEW" - The incident has just been reported.
// "ONGOING" - The incident is ongoing.
// "RESOLVED" - The incident has been resolved.
// "FALSE_POSITIVE" - Further assessment indicated no customer impact.
// "PARTIALLY_RESOLVED" - The incident has been partially resolved.
// "MERGED" - The incident was merged into a parent.
// "DOWNGRADED" - The incident has lower impact than initially anticipated.
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "DashboardUri") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DashboardUri") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AppsOutage) MarshalJSON() ([]byte, error) {
type NoMethod AppsOutage
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Attachment: Attachment with application-specific information about an alert.
type Attachment struct {
// Csv: A CSV file attachment.
Csv *Csv `json:"csv,omitempty"`
// ForceSendFields is a list of field names (e.g. "Csv") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Csv") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Attachment) MarshalJSON() ([]byte, error) {
type NoMethod Attachment
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BadWhitelist: Alert for setting the domain or IP that malicious email comes
// from as whitelisted domain or IP in Gmail advanced settings.
type BadWhitelist struct {
// DomainId: The domain ID.
DomainId *DomainId `json:"domainId,omitempty"`
// MaliciousEntity: The entity whose actions triggered a Gmail phishing alert.
MaliciousEntity *MaliciousEntity `json:"maliciousEntity,omitempty"`
// Messages: The list of messages contained by this alert.
Messages []*GmailMessageInfo `json:"messages,omitempty"`
// SourceIp: The source IP address of the malicious email, for example,
// `127.0.0.1`.
SourceIp string `json:"sourceIp,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BadWhitelist) MarshalJSON() ([]byte, error) {
type NoMethod BadWhitelist
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BatchDeleteAlertsRequest: A request to perform batch delete on alerts.
type BatchDeleteAlertsRequest struct {
// AlertId: Required. The list of alert IDs to delete.
AlertId []string `json:"alertId,omitempty"`
// CustomerId: Optional. The unique identifier of the Google Workspace account
// of the customer the alerts are associated with. The `customer_id` must have
// the initial "C" stripped (for example, `046psxkn`). Inferred from the caller
// identity if not provided. Find your customer ID
// (https://support.google.com/cloudidentity/answer/10070793).
CustomerId string `json:"customerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AlertId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchDeleteAlertsRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchDeleteAlertsRequest
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BatchDeleteAlertsResponse: Response to batch delete operation on alerts.
type BatchDeleteAlertsResponse struct {
// FailedAlertStatus: The status details for each failed `alert_id`.
FailedAlertStatus map[string]Status `json:"failedAlertStatus,omitempty"`
// SuccessAlertIds: The successful list of alert IDs.
SuccessAlertIds []string `json:"successAlertIds,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "FailedAlertStatus") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FailedAlertStatus") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchDeleteAlertsResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchDeleteAlertsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BatchUndeleteAlertsRequest: A request to perform batch undelete on alerts.
type BatchUndeleteAlertsRequest struct {
// AlertId: Required. The list of alert IDs to undelete.
AlertId []string `json:"alertId,omitempty"`
// CustomerId: Optional. The unique identifier of the Google Workspace account
// of the customer the alerts are associated with. The `customer_id` must have
// the initial "C" stripped (for example, `046psxkn`). Inferred from the caller
// identity if not provided. Find your customer ID
// (https://support.google.com/cloudidentity/answer/10070793).
CustomerId string `json:"customerId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AlertId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlertId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchUndeleteAlertsRequest) MarshalJSON() ([]byte, error) {
type NoMethod BatchUndeleteAlertsRequest
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// BatchUndeleteAlertsResponse: Response to batch undelete operation on alerts.
type BatchUndeleteAlertsResponse struct {
// FailedAlertStatus: The status details for each failed `alert_id`.
FailedAlertStatus map[string]Status `json:"failedAlertStatus,omitempty"`
// SuccessAlertIds: The successful list of alert IDs.
SuccessAlertIds []string `json:"successAlertIds,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "FailedAlertStatus") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FailedAlertStatus") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BatchUndeleteAlertsResponse) MarshalJSON() ([]byte, error) {
type NoMethod BatchUndeleteAlertsResponse
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CloudPubsubTopic: A reference to a Cloud Pubsub topic. To register for
// notifications, the owner of the topic must grant
// `[email protected]` the
// `projects.topics.publish` permission.
type CloudPubsubTopic struct {
// PayloadFormat: Optional. The format of the payload that would be sent. If
// not specified the format will be JSON.
//
// Possible values:
// "PAYLOAD_FORMAT_UNSPECIFIED" - Payload format is not specified (will use
// JSON as default).
// "JSON" - Use JSON.
PayloadFormat string `json:"payloadFormat,omitempty"`
// TopicName: The `name` field of a Cloud Pubsub [Topic]
// (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
TopicName string `json:"topicName,omitempty"`
// ForceSendFields is a list of field names (e.g. "PayloadFormat") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PayloadFormat") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CloudPubsubTopic) MarshalJSON() ([]byte, error) {
type NoMethod CloudPubsubTopic
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// Csv: A representation of a CSV file attachment, as a list of column headers
// and a list of data rows.
type Csv struct {
// DataRows: The list of data rows in a CSV file, as string arrays rather than
// as a single comma-separated string.
DataRows []*CsvRow `json:"dataRows,omitempty"`
// Headers: The list of headers for data columns in a CSV file.
Headers []string `json:"headers,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataRows") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataRows") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Csv) MarshalJSON() ([]byte, error) {
type NoMethod Csv
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// CsvRow: A representation of a single data row in a CSV file.
type CsvRow struct {
// Entries: The data entries in a CSV file row, as a string array rather than a
// single comma-separated string.
Entries []string `json:"entries,omitempty"`
// ForceSendFields is a list of field names (e.g. "Entries") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Entries") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CsvRow) MarshalJSON() ([]byte, error) {
type NoMethod CsvRow
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// DeviceCompromised: A mobile device compromised alert. Derived from audit
// logs.
type DeviceCompromised struct {
// Email: The email of the user this alert was created for.
Email string `json:"email,omitempty"`
// Events: Required. The list of security events.
Events []*DeviceCompromisedSecurityDetail `json:"events,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceCompromised) MarshalJSON() ([]byte, error) {
type NoMethod DeviceCompromised
return gensupport.MarshalJSON(NoMethod(*s), s.ForceSendFields, s.NullFields)
}
// DeviceCompromisedSecurityDetail: Detailed information of a single MDM device
// compromised event.