forked from distribution/distribution
-
Notifications
You must be signed in to change notification settings - Fork 0
/
spectrum-gen.go
2200 lines (1935 loc) · 86.9 KB
/
spectrum-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
// Package spectrum provides access to the Google Spectrum Database API.
//
// See http://developers.google.com/spectrum
//
// Usage example:
//
// import "google.golang.org/api/spectrum/v1explorer"
// ...
// spectrumService, err := spectrum.New(oauthHttpClient)
package spectrum // import "google.golang.org/api/spectrum/v1explorer"
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"golang.org/x/net/context"
"golang.org/x/net/context/ctxhttp"
"google.golang.org/api/googleapi"
"google.golang.org/api/internal"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// 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 _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = internal.MarshalJSON
var _ = context.Canceled
var _ = ctxhttp.Do
const apiId = "spectrum:v1explorer"
const apiName = "spectrum"
const apiVersion = "v1explorer"
const basePath = "https://www.googleapis.com/spectrum/v1explorer/paws/"
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Paws = NewPawsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Paws *PawsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewPawsService(s *Service) *PawsService {
rs := &PawsService{s: s}
return rs
}
type PawsService struct {
s *Service
}
// AntennaCharacteristics: Antenna characteristics provide additional
// information, such as the antenna height, antenna type, etc. Whether
// antenna characteristics must be provided in a request depends on the
// device type and regulatory domain.
type AntennaCharacteristics struct {
// Height: The antenna height in meters. Whether the antenna height is
// required depends on the device type and the regulatory domain. Note
// that the height may be negative.
Height float64 `json:"height,omitempty"`
// HeightType: If the height is required, then the height type (AGL for
// above ground level or AMSL for above mean sea level) is also
// required. The default is AGL.
HeightType string `json:"heightType,omitempty"`
// HeightUncertainty: The height uncertainty in meters. Whether this is
// required depends on the regulatory domain.
HeightUncertainty float64 `json:"heightUncertainty,omitempty"`
// ForceSendFields is a list of field names (e.g. "Height") 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:"-"`
}
func (s *AntennaCharacteristics) MarshalJSON() ([]byte, error) {
type noMethod AntennaCharacteristics
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DatabaseSpec: This message contains the name and URI of a database.
type DatabaseSpec struct {
// Name: The display name for a database.
Name string `json:"name,omitempty"`
// Uri: The corresponding URI of the database.
Uri string `json:"uri,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") 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:"-"`
}
func (s *DatabaseSpec) MarshalJSON() ([]byte, error) {
type noMethod DatabaseSpec
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DbUpdateSpec: This message is provided by the database to notify
// devices of an upcoming change to the database URI.
type DbUpdateSpec struct {
// Databases: A required list of one or more databases. A device should
// update its preconfigured list of databases to replace (only) the
// database that provided the response with the specified entries.
Databases []*DatabaseSpec `json:"databases,omitempty"`
// ForceSendFields is a list of field names (e.g. "Databases") 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:"-"`
}
func (s *DbUpdateSpec) MarshalJSON() ([]byte, error) {
type noMethod DbUpdateSpec
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DeviceCapabilities: Device capabilities provide additional
// information that may be used by a device to provide additional
// information to the database that may help it to determine available
// spectrum. If the database does not support device capabilities it
// will ignore the parameter altogether.
type DeviceCapabilities struct {
// FrequencyRanges: An optional list of frequency ranges supported by
// the device. Each element must contain start and stop frequencies in
// which the device can operate. Channel identifiers are optional. When
// specified, the database should not return available spectrum that
// falls outside these ranges or channel IDs.
FrequencyRanges []*FrequencyRange `json:"frequencyRanges,omitempty"`
// ForceSendFields is a list of field names (e.g. "FrequencyRanges") 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:"-"`
}
func (s *DeviceCapabilities) MarshalJSON() ([]byte, error) {
type noMethod DeviceCapabilities
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DeviceDescriptor: The device descriptor contains parameters that
// identify the specific device, such as its manufacturer serial number,
// regulatory-specific identifier (e.g., FCC ID), and any other device
// characteristics required by regulatory domains.
type DeviceDescriptor struct {
// EtsiEnDeviceCategory: Specifies the ETSI white space device category.
// Valid values are the strings master and slave. This field is
// case-insensitive. Consult the ETSI documentation for details about
// the device types.
EtsiEnDeviceCategory string `json:"etsiEnDeviceCategory,omitempty"`
// EtsiEnDeviceEmissionsClass: Specifies the ETSI white space device
// emissions class. The values are represented by numeric strings, such
// as 1, 2, etc. Consult the ETSI documentation for details about the
// device types.
EtsiEnDeviceEmissionsClass string `json:"etsiEnDeviceEmissionsClass,omitempty"`
// EtsiEnDeviceType: Specifies the ETSI white space device type. Valid
// values are single-letter strings, such as A, B, etc. Consult the ETSI
// documentation for details about the device types.
EtsiEnDeviceType string `json:"etsiEnDeviceType,omitempty"`
// EtsiEnTechnologyId: Specifies the ETSI white space device technology
// identifier. The string value must not exceed 64 characters in length.
// Consult the ETSI documentation for details about the device types.
EtsiEnTechnologyId string `json:"etsiEnTechnologyId,omitempty"`
// FccId: Specifies the device's FCC certification identifier. The value
// is an identifier string whose length should not exceed 32 characters.
// Note that, in practice, a valid FCC ID may be limited to 19
// characters.
FccId string `json:"fccId,omitempty"`
// FccTvbdDeviceType: Specifies the TV Band White Space device type, as
// defined by the FCC. Valid values are FIXED, MODE_1, MODE_2.
FccTvbdDeviceType string `json:"fccTvbdDeviceType,omitempty"`
// ManufacturerId: The manufacturer's ID may be required by the
// regulatory domain. This should represent the name of the device
// manufacturer, should be consistent across all devices from the same
// manufacturer, and should be distinct from that of other
// manufacturers. The string value must not exceed 64 characters in
// length.
ManufacturerId string `json:"manufacturerId,omitempty"`
// ModelId: The device's model ID may be required by the regulatory
// domain. The string value must not exceed 64 characters in length.
ModelId string `json:"modelId,omitempty"`
// RulesetIds: The list of identifiers for rulesets supported by the
// device. A database may require that the device provide this list
// before servicing the device requests. If the database does not
// support any of the rulesets specified in the list, the database may
// refuse to service the device requests. If present, the list must
// contain at least one entry.
//
// For information about the valid requests, see section 9.2 of the PAWS
// specification. Currently, FccTvBandWhiteSpace-2010 is the only
// supported ruleset.
RulesetIds []string `json:"rulesetIds,omitempty"`
// SerialNumber: The manufacturer's device serial number; required by
// the applicable regulatory domain. The length of the value must not
// exceed 64 characters.
SerialNumber string `json:"serialNumber,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "EtsiEnDeviceCategory") 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:"-"`
}
func (s *DeviceDescriptor) MarshalJSON() ([]byte, error) {
type noMethod DeviceDescriptor
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DeviceOwner: This parameter contains device-owner information
// required as part of device registration. The regulatory domains may
// require additional parameters.
//
// All contact information must be expressed using the structure defined
// by the vCard format specification. Only the contact fields of vCard
// are supported:
// - fn: Full name of an individual
// - org: Name of the organization
// - adr: Address fields
// - tel: Telephone numbers
// - email: Email addresses
//
// Note that the vCard specification defines maximum lengths for each
// field.
type DeviceOwner struct {
// Operator: The vCard contact information for the device operator is
// optional, but may be required by specific regulatory domains.
Operator *Vcard `json:"operator,omitempty"`
// Owner: The vCard contact information for the individual or business
// that owns the device is required.
Owner *Vcard `json:"owner,omitempty"`
// ForceSendFields is a list of field names (e.g. "Operator") 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:"-"`
}
func (s *DeviceOwner) MarshalJSON() ([]byte, error) {
type noMethod DeviceOwner
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// DeviceValidity: The device validity element describes whether a
// particular device is valid to operate in the regulatory domain.
type DeviceValidity struct {
// DeviceDesc: The descriptor of the device for which the validity check
// was requested. It will always be present.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// IsValid: The validity status: true if the device is valid for
// operation, false otherwise. It will always be present.
IsValid bool `json:"isValid,omitempty"`
// Reason: If the device identifier is not valid, the database may
// include a reason. The reason may be in any language. The length of
// the value should not exceed 128 characters.
Reason string `json:"reason,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceDesc") 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:"-"`
}
func (s *DeviceValidity) MarshalJSON() ([]byte, error) {
type noMethod DeviceValidity
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// EventTime: The start and stop times of an event. This is used to
// indicate the time period for which a spectrum profile is valid.
//
// Both times are expressed using the format, YYYY-MM-DDThh:mm:ssZ, as
// defined in RFC3339. The times must be expressed using UTC.
type EventTime struct {
// StartTime: The inclusive start of the event. It will be present.
StartTime string `json:"startTime,omitempty"`
// StopTime: The exclusive end of the event. It will be present.
StopTime string `json:"stopTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "StartTime") 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:"-"`
}
func (s *EventTime) MarshalJSON() ([]byte, error) {
type noMethod EventTime
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// FrequencyRange: A specific range of frequencies together with the
// associated maximum power level and channel identifier.
type FrequencyRange struct {
// ChannelId: The database may include a channel identifier, when
// applicable. When it is included, the device should treat it as
// informative. The length of the identifier should not exceed 16
// characters.
ChannelId string `json:"channelId,omitempty"`
// MaxPowerDBm: The maximum total power level (EIRP)—computed over the
// corresponding operating bandwidth—that is permitted within the
// frequency range. Depending on the context in which the
// frequency-range element appears, this value may be required. For
// example, it is required in the available-spectrum response,
// available-spectrum-batch response, and spectrum-use notification
// message, but it should not be present (it is not applicable) when the
// frequency range appears inside a device-capabilities message.
MaxPowerDBm float64 `json:"maxPowerDBm,omitempty"`
// StartHz: The required inclusive start of the frequency range (in
// Hertz).
StartHz float64 `json:"startHz,omitempty"`
// StopHz: The required exclusive end of the frequency range (in Hertz).
StopHz float64 `json:"stopHz,omitempty"`
// ForceSendFields is a list of field names (e.g. "ChannelId") 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:"-"`
}
func (s *FrequencyRange) MarshalJSON() ([]byte, error) {
type noMethod FrequencyRange
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// GeoLocation: This parameter is used to specify the geolocation of the
// device.
type GeoLocation struct {
// Confidence: The location confidence level, as an integer percentage,
// may be required, depending on the regulatory domain. When the
// parameter is optional and not provided, its value is assumed to be
// 95. Valid values range from 0 to 99, since, in practice, 100-percent
// confidence is not achievable. The confidence value is meaningful only
// when geolocation refers to a point with uncertainty.
Confidence int64 `json:"confidence,omitempty"`
// Point: If present, indicates that the geolocation represents a point.
// Paradoxically, a point is parameterized using an ellipse, where the
// center represents the location of the point and the distances along
// the major and minor axes represent the uncertainty. The uncertainty
// values may be required, depending on the regulatory domain.
Point *GeoLocationEllipse `json:"point,omitempty"`
// Region: If present, indicates that the geolocation represents a
// region. Database support for regions is optional.
Region *GeoLocationPolygon `json:"region,omitempty"`
// ForceSendFields is a list of field names (e.g. "Confidence") 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:"-"`
}
func (s *GeoLocation) MarshalJSON() ([]byte, error) {
type noMethod GeoLocation
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// GeoLocationEllipse: A "point" with uncertainty is represented using
// the Ellipse shape.
type GeoLocationEllipse struct {
// Center: A required geo-spatial point representing the center of the
// ellipse.
Center *GeoLocationPoint `json:"center,omitempty"`
// Orientation: A floating-point number that expresses the orientation
// of the ellipse, representing the rotation, in degrees, of the
// semi-major axis from North towards the East. For example, when the
// uncertainty is greatest along the North-South direction, orientation
// is 0 degrees; conversely, if the uncertainty is greatest along the
// East-West direction, orientation is 90 degrees. When orientation is
// not present, the orientation is assumed to be 0.
Orientation float64 `json:"orientation,omitempty"`
// SemiMajorAxis: A floating-point number that expresses the location
// uncertainty along the major axis of the ellipse. May be required by
// the regulatory domain. When the uncertainty is optional, the default
// value is 0.
SemiMajorAxis float64 `json:"semiMajorAxis,omitempty"`
// SemiMinorAxis: A floating-point number that expresses the location
// uncertainty along the minor axis of the ellipse. May be required by
// the regulatory domain. When the uncertainty is optional, the default
// value is 0.
SemiMinorAxis float64 `json:"semiMinorAxis,omitempty"`
// ForceSendFields is a list of field names (e.g. "Center") 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:"-"`
}
func (s *GeoLocationEllipse) MarshalJSON() ([]byte, error) {
type noMethod GeoLocationEllipse
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// GeoLocationPoint: A single geolocation on the globe.
type GeoLocationPoint struct {
// Latitude: A required floating-point number that expresses the
// latitude in degrees using the WGS84 datum. For details on this
// encoding, see the National Imagery and Mapping Agency's Technical
// Report TR8350.2.
Latitude float64 `json:"latitude,omitempty"`
// Longitude: A required floating-point number that expresses the
// longitude in degrees using the WGS84 datum. For details on this
// encoding, see the National Imagery and Mapping Agency's Technical
// Report TR8350.2.
Longitude float64 `json:"longitude,omitempty"`
// ForceSendFields is a list of field names (e.g. "Latitude") 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:"-"`
}
func (s *GeoLocationPoint) MarshalJSON() ([]byte, error) {
type noMethod GeoLocationPoint
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// GeoLocationPolygon: A region is represented using the polygonal
// shape.
type GeoLocationPolygon struct {
// Exterior: When the geolocation describes a region, the exterior field
// refers to a list of latitude/longitude points that represent the
// vertices of a polygon. The first and last points must be the same.
// Thus, a minimum of four points is required. The following polygon
// restrictions from RFC5491 apply:
// - A connecting line shall not cross another connecting line of the
// same polygon.
// - The vertices must be defined in a counterclockwise order.
// - The edges of a polygon are defined by the shortest path between two
// points in space (not a geodesic curve). Consequently, the length
// between two adjacent vertices should be restricted to a maximum of
// 130 km.
// - All vertices are assumed to be at the same altitude.
// - Polygon shapes should be restricted to a maximum of 15 vertices (16
// points that include the repeated vertex).
Exterior []*GeoLocationPoint `json:"exterior,omitempty"`
// ForceSendFields is a list of field names (e.g. "Exterior") 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:"-"`
}
func (s *GeoLocationPolygon) MarshalJSON() ([]byte, error) {
type noMethod GeoLocationPolygon
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// GeoSpectrumSchedule: The schedule of spectrum profiles available at a
// particular geolocation.
type GeoSpectrumSchedule struct {
// Location: The geolocation identifies the location at which the
// spectrum schedule applies. It will always be present.
Location *GeoLocation `json:"location,omitempty"`
// SpectrumSchedules: A list of available spectrum profiles and
// associated times. It will always be present, and at least one
// schedule must be included (though it may be empty if there is no
// available spectrum). More than one schedule may be included to
// represent future changes to the available spectrum.
SpectrumSchedules []*SpectrumSchedule `json:"spectrumSchedules,omitempty"`
// ForceSendFields is a list of field names (e.g. "Location") 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:"-"`
}
func (s *GeoSpectrumSchedule) MarshalJSON() ([]byte, error) {
type noMethod GeoSpectrumSchedule
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// PawsGetSpectrumBatchRequest: The request message for a batch
// available spectrum query protocol.
type PawsGetSpectrumBatchRequest struct {
// Antenna: Depending on device type and regulatory domain, antenna
// characteristics may be required.
Antenna *AntennaCharacteristics `json:"antenna,omitempty"`
// Capabilities: The master device may include its device capabilities
// to limit the available-spectrum batch response to the spectrum that
// is compatible with its capabilities. The database should not return
// spectrum that is incompatible with the specified capabilities.
Capabilities *DeviceCapabilities `json:"capabilities,omitempty"`
// DeviceDesc: When the available spectrum request is made on behalf of
// a specific device (a master or slave device), device descriptor
// information for the device on whose behalf the request is made is
// required (in such cases, the requestType parameter must be empty).
// When a requestType value is specified, device descriptor information
// may be optional or required according to the rules of the applicable
// regulatory domain.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// Locations: A geolocation list is required. This allows a device to
// specify its current location plus additional anticipated locations
// when allowed by the regulatory domain. At least one location must be
// included. Geolocation must be given as the location of the radiation
// center of the device's antenna. If a location specifies a region,
// rather than a point, the database may return an UNIMPLEMENTED error
// if it does not support query by region.
//
// There is no upper limit on the number of locations included in a
// available spectrum batch request, but the database may restrict the
// number of locations it supports by returning a response with fewer
// locations than specified in the batch request. Note that geolocations
// must be those of the master device (a device with geolocation
// capability that makes an available spectrum batch request), whether
// the master device is making the request on its own behalf or on
// behalf of a slave device (one without geolocation capability).
Locations []*GeoLocation `json:"locations,omitempty"`
// MasterDeviceDesc: When an available spectrum batch request is made by
// the master device (a device with geolocation capability) on behalf of
// a slave device (a device without geolocation capability), the rules
// of the applicable regulatory domain may require the master device to
// provide its own device descriptor information (in addition to device
// descriptor information for the slave device in a separate parameter).
MasterDeviceDesc *DeviceDescriptor `json:"masterDeviceDesc,omitempty"`
// Owner: Depending on device type and regulatory domain, device owner
// information may be included in an available spectrum batch request.
// This allows the device to register and get spectrum-availability
// information in a single request.
Owner *DeviceOwner `json:"owner,omitempty"`
// RequestType: The request type parameter is an optional parameter that
// can be used to modify an available spectrum batch request, but its
// use depends on applicable regulatory rules. For example, It may be
// used to request generic slave device parameters without having to
// specify the device descriptor for a specific device. When the
// requestType parameter is missing, the request is for a specific
// device (master or slave), and the device descriptor parameter for the
// device on whose behalf the batch request is made is required.
RequestType string `json:"requestType,omitempty"`
// Type: The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ,
// ...).
//
// Required field.
Type string `json:"type,omitempty"`
// Version: The PAWS version. Must be exactly 1.0.
//
// Required field.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "Antenna") 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:"-"`
}
func (s *PawsGetSpectrumBatchRequest) MarshalJSON() ([]byte, error) {
type noMethod PawsGetSpectrumBatchRequest
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// PawsGetSpectrumBatchResponse: The response message for the batch
// available spectrum query contains a schedule of available spectrum
// for the device at multiple locations.
type PawsGetSpectrumBatchResponse struct {
// DatabaseChange: A database may include the databaseChange parameter
// to notify a device of a change to its database URI, providing one or
// more alternate database URIs. The device should use this information
// to update its list of pre-configured databases by (only) replacing
// its entry for the responding database with the list of alternate
// URIs.
DatabaseChange *DbUpdateSpec `json:"databaseChange,omitempty"`
// DeviceDesc: The database must return in its available spectrum
// response the device descriptor information it received in the master
// device's available spectrum batch request.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// GeoSpectrumSchedules: The available spectrum batch response must
// contain a geo-spectrum schedule list, The list may be empty if
// spectrum is not available. The database may return more than one
// geo-spectrum schedule to represent future changes to the available
// spectrum. How far in advance a schedule may be provided depends upon
// the applicable regulatory domain. The database may return available
// spectrum for fewer geolocations than requested. The device must not
// make assumptions about the order of the entries in the list, and must
// use the geolocation value in each geo-spectrum schedule entry to
// match available spectrum to a location.
GeoSpectrumSchedules []*GeoSpectrumSchedule `json:"geoSpectrumSchedules,omitempty"`
// Kind: Identifies what kind of resource this is. Value: the fixed
// string "spectrum#pawsGetSpectrumBatchResponse".
Kind string `json:"kind,omitempty"`
// MaxContiguousBwHz: The database may return a constraint on the
// allowed maximum contiguous bandwidth (in Hertz). A regulatory domain
// may require the database to return this parameter. When this
// parameter is present in the response, the device must apply this
// constraint to its spectrum-selection logic to ensure that no single
// block of spectrum has bandwidth that exceeds this value.
MaxContiguousBwHz float64 `json:"maxContiguousBwHz,omitempty"`
// MaxTotalBwHz: The database may return a constraint on the allowed
// maximum total bandwidth (in Hertz), which does not need to be
// contiguous. A regulatory domain may require the database to return
// this parameter. When this parameter is present in the available
// spectrum batch response, the device must apply this constraint to its
// spectrum-selection logic to ensure that total bandwidth does not
// exceed this value.
MaxTotalBwHz float64 `json:"maxTotalBwHz,omitempty"`
// NeedsSpectrumReport: For regulatory domains that require a
// spectrum-usage report from devices, the database must return true for
// this parameter if the geo-spectrum schedules list is not empty;
// otherwise, the database should either return false or omit this
// parameter. If this parameter is present and its value is true, the
// device must send a spectrum use notify message to the database;
// otherwise, the device should not send the notification.
NeedsSpectrumReport bool `json:"needsSpectrumReport,omitempty"`
// RulesetInfo: The database should return ruleset information, which
// identifies the applicable regulatory authority and ruleset for the
// available spectrum batch response. If included, the device must use
// the corresponding ruleset to interpret the response. Values provided
// in the returned ruleset information, such as maxLocationChange, take
// precedence over any conflicting values provided in the ruleset
// information returned in a prior initialization response sent by the
// database to the device.
RulesetInfo *RulesetInfo `json:"rulesetInfo,omitempty"`
// Timestamp: The database includes a timestamp of the form,
// YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339), in its
// available spectrum batch response. The timestamp should be used by
// the device as a reference for the start and stop times specified in
// the response spectrum schedules.
Timestamp string `json:"timestamp,omitempty"`
// Type: The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ,
// ...).
//
// Required field.
Type string `json:"type,omitempty"`
// Version: The PAWS version. Must be exactly 1.0.
//
// Required field.
Version string `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DatabaseChange") 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:"-"`
}
func (s *PawsGetSpectrumBatchResponse) MarshalJSON() ([]byte, error) {
type noMethod PawsGetSpectrumBatchResponse
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// PawsGetSpectrumRequest: The request message for the available
// spectrum query protocol which must include the device's geolocation.
type PawsGetSpectrumRequest struct {
// Antenna: Depending on device type and regulatory domain, the
// characteristics of the antenna may be required.
Antenna *AntennaCharacteristics `json:"antenna,omitempty"`
// Capabilities: The master device may include its device capabilities
// to limit the available-spectrum response to the spectrum that is
// compatible with its capabilities. The database should not return
// spectrum that is incompatible with the specified capabilities.
Capabilities *DeviceCapabilities `json:"capabilities,omitempty"`
// DeviceDesc: When the available spectrum request is made on behalf of
// a specific device (a master or slave device), device descriptor
// information for that device is required (in such cases, the
// requestType parameter must be empty). When a requestType value is
// specified, device descriptor information may be optional or required
// according to the rules of the applicable regulatory domain.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// Location: The geolocation of the master device (a device with
// geolocation capability that makes an available spectrum request) is
// required whether the master device is making the request on its own
// behalf or on behalf of a slave device (one without geolocation
// capability). The location must be the location of the radiation
// center of the master device's antenna. To support mobile devices, a
// regulatory domain may allow the anticipated position of the master
// device to be given instead. If the location specifies a region,
// rather than a point, the database may return an UNIMPLEMENTED error
// code if it does not support query by region.
Location *GeoLocation `json:"location,omitempty"`
// MasterDeviceDesc: When an available spectrum request is made by the
// master device (a device with geolocation capability) on behalf of a
// slave device (a device without geolocation capability), the rules of
// the applicable regulatory domain may require the master device to
// provide its own device descriptor information (in addition to device
// descriptor information for the slave device, which is provided in a
// separate parameter).
MasterDeviceDesc *DeviceDescriptor `json:"masterDeviceDesc,omitempty"`
// Owner: Depending on device type and regulatory domain, device owner
// information may be included in an available spectrum request. This
// allows the device to register and get spectrum-availability
// information in a single request.
Owner *DeviceOwner `json:"owner,omitempty"`
// RequestType: The request type parameter is an optional parameter that
// can be used to modify an available spectrum request, but its use
// depends on applicable regulatory rules. It may be used, for example,
// to request generic slave device parameters without having to specify
// the device descriptor for a specific device. When the requestType
// parameter is missing, the request is for a specific device (master or
// slave), and the deviceDesc parameter for the device on whose behalf
// the request is made is required.
RequestType string `json:"requestType,omitempty"`
// Type: The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ,
// ...).
//
// Required field.
Type string `json:"type,omitempty"`
// Version: The PAWS version. Must be exactly 1.0.
//
// Required field.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "Antenna") 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:"-"`
}
func (s *PawsGetSpectrumRequest) MarshalJSON() ([]byte, error) {
type noMethod PawsGetSpectrumRequest
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// PawsGetSpectrumResponse: The response message for the available
// spectrum query which contains a schedule of available spectrum for
// the device.
type PawsGetSpectrumResponse struct {
// DatabaseChange: A database may include the databaseChange parameter
// to notify a device of a change to its database URI, providing one or
// more alternate database URIs. The device should use this information
// to update its list of pre-configured databases by (only) replacing
// its entry for the responding database with the list of alternate
// URIs.
DatabaseChange *DbUpdateSpec `json:"databaseChange,omitempty"`
// DeviceDesc: The database must return, in its available spectrum
// response, the device descriptor information it received in the master
// device's available spectrum request.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// Kind: Identifies what kind of resource this is. Value: the fixed
// string "spectrum#pawsGetSpectrumResponse".
Kind string `json:"kind,omitempty"`
// MaxContiguousBwHz: The database may return a constraint on the
// allowed maximum contiguous bandwidth (in Hertz). A regulatory domain
// may require the database to return this parameter. When this
// parameter is present in the response, the device must apply this
// constraint to its spectrum-selection logic to ensure that no single
// block of spectrum has bandwidth that exceeds this value.
MaxContiguousBwHz float64 `json:"maxContiguousBwHz,omitempty"`
// MaxTotalBwHz: The database may return a constraint on the allowed
// maximum total bandwidth (in Hertz), which need not be contiguous. A
// regulatory domain may require the database to return this parameter.
// When this parameter is present in the available spectrum response,
// the device must apply this constraint to its spectrum-selection logic
// to ensure that total bandwidth does not exceed this value.
MaxTotalBwHz float64 `json:"maxTotalBwHz,omitempty"`
// NeedsSpectrumReport: For regulatory domains that require a
// spectrum-usage report from devices, the database must return true for
// this parameter if the spectrum schedule list is not empty; otherwise,
// the database will either return false or omit this parameter. If this
// parameter is present and its value is true, the device must send a
// spectrum use notify message to the database; otherwise, the device
// must not send the notification.
NeedsSpectrumReport bool `json:"needsSpectrumReport,omitempty"`
// RulesetInfo: The database should return ruleset information, which
// identifies the applicable regulatory authority and ruleset for the
// available spectrum response. If included, the device must use the
// corresponding ruleset to interpret the response. Values provided in
// the returned ruleset information, such as maxLocationChange, take
// precedence over any conflicting values provided in the ruleset
// information returned in a prior initialization response sent by the
// database to the device.
RulesetInfo *RulesetInfo `json:"rulesetInfo,omitempty"`
// SpectrumSchedules: The available spectrum response must contain a
// spectrum schedule list. The list may be empty if spectrum is not
// available. The database may return more than one spectrum schedule to
// represent future changes to the available spectrum. How far in
// advance a schedule may be provided depends on the applicable
// regulatory domain.
SpectrumSchedules []*SpectrumSchedule `json:"spectrumSchedules,omitempty"`
// Timestamp: The database includes a timestamp of the form
// YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339) in its
// available spectrum response. The timestamp should be used by the
// device as a reference for the start and stop times specified in the
// response spectrum schedules.
Timestamp string `json:"timestamp,omitempty"`
// Type: The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ,
// ...).
//
// Required field.
Type string `json:"type,omitempty"`
// Version: The PAWS version. Must be exactly 1.0.
//
// Required field.
Version string `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DatabaseChange") 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:"-"`
}
func (s *PawsGetSpectrumResponse) MarshalJSON() ([]byte, error) {
type noMethod PawsGetSpectrumResponse
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}
// PawsInitRequest: The initialization request message allows the master
// device to initiate exchange of capabilities with the database.
type PawsInitRequest struct {
// DeviceDesc: The DeviceDescriptor parameter is required. If the
// database does not support the device or any of the rulesets specified
// in the device descriptor, it must return an UNSUPPORTED error code in
// the error response.
DeviceDesc *DeviceDescriptor `json:"deviceDesc,omitempty"`
// Location: A device's geolocation is required.
Location *GeoLocation `json:"location,omitempty"`
// Type: The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ,
// ...).
//
// Required field.
Type string `json:"type,omitempty"`
// Version: The PAWS version. Must be exactly 1.0.
//
// Required field.
Version string `json:"version,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceDesc") 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:"-"`
}
func (s *PawsInitRequest) MarshalJSON() ([]byte, error) {
type noMethod PawsInitRequest
raw := noMethod(*s)
return internal.MarshalJSON(raw, s.ForceSendFields)
}