-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
Copy pathsafebrowsing-gen.go
2486 lines (2225 loc) · 90.4 KB
/
safebrowsing-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 2019 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 safebrowsing provides access to the Safe Browsing API.
//
// For product documentation, see: https://developers.google.com/safe-browsing/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/safebrowsing/v4"
// ...
// ctx := context.Background()
// safebrowsingService, err := safebrowsing.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 option.WithAPIKey:
//
// safebrowsingService, err := safebrowsing.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// safebrowsingService, err := safebrowsing.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package safebrowsing // import "google.golang.org/api/safebrowsing/v4"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
option "google.golang.org/api/option"
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
const apiId = "safebrowsing:v4"
const apiName = "safebrowsing"
const apiVersion = "v4"
const basePath = "https://safebrowsing.googleapis.com/"
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
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.EncodedFullHashes = NewEncodedFullHashesService(s)
s.EncodedUpdates = NewEncodedUpdatesService(s)
s.FullHashes = NewFullHashesService(s)
s.ThreatHits = NewThreatHitsService(s)
s.ThreatListUpdates = NewThreatListUpdatesService(s)
s.ThreatLists = NewThreatListsService(s)
s.ThreatMatches = NewThreatMatchesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
EncodedFullHashes *EncodedFullHashesService
EncodedUpdates *EncodedUpdatesService
FullHashes *FullHashesService
ThreatHits *ThreatHitsService
ThreatListUpdates *ThreatListUpdatesService
ThreatLists *ThreatListsService
ThreatMatches *ThreatMatchesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewEncodedFullHashesService(s *Service) *EncodedFullHashesService {
rs := &EncodedFullHashesService{s: s}
return rs
}
type EncodedFullHashesService struct {
s *Service
}
func NewEncodedUpdatesService(s *Service) *EncodedUpdatesService {
rs := &EncodedUpdatesService{s: s}
return rs
}
type EncodedUpdatesService struct {
s *Service
}
func NewFullHashesService(s *Service) *FullHashesService {
rs := &FullHashesService{s: s}
return rs
}
type FullHashesService struct {
s *Service
}
func NewThreatHitsService(s *Service) *ThreatHitsService {
rs := &ThreatHitsService{s: s}
return rs
}
type ThreatHitsService struct {
s *Service
}
func NewThreatListUpdatesService(s *Service) *ThreatListUpdatesService {
rs := &ThreatListUpdatesService{s: s}
return rs
}
type ThreatListUpdatesService struct {
s *Service
}
func NewThreatListsService(s *Service) *ThreatListsService {
rs := &ThreatListsService{s: s}
return rs
}
type ThreatListsService struct {
s *Service
}
func NewThreatMatchesService(s *Service) *ThreatMatchesService {
rs := &ThreatMatchesService{s: s}
return rs
}
type ThreatMatchesService struct {
s *Service
}
// Checksum: The expected state of a client's local database.
type Checksum struct {
// Sha256: The SHA256 hash of the client state; that is, of the sorted
// list of all
// hashes present in the database.
Sha256 string `json:"sha256,omitempty"`
// ForceSendFields is a list of field names (e.g. "Sha256") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Sha256") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Checksum) MarshalJSON() ([]byte, error) {
type NoMethod Checksum
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ClientInfo: The client metadata associated with Safe Browsing API
// requests.
type ClientInfo struct {
// ClientId: A client ID that (hopefully) uniquely identifies the client
// implementation
// of the Safe Browsing API.
ClientId string `json:"clientId,omitempty"`
// ClientVersion: The version of the client implementation.
ClientVersion string `json:"clientVersion,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClientId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ClientId") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ClientInfo) MarshalJSON() ([]byte, error) {
type NoMethod ClientInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Constraints: The constraints for this update.
type Constraints struct {
// DeviceLocation: A client's physical location, expressed as a ISO
// 31166-1 alpha-2
// region code.
DeviceLocation string `json:"deviceLocation,omitempty"`
// Language: Requests the lists for a specific language. Expects ISO 639
// alpha-2
// format.
Language string `json:"language,omitempty"`
// MaxDatabaseEntries: Sets the maximum number of entries that the
// client is willing to have
// in the local database. This should be a power of 2 between 2**10
// and
// 2**20. If zero, no database size limit is set.
MaxDatabaseEntries int64 `json:"maxDatabaseEntries,omitempty"`
// MaxUpdateEntries: The maximum size in number of entries. The update
// will not contain more
// entries than this value. This should be a power of 2 between 2**10
// and
// 2**20. If zero, no update size limit is set.
MaxUpdateEntries int64 `json:"maxUpdateEntries,omitempty"`
// Region: Requests the list for a specific geographic location. If not
// set the
// server may pick that value based on the user's IP address. Expects
// ISO
// 3166-1 alpha-2 format.
Region string `json:"region,omitempty"`
// SupportedCompressions: The compression types supported by the client.
//
// Possible values:
// "COMPRESSION_TYPE_UNSPECIFIED" - Unknown.
// "RAW" - Raw, uncompressed data.
// "RICE" - Rice-Golomb encoded data.
SupportedCompressions []string `json:"supportedCompressions,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceLocation") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceLocation") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Constraints) MarshalJSON() ([]byte, error) {
type NoMethod Constraints
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Empty: A generic empty message that you can re-use to avoid defining
// duplicated
// empty messages in your APIs. A typical example is to use it as the
// request
// or the response type of an API method. For instance:
//
// service Foo {
// rpc Bar(google.protobuf.Empty) returns
// (google.protobuf.Empty);
// }
//
// The JSON representation for `Empty` is empty JSON object `{}`.
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// FetchThreatListUpdatesRequest: Describes a Safe Browsing API update
// request. Clients can request updates for
// multiple lists in a single request.
// NOTE: Field index 2 is unused.
// NEXT: 5
type FetchThreatListUpdatesRequest struct {
// Client: The client metadata.
Client *ClientInfo `json:"client,omitempty"`
// ListUpdateRequests: The requested threat list updates.
ListUpdateRequests []*ListUpdateRequest `json:"listUpdateRequests,omitempty"`
// ForceSendFields is a list of field names (e.g. "Client") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Client") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FetchThreatListUpdatesRequest) MarshalJSON() ([]byte, error) {
type NoMethod FetchThreatListUpdatesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type FetchThreatListUpdatesResponse struct {
// ListUpdateResponses: The list updates requested by the clients.
ListUpdateResponses []*ListUpdateResponse `json:"listUpdateResponses,omitempty"`
// MinimumWaitDuration: The minimum duration the client must wait before
// issuing any update
// request. If this field is not set clients may update as soon as they
// want.
MinimumWaitDuration string `json:"minimumWaitDuration,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ListUpdateResponses")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ListUpdateResponses") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *FetchThreatListUpdatesResponse) MarshalJSON() ([]byte, error) {
type NoMethod FetchThreatListUpdatesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FindFullHashesRequest: Request to return full hashes matched by the
// provided hash prefixes.
type FindFullHashesRequest struct {
// ApiClient: Client metadata associated with callers of higher-level
// APIs built on top
// of the client's implementation.
ApiClient *ClientInfo `json:"apiClient,omitempty"`
// Client: The client metadata.
Client *ClientInfo `json:"client,omitempty"`
// ClientStates: The current client states for each of the client's
// local threat lists.
ClientStates []string `json:"clientStates,omitempty"`
// ThreatInfo: The lists and hashes to be checked.
ThreatInfo *ThreatInfo `json:"threatInfo,omitempty"`
// ForceSendFields is a list of field names (e.g. "ApiClient") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ApiClient") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FindFullHashesRequest) MarshalJSON() ([]byte, error) {
type NoMethod FindFullHashesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type FindFullHashesResponse struct {
// Matches: The full hashes that matched the requested prefixes.
Matches []*ThreatMatch `json:"matches,omitempty"`
// MinimumWaitDuration: The minimum duration the client must wait before
// issuing any find hashes
// request. If this field is not set, clients can issue a request as
// soon as
// they want.
MinimumWaitDuration string `json:"minimumWaitDuration,omitempty"`
// NegativeCacheDuration: For requested entities that did not match the
// threat list, how long to
// cache the response.
NegativeCacheDuration string `json:"negativeCacheDuration,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Matches") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Matches") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FindFullHashesResponse) MarshalJSON() ([]byte, error) {
type NoMethod FindFullHashesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FindThreatMatchesRequest: Request to check entries against lists.
type FindThreatMatchesRequest struct {
// Client: The client metadata.
Client *ClientInfo `json:"client,omitempty"`
// ThreatInfo: The lists and entries to be checked for matches.
ThreatInfo *ThreatInfo `json:"threatInfo,omitempty"`
// ForceSendFields is a list of field names (e.g. "Client") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Client") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FindThreatMatchesRequest) MarshalJSON() ([]byte, error) {
type NoMethod FindThreatMatchesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type FindThreatMatchesResponse struct {
// Matches: The threat list matches.
Matches []*ThreatMatch `json:"matches,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Matches") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Matches") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FindThreatMatchesResponse) MarshalJSON() ([]byte, error) {
type NoMethod FindThreatMatchesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListThreatListsResponse struct {
// ThreatLists: The lists available for download by the client.
ThreatLists []*ThreatListDescriptor `json:"threatLists,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ThreatLists") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ThreatLists") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListThreatListsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListThreatListsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListUpdateRequest: A single list update request.
type ListUpdateRequest struct {
// Constraints: The constraints associated with this request.
Constraints *Constraints `json:"constraints,omitempty"`
// PlatformType: The type of platform at risk by entries present in the
// list.
//
// Possible values:
// "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
// "WINDOWS" - Threat posed to Windows.
// "LINUX" - Threat posed to Linux.
// "ANDROID" - Threat posed to Android.
// "OSX" - Threat posed to OS X.
// "IOS" - Threat posed to iOS.
// "ANY_PLATFORM" - Threat posed to at least one of the defined
// platforms.
// "ALL_PLATFORMS" - Threat posed to all defined platforms.
// "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// State: The current state of the client for the requested list (the
// encrypted
// client state that was received from the last successful list update).
State string `json:"state,omitempty"`
// ThreatEntryType: The types of entries present in the list.
//
// Possible values:
// "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
// "URL" - A URL.
// "EXECUTABLE" - An executable program.
// "IP_RANGE" - An IP range.
// "CHROME_EXTENSION" - Chrome extension.
// "FILENAME" - Filename.
// "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The type of threat posed by entries present in the list.
//
// Possible values:
// "THREAT_TYPE_UNSPECIFIED" - Unknown.
// "MALWARE" - Malware threat type.
// "SOCIAL_ENGINEERING" - Social engineering threat type.
// "UNWANTED_SOFTWARE" - Unwanted software threat type.
// "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
// threat type.
// "SOCIAL_ENGINEERING_INTERNAL" - Social engineering threat type for
// internal use.
// "API_ABUSE" - API abuse threat type.
// "MALICIOUS_BINARY" - Malicious binary threat type.
// "CSD_WHITELIST" - Client side detection whitelist threat type.
// "CSD_DOWNLOAD_WHITELIST" - Client side download detection whitelist
// threat type.
// "CLIENT_INCIDENT" - Client incident threat type.
// "CLIENT_INCIDENT_WHITELIST" - Whitelist used when detecting client
// incident threats.
// This enum was never launched and should be re-used for the next list.
// "APK_MALWARE_OFFLINE" - List used for offline APK checks in PAM.
// "SUBRESOURCE_FILTER" - Patterns to be used for activating the
// subresource filter. Interstitial
// will not be shown for patterns from this list.
// "SUSPICIOUS" - Entities that are suspected to present a threat.
// "TRICK_TO_BILL" - Trick-to-bill threat list.
// "HIGH_CONFIDENCE_ALLOWLIST" - Safe list to ship hashes of known
// safe URL expressions.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Constraints") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Constraints") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListUpdateRequest) MarshalJSON() ([]byte, error) {
type NoMethod ListUpdateRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListUpdateResponse: An update to an individual list.
type ListUpdateResponse struct {
// Additions: A set of entries to add to a local threat type's list.
// Repeated to allow
// for a combination of compressed and raw data to be sent in a
// single
// response.
Additions []*ThreatEntrySet `json:"additions,omitempty"`
// Checksum: The expected SHA256 hash of the client state; that is, of
// the sorted list
// of all hashes present in the database after applying the provided
// update.
// If the client state doesn't match the expected state, the client
// must
// disregard this update and retry later.
Checksum *Checksum `json:"checksum,omitempty"`
// NewClientState: The new client state, in encrypted format. Opaque to
// clients.
NewClientState string `json:"newClientState,omitempty"`
// PlatformType: The platform type for which data is returned.
//
// Possible values:
// "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
// "WINDOWS" - Threat posed to Windows.
// "LINUX" - Threat posed to Linux.
// "ANDROID" - Threat posed to Android.
// "OSX" - Threat posed to OS X.
// "IOS" - Threat posed to iOS.
// "ANY_PLATFORM" - Threat posed to at least one of the defined
// platforms.
// "ALL_PLATFORMS" - Threat posed to all defined platforms.
// "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// Removals: A set of entries to remove from a local threat type's list.
// In practice,
// this field is empty or contains exactly one ThreatEntrySet.
Removals []*ThreatEntrySet `json:"removals,omitempty"`
// ResponseType: The type of response. This may indicate that an action
// is required by the
// client when the response is received.
//
// Possible values:
// "RESPONSE_TYPE_UNSPECIFIED" - Unknown.
// "PARTIAL_UPDATE" - Partial updates are applied to the client's
// existing local database.
// "FULL_UPDATE" - Full updates replace the client's entire local
// database. This means
// that either the client was seriously out-of-date or the client
// is
// believed to be corrupt.
ResponseType string `json:"responseType,omitempty"`
// ThreatEntryType: The format of the threats.
//
// Possible values:
// "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
// "URL" - A URL.
// "EXECUTABLE" - An executable program.
// "IP_RANGE" - An IP range.
// "CHROME_EXTENSION" - Chrome extension.
// "FILENAME" - Filename.
// "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The threat type for which data is returned.
//
// Possible values:
// "THREAT_TYPE_UNSPECIFIED" - Unknown.
// "MALWARE" - Malware threat type.
// "SOCIAL_ENGINEERING" - Social engineering threat type.
// "UNWANTED_SOFTWARE" - Unwanted software threat type.
// "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
// threat type.
// "SOCIAL_ENGINEERING_INTERNAL" - Social engineering threat type for
// internal use.
// "API_ABUSE" - API abuse threat type.
// "MALICIOUS_BINARY" - Malicious binary threat type.
// "CSD_WHITELIST" - Client side detection whitelist threat type.
// "CSD_DOWNLOAD_WHITELIST" - Client side download detection whitelist
// threat type.
// "CLIENT_INCIDENT" - Client incident threat type.
// "CLIENT_INCIDENT_WHITELIST" - Whitelist used when detecting client
// incident threats.
// This enum was never launched and should be re-used for the next list.
// "APK_MALWARE_OFFLINE" - List used for offline APK checks in PAM.
// "SUBRESOURCE_FILTER" - Patterns to be used for activating the
// subresource filter. Interstitial
// will not be shown for patterns from this list.
// "SUSPICIOUS" - Entities that are suspected to present a threat.
// "TRICK_TO_BILL" - Trick-to-bill threat list.
// "HIGH_CONFIDENCE_ALLOWLIST" - Safe list to ship hashes of known
// safe URL expressions.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Additions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Additions") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListUpdateResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListUpdateResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// MetadataEntry: A single metadata entry.
type MetadataEntry struct {
// Key: The metadata entry key. For JSON requests, the key is
// base64-encoded.
Key string `json:"key,omitempty"`
// Value: The metadata entry value. For JSON requests, the value is
// base64-encoded.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Key") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MetadataEntry) MarshalJSON() ([]byte, error) {
type NoMethod MetadataEntry
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// RawHashes: The uncompressed threat entries in hash format of a
// particular prefix length.
// Hashes can be anywhere from 4 to 32 bytes in size. A large majority
// are 4
// bytes, but some hashes are lengthened if they collide with the hash
// of a
// popular URL.
//
// Used for sending ThreatEntrySet to clients that do not support
// compression,
// or when sending non-4-byte hashes to clients that do support
// compression.
type RawHashes struct {
// PrefixSize: The number of bytes for each prefix encoded below. This
// field can be
// anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
PrefixSize int64 `json:"prefixSize,omitempty"`
// RawHashes: The hashes, in binary format, concatenated into one long
// string. Hashes are
// sorted in lexicographic order. For JSON API users, hashes
// are
// base64-encoded.
RawHashes string `json:"rawHashes,omitempty"`
// ForceSendFields is a list of field names (e.g. "PrefixSize") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PrefixSize") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *RawHashes) MarshalJSON() ([]byte, error) {
type NoMethod RawHashes
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// RawIndices: A set of raw indices to remove from a local list.
type RawIndices struct {
// Indices: The indices to remove from a lexicographically-sorted local
// list.
Indices []int64 `json:"indices,omitempty"`
// ForceSendFields is a list of field names (e.g. "Indices") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Indices") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *RawIndices) MarshalJSON() ([]byte, error) {
type NoMethod RawIndices
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// RiceDeltaEncoding: The Rice-Golomb encoded data. Used for sending
// compressed 4-byte hashes or
// compressed removal indices.
type RiceDeltaEncoding struct {
// EncodedData: The encoded deltas that are encoded using the
// Golomb-Rice coder.
EncodedData string `json:"encodedData,omitempty"`
// FirstValue: The offset of the first entry in the encoded data, or, if
// only a single
// integer was encoded, that single integer's value. If the field is
// empty or
// missing, assume zero.
FirstValue int64 `json:"firstValue,omitempty,string"`
// NumEntries: The number of entries that are delta encoded in the
// encoded data. If only a
// single integer was encoded, this will be zero and the single value
// will be
// stored in `first_value`.
NumEntries int64 `json:"numEntries,omitempty"`
// RiceParameter: The Golomb-Rice parameter, which is a number between 2
// and 28. This field
// is missing (that is, zero) if `num_entries` is zero.
RiceParameter int64 `json:"riceParameter,omitempty"`
// ForceSendFields is a list of field names (e.g. "EncodedData") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EncodedData") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *RiceDeltaEncoding) MarshalJSON() ([]byte, error) {
type NoMethod RiceDeltaEncoding
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ThreatEntry: An individual threat; for example, a malicious URL or
// its hash
// representation. Only one of these fields should be set.
type ThreatEntry struct {
// Digest: The digest of an executable in SHA256 format. The API
// supports both
// binary and hex digests. For JSON requests, digests are
// base64-encoded.
Digest string `json:"digest,omitempty"`
// Hash: A hash prefix, consisting of the most significant 4-32 bytes of
// a SHA256
// hash. This field is in binary format. For JSON requests, hashes
// are
// base64-encoded.
Hash string `json:"hash,omitempty"`
// Url: A URL.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Digest") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`