-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
discovery-gen.go
1070 lines (995 loc) · 43.7 KB
/
discovery-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 discovery provides access to the API Discovery Service.
//
// For product documentation, see: https://developers.google.com/discovery/
//
// # 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/discovery/v1"
// ...
// ctx := context.Background()
// discoveryService, err := discovery.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]:
//
// discoveryService, err := discovery.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, ...)
// discoveryService, err := discovery.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package discovery // import "google.golang.org/api/discovery/v1"
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 = "discovery:v1"
const apiName = "discovery"
const apiVersion = "v1"
const basePath = "https://www.googleapis.com/discovery/v1/"
const basePathTemplate = "https://www.UNIVERSE_DOMAIN/discovery/v1/"
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
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.Apis = NewApisService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Apis *ApisService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewApisService(s *Service) *ApisService {
rs := &ApisService{s: s}
return rs
}
type ApisService struct {
s *Service
}
type DirectoryList struct {
// DiscoveryVersion: Indicate the version of the Discovery API used to generate
// this doc.
DiscoveryVersion string `json:"discoveryVersion,omitempty"`
// Items: The individual directory entries. One entry per api/version pair.
Items []*DirectoryListItems `json:"items,omitempty"`
// Kind: The kind for this response.
Kind string `json:"kind,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DiscoveryVersion") 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. "DiscoveryVersion") 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 DirectoryList) MarshalJSON() ([]byte, error) {
type NoMethod DirectoryList
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type DirectoryListItems struct {
// Description: The description of this API.
Description string `json:"description,omitempty"`
// DiscoveryLink: A link to the discovery document.
DiscoveryLink string `json:"discoveryLink,omitempty"`
// DiscoveryRestUrl: The URL for the discovery REST document.
DiscoveryRestUrl string `json:"discoveryRestUrl,omitempty"`
// DocumentationLink: A link to human readable documentation for the API.
DocumentationLink string `json:"documentationLink,omitempty"`
// Icons: Links to 16x16 and 32x32 icons representing the API.
Icons *DirectoryListItemsIcons `json:"icons,omitempty"`
// Id: The id of this API.
Id string `json:"id,omitempty"`
// Kind: The kind for this response.
Kind string `json:"kind,omitempty"`
// Labels: Labels for the status of this API, such as labs or deprecated.
Labels []string `json:"labels,omitempty"`
// Name: The name of the API.
Name string `json:"name,omitempty"`
// Preferred: True if this version is the preferred version to use.
Preferred bool `json:"preferred,omitempty"`
// Title: The title of this API.
Title string `json:"title,omitempty"`
// Version: The version of the API.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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 DirectoryListItems) MarshalJSON() ([]byte, error) {
type NoMethod DirectoryListItems
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DirectoryListItemsIcons: Links to 16x16 and 32x32 icons representing the
// API.
type DirectoryListItemsIcons struct {
// X16: The URL of the 16x16 icon.
X16 string `json:"x16,omitempty"`
// X32: The URL of the 32x32 icon.
X32 string `json:"x32,omitempty"`
// ForceSendFields is a list of field names (e.g. "X16") 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. "X16") 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 DirectoryListItemsIcons) MarshalJSON() ([]byte, error) {
type NoMethod DirectoryListItemsIcons
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type JsonSchema struct {
// Ref: A reference to another schema. The value of this property is the "id"
// of another schema.
Ref string `json:"$ref,omitempty"`
// AdditionalProperties: If this is a schema for an object, this property is
// the schema for any additional properties with dynamic keys on this object.
AdditionalProperties *JsonSchema `json:"additionalProperties,omitempty"`
// Annotations: Additional information about this property.
Annotations *JsonSchemaAnnotations `json:"annotations,omitempty"`
// Default: The default value of this property (if one exists).
Default string `json:"default,omitempty"`
// Deprecated -- Whether the parameter is deprecated.
Deprecated bool `json:"deprecated,omitempty"`
// Description: A description of this object.
Description string `json:"description,omitempty"`
// Enum: Values this parameter may take (if it is an enum).
Enum []string `json:"enum,omitempty"`
// EnumDeprecated: The deprecation status for the enums. Each position maps to
// the corresponding value in the "enum" array.
EnumDeprecated []bool `json:"enumDeprecated,omitempty"`
// EnumDescriptions: The descriptions for the enums. Each position maps to the
// corresponding value in the "enum" array.
EnumDescriptions []string `json:"enumDescriptions,omitempty"`
// Format: An additional regular expression or key that helps constrain the
// value. For more details see:
// http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
Format string `json:"format,omitempty"`
// Id: Unique identifier for this schema.
Id string `json:"id,omitempty"`
// Items: If this is a schema for an array, this property is the schema for
// each element in the array.
Items *JsonSchema `json:"items,omitempty"`
// Location: Whether this parameter goes in the query or the path for REST
// requests.
Location string `json:"location,omitempty"`
// Maximum: The maximum value of this parameter.
Maximum string `json:"maximum,omitempty"`
// Minimum: The minimum value of this parameter.
Minimum string `json:"minimum,omitempty"`
// Pattern: The regular expression this parameter must conform to. Uses Java 6
// regex format:
// http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
Pattern string `json:"pattern,omitempty"`
// Properties: If this is a schema for an object, list the schema for each
// property of this object.
Properties map[string]JsonSchema `json:"properties,omitempty"`
// ReadOnly: The value is read-only, generated by the service. The value cannot
// be modified by the client. If the value is included in a POST, PUT, or PATCH
// request, it is ignored by the service.
ReadOnly bool `json:"readOnly,omitempty"`
// Repeated: Whether this parameter may appear multiple times.
Repeated bool `json:"repeated,omitempty"`
// Required: Whether the parameter is required.
Required bool `json:"required,omitempty"`
// Type: The value type for this schema. A list of values can be found here:
// http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
Type string `json:"type,omitempty"`
// Variant: In a variant data type, the value of one property is used to
// determine how to interpret the entire entity. Its value must exist in a map
// of descriminant values to schema names.
Variant *JsonSchemaVariant `json:"variant,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ref") 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. "Ref") 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 JsonSchema) MarshalJSON() ([]byte, error) {
type NoMethod JsonSchema
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// JsonSchemaAnnotations: Additional information about this property.
type JsonSchemaAnnotations struct {
// Required: A list of methods for which this property is required on requests.
Required []string `json:"required,omitempty"`
// ForceSendFields is a list of field names (e.g. "Required") 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. "Required") 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 JsonSchemaAnnotations) MarshalJSON() ([]byte, error) {
type NoMethod JsonSchemaAnnotations
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// JsonSchemaVariant: In a variant data type, the value of one property is used
// to determine how to interpret the entire entity. Its value must exist in a
// map of descriminant values to schema names.
type JsonSchemaVariant struct {
// Discriminant: The name of the type discriminant property.
Discriminant string `json:"discriminant,omitempty"`
// Map: The map of discriminant value to schema to use for parsing..
Map []*JsonSchemaVariantMap `json:"map,omitempty"`
// ForceSendFields is a list of field names (e.g. "Discriminant") 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. "Discriminant") 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 JsonSchemaVariant) MarshalJSON() ([]byte, error) {
type NoMethod JsonSchemaVariant
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type JsonSchemaVariantMap struct {
Ref string `json:"$ref,omitempty"`
TypeValue string `json:"type_value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ref") 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. "Ref") 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 JsonSchemaVariantMap) MarshalJSON() ([]byte, error) {
type NoMethod JsonSchemaVariantMap
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type RestDescription struct {
// Auth: Authentication information.
Auth *RestDescriptionAuth `json:"auth,omitempty"`
// BasePath: [DEPRECATED] The base path for REST requests.
BasePath string `json:"basePath,omitempty"`
// BaseUrl: [DEPRECATED] The base URL for REST requests.
BaseUrl string `json:"baseUrl,omitempty"`
// BatchPath: The path for REST batch requests.
BatchPath string `json:"batchPath,omitempty"`
// CanonicalName: Indicates how the API name should be capitalized and split
// into various parts. Useful for generating pretty class names.
CanonicalName string `json:"canonicalName,omitempty"`
// Description: The description of this API.
Description string `json:"description,omitempty"`
// DiscoveryVersion: Indicate the version of the Discovery API used to generate
// this doc.
DiscoveryVersion string `json:"discoveryVersion,omitempty"`
// DocumentationLink: A link to human readable documentation for the API.
DocumentationLink string `json:"documentationLink,omitempty"`
// Endpoints: A list of location-based endpoint objects for this API. Each
// object contains the endpoint URL, location, description and deprecation
// status.
Endpoints []*RestDescriptionEndpoints `json:"endpoints,omitempty"`
// Etag: The ETag for this response.
Etag string `json:"etag,omitempty"`
// ExponentialBackoffDefault: Enable exponential backoff for suitable methods
// in the generated clients.
ExponentialBackoffDefault bool `json:"exponentialBackoffDefault,omitempty"`
// Features: A list of supported features for this API.
Features []string `json:"features,omitempty"`
// Icons: Links to 16x16 and 32x32 icons representing the API.
Icons *RestDescriptionIcons `json:"icons,omitempty"`
// Id: The ID of this API.
Id string `json:"id,omitempty"`
// Kind: The kind for this response.
Kind string `json:"kind,omitempty"`
// Labels: Labels for the status of this API, such as labs or deprecated.
Labels []string `json:"labels,omitempty"`
// Methods: API-level methods for this API.
Methods map[string]RestMethod `json:"methods,omitempty"`
// Name: The name of this API.
Name string `json:"name,omitempty"`
// OwnerDomain: The domain of the owner of this API. Together with the
// ownerName and a packagePath values, this can be used to generate a library
// for this API which would have a unique fully qualified name.
OwnerDomain string `json:"ownerDomain,omitempty"`
// OwnerName: The name of the owner of this API. See ownerDomain.
OwnerName string `json:"ownerName,omitempty"`
// PackagePath: The package of the owner of this API. See ownerDomain.
PackagePath string `json:"packagePath,omitempty"`
// Parameters: Common parameters that apply across all apis.
Parameters map[string]JsonSchema `json:"parameters,omitempty"`
// Protocol: The protocol described by this document.
Protocol string `json:"protocol,omitempty"`
// Resources: The resources in this API.
Resources map[string]RestResource `json:"resources,omitempty"`
// Revision: The version of this API.
Revision string `json:"revision,omitempty"`
// RootUrl: The root URL under which all API services live.
RootUrl string `json:"rootUrl,omitempty"`
// Schemas: The schemas for this API.
Schemas map[string]JsonSchema `json:"schemas,omitempty"`
// ServicePath: The base path for all REST requests.
ServicePath string `json:"servicePath,omitempty"`
// Title: The title of this API.
Title string `json:"title,omitempty"`
// Version: The version of this API.
Version string `json:"version,omitempty"`
VersionModule bool `json:"version_module,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Auth") 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. "Auth") 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 RestDescription) MarshalJSON() ([]byte, error) {
type NoMethod RestDescription
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestDescriptionAuth: Authentication information.
type RestDescriptionAuth struct {
// Oauth2: OAuth 2.0 authentication information.
Oauth2 *RestDescriptionAuthOauth2 `json:"oauth2,omitempty"`
// ForceSendFields is a list of field names (e.g. "Oauth2") 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. "Oauth2") 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 RestDescriptionAuth) MarshalJSON() ([]byte, error) {
type NoMethod RestDescriptionAuth
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestDescriptionAuthOauth2: OAuth 2.0 authentication information.
type RestDescriptionAuthOauth2 struct {
// Scopes: Available OAuth 2.0 scopes.
Scopes map[string]RestDescriptionAuthOauth2Scopes `json:"scopes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Scopes") 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. "Scopes") 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 RestDescriptionAuthOauth2) MarshalJSON() ([]byte, error) {
type NoMethod RestDescriptionAuthOauth2
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestDescriptionAuthOauth2Scopes: The scope value.
type RestDescriptionAuthOauth2Scopes struct {
// Description: Description of scope.
Description string `json:"description,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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 RestDescriptionAuthOauth2Scopes) MarshalJSON() ([]byte, error) {
type NoMethod RestDescriptionAuthOauth2Scopes
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestDescriptionEndpoints: A single endpoint object
type RestDescriptionEndpoints struct {
// Deprecated -- Whether this endpoint is deprecated
Deprecated bool `json:"deprecated,omitempty"`
// Description: A string describing the host designated by the URL
Description string `json:"description,omitempty"`
// EndpointUrl: The URL of the endpoint target host
EndpointUrl string `json:"endpointUrl,omitempty"`
// Location: The location of the endpoint
Location string `json:"location,omitempty"`
// ForceSendFields is a list of field names (e.g. "Deprecated") 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. "Deprecated") 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 RestDescriptionEndpoints) MarshalJSON() ([]byte, error) {
type NoMethod RestDescriptionEndpoints
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestDescriptionIcons: Links to 16x16 and 32x32 icons representing the API.
type RestDescriptionIcons struct {
// X16: The URL of the 16x16 icon.
X16 string `json:"x16,omitempty"`
// X32: The URL of the 32x32 icon.
X32 string `json:"x32,omitempty"`
// ForceSendFields is a list of field names (e.g. "X16") 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. "X16") 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 RestDescriptionIcons) MarshalJSON() ([]byte, error) {
type NoMethod RestDescriptionIcons
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type RestMethod struct {
// ApiVersion: The API Version of this method, as passed in via the
// `X-Goog-Api-Version` header or `$apiVersion` query parameter.
ApiVersion string `json:"apiVersion,omitempty"`
// Deprecated -- Whether this method is deprecated.
Deprecated bool `json:"deprecated,omitempty"`
// Description: Description of this method.
Description string `json:"description,omitempty"`
// EtagRequired: Whether this method requires an ETag to be specified. The ETag
// is sent as an HTTP If-Match or If-None-Match header.
EtagRequired bool `json:"etagRequired,omitempty"`
// FlatPath: The URI path of this REST method in (RFC 6570) format without
// level 2 features ({+var}). Supplementary to the path property.
FlatPath string `json:"flatPath,omitempty"`
// HttpMethod: HTTP method used by this method.
HttpMethod string `json:"httpMethod,omitempty"`
// Id: A unique ID for this method. This property can be used to match methods
// between different versions of Discovery.
Id string `json:"id,omitempty"`
// MediaUpload: Media upload parameters.
MediaUpload *RestMethodMediaUpload `json:"mediaUpload,omitempty"`
// ParameterOrder: Ordered list of required parameters, serves as a hint to
// clients on how to structure their method signatures. The array is ordered
// such that the "most-significant" parameter appears first.
ParameterOrder []string `json:"parameterOrder,omitempty"`
// Parameters: Details for all parameters in this method.
Parameters map[string]JsonSchema `json:"parameters,omitempty"`
// Path: The URI path of this REST method. Should be used in conjunction with
// the basePath property at the api-level.
Path string `json:"path,omitempty"`
// Request: The schema for the request.
Request *RestMethodRequest `json:"request,omitempty"`
// Response: The schema for the response.
Response *RestMethodResponse `json:"response,omitempty"`
// Scopes: OAuth 2.0 scopes applicable to this method.
Scopes []string `json:"scopes,omitempty"`
// SupportsMediaDownload: Whether this method supports media downloads.
SupportsMediaDownload bool `json:"supportsMediaDownload,omitempty"`
// SupportsMediaUpload: Whether this method supports media uploads.
SupportsMediaUpload bool `json:"supportsMediaUpload,omitempty"`
// SupportsSubscription: Whether this method supports subscriptions.
SupportsSubscription bool `json:"supportsSubscription,omitempty"`
// UseMediaDownloadService: Indicates that downloads from this method should
// use the download service URL (i.e. "/download"). Only applies if the method
// supports media download.
UseMediaDownloadService bool `json:"useMediaDownloadService,omitempty"`
// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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 RestMethod) MarshalJSON() ([]byte, error) {
type NoMethod RestMethod
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodMediaUpload: Media upload parameters.
type RestMethodMediaUpload struct {
// Accept: MIME Media Ranges for acceptable media uploads to this method.
Accept []string `json:"accept,omitempty"`
// MaxSize: Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
MaxSize string `json:"maxSize,omitempty"`
// Protocols: Supported upload protocols.
Protocols *RestMethodMediaUploadProtocols `json:"protocols,omitempty"`
// ForceSendFields is a list of field names (e.g. "Accept") 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. "Accept") 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 RestMethodMediaUpload) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodMediaUpload
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodMediaUploadProtocols: Supported upload protocols.
type RestMethodMediaUploadProtocols struct {
// Resumable: Supports the Resumable Media Upload protocol.
Resumable *RestMethodMediaUploadProtocolsResumable `json:"resumable,omitempty"`
// Simple: Supports uploading as a single HTTP request.
Simple *RestMethodMediaUploadProtocolsSimple `json:"simple,omitempty"`
// ForceSendFields is a list of field names (e.g. "Resumable") 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. "Resumable") 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 RestMethodMediaUploadProtocols) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodMediaUploadProtocols
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodMediaUploadProtocolsResumable: Supports the Resumable Media Upload
// protocol.
type RestMethodMediaUploadProtocolsResumable struct {
// Multipart: True if this endpoint supports uploading multipart media.
//
// Default: true
Multipart *bool `json:"multipart,omitempty"`
// Path: The URI path to be used for upload. Should be used in conjunction with
// the basePath property at the api-level.
Path string `json:"path,omitempty"`
// ForceSendFields is a list of field names (e.g. "Multipart") 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. "Multipart") 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 RestMethodMediaUploadProtocolsResumable) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodMediaUploadProtocolsResumable
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodMediaUploadProtocolsSimple: Supports uploading as a single HTTP
// request.
type RestMethodMediaUploadProtocolsSimple struct {
// Multipart: True if this endpoint supports upload multipart media.
//
// Default: true
Multipart *bool `json:"multipart,omitempty"`
// Path: The URI path to be used for upload. Should be used in conjunction with
// the basePath property at the api-level.
Path string `json:"path,omitempty"`
// ForceSendFields is a list of field names (e.g. "Multipart") 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. "Multipart") 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 RestMethodMediaUploadProtocolsSimple) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodMediaUploadProtocolsSimple
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodRequest: The schema for the request.
type RestMethodRequest struct {
// Ref: Schema ID for the request schema.
Ref string `json:"$ref,omitempty"`
// ParameterName: parameter name.
ParameterName string `json:"parameterName,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ref") 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. "Ref") 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 RestMethodRequest) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodRequest
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// RestMethodResponse: The schema for the response.
type RestMethodResponse struct {
// Ref: Schema ID for the response schema.
Ref string `json:"$ref,omitempty"`
// ForceSendFields is a list of field names (e.g. "Ref") 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. "Ref") 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 RestMethodResponse) MarshalJSON() ([]byte, error) {
type NoMethod RestMethodResponse
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type RestResource struct {
// Deprecated -- Whether this resource is deprecated.
Deprecated bool `json:"deprecated,omitempty"`
// Methods: Methods on this resource.
Methods map[string]RestMethod `json:"methods,omitempty"`
// Resources: Sub-resources on this resource.
Resources map[string]RestResource `json:"resources,omitempty"`
// ForceSendFields is a list of field names (e.g. "Deprecated") 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. "Deprecated") 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 RestResource) MarshalJSON() ([]byte, error) {
type NoMethod RestResource
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
type ApisGetRestCall struct {
s *Service
api string
version string
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// GetRest: Retrieve the description of a particular version of an api.
//
// - api: The name of the API.
// - version: The version of the API.
func (r *ApisService) GetRest(api string, version string) *ApisGetRestCall {
c := &ApisGetRestCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.api = api
c.version = version
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *ApisGetRestCall) Fields(s ...googleapi.Field) *ApisGetRestCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *ApisGetRestCall) IfNoneMatch(entityTag string) *ApisGetRestCall {
c.ifNoneMatch_ = entityTag
return c
}
// Context sets the context to be used in this call's Do method.
func (c *ApisGetRestCall) Context(ctx context.Context) *ApisGetRestCall {
c.ctx_ = ctx
return c
}
// Header returns a http.Header that can be modified by the caller to add
// headers to the request.
func (c *ApisGetRestCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *ApisGetRestCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_)
if c.ifNoneMatch_ != "" {
reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
}
var body io.Reader = nil
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "apis/{api}/{version}/rest")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("GET", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"api": c.api,
"version": c.version,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "discovery.apis.getRest" call.
// Any non-2xx status code is an error. Response headers are in either
// *RestDescription.ServerResponse.Header or (if a response was returned at
// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
// check whether the returned error was because http.StatusNotModified was
// returned.
func (c *ApisGetRestCall) Do(opts ...googleapi.CallOption) (*RestDescription, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &RestDescription{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
}
type ApisListCall struct {
s *Service
urlParams_ gensupport.URLParams
ifNoneMatch_ string
ctx_ context.Context
header_ http.Header
}
// List: Retrieve the list of APIs supported at this endpoint.
func (r *ApisService) List() *ApisListCall {
c := &ApisListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
}
// Name sets the optional parameter "name": Only include APIs with the given
// name.
func (c *ApisListCall) Name(name string) *ApisListCall {
c.urlParams_.Set("name", name)
return c
}
// Preferred sets the optional parameter "preferred": Return only the preferred
// version of an API.
func (c *ApisListCall) Preferred(preferred bool) *ApisListCall {
c.urlParams_.Set("preferred", fmt.Sprint(preferred))
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more
// details.
func (c *ApisListCall) Fields(s ...googleapi.Field) *ApisListCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// IfNoneMatch sets an optional parameter which makes the operation fail if the
// object's ETag matches the given value. This is useful for getting updates
// only after the object has changed since the last request.
func (c *ApisListCall) IfNoneMatch(entityTag string) *ApisListCall {
c.ifNoneMatch_ = entityTag
return c
}