forked from googleapis/google-api-go-client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
servicecontrol-gen.go
1133 lines (1016 loc) · 40.4 KB
/
servicecontrol-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 servicecontrol provides access to the Google Service Control API.
//
// See https://cloud.google.com/service-control/
//
// Usage example:
//
// import "google.golang.org/api/servicecontrol/v1"
// ...
// servicecontrolService, err := servicecontrol.New(oauthHttpClient)
package servicecontrol // import "google.golang.org/api/servicecontrol/v1"
import (
"bytes"
"encoding/json"
"errors"
"fmt"
context "golang.org/x/net/context"
ctxhttp "golang.org/x/net/context/ctxhttp"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
"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 _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = ctxhttp.Do
const apiId = "servicecontrol:v1"
const apiName = "servicecontrol"
const apiVersion = "v1"
const basePath = "https://servicecontrol.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// Manage your Google Service Control data
ServicecontrolScope = "https://www.googleapis.com/auth/servicecontrol"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Services = NewServicesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Services *ServicesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewServicesService(s *Service) *ServicesService {
rs := &ServicesService{s: s}
return rs
}
type ServicesService struct {
s *Service
}
// CheckError: Defines the errors to be returned
// in
// google.api.servicecontrol.v1.CheckResponse.check_errors.
type CheckError struct {
// Code: The error code.
//
// Possible values:
// "ERROR_CODE_UNSPECIFIED" - This is never used in `CheckResponse`.
// "NOT_FOUND" - The consumer's project id was not found.
// Same as google.rpc.Code.NOT_FOUND.
// "PERMISSION_DENIED" - The consumer doesn't have access to the
// specified resource.
// Same as google.rpc.Code.PERMISSION_DENIED.
// "RESOURCE_EXHAUSTED" - Quota check failed. Same as
// google.rpc.Code.RESOURCE_EXHAUSTED.
// "SERVICE_NOT_ACTIVATED" - The consumer hasn't activated the
// service.
// "BILLING_DISABLED" - The consumer cannot access the service because
// billing is disabled.
// "PROJECT_DELETED" - The consumer's project has been marked as
// deleted (soft deletion).
// "PROJECT_INVALID" - The consumer's project number or id does not
// represent a valid project.
// "IP_ADDRESS_BLOCKED" - The IP address of the consumer is invalid
// for the specific consumer
// project.
// "REFERER_BLOCKED" - The referer address of the consumer request is
// invalid for the specific
// consumer project.
// "CLIENT_APP_BLOCKED" - The client application of the consumer
// request is invalid for the
// specific consumer project.
// "API_KEY_INVALID" - The consumer's API key is invalid.
// "API_KEY_EXPIRED" - The consumer's API Key has expired.
// "API_KEY_NOT_FOUND" - The consumer's API Key was not found in
// config record.
// "NAMESPACE_LOOKUP_UNAVAILABLE" - The backend server for looking up
// project id/number is unavailable.
// "SERVICE_STATUS_UNAVAILABLE" - The backend server for checking
// service status is unavailable.
// "BILLING_STATUS_UNAVAILABLE" - The backend server for checking
// billing status is unavailable.
Code string `json:"code,omitempty"`
// Detail: Free-form text providing details on the error cause of the
// error.
Detail string `json:"detail,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") 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 *CheckError) MarshalJSON() ([]byte, error) {
type noMethod CheckError
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// CheckRequest: Request message for the Check method.
type CheckRequest struct {
// Operation: The operation to be checked.
Operation *Operation `json:"operation,omitempty"`
// ForceSendFields is a list of field names (e.g. "Operation") 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 *CheckRequest) MarshalJSON() ([]byte, error) {
type noMethod CheckRequest
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// CheckResponse: Response message for the Check method.
type CheckResponse struct {
// CheckErrors: Indicate the decision of the check.
//
// If no check errors are present, the service should process the
// operation.
// Otherwise the service should use the list of errors to determine
// the
// appropriate action.
CheckErrors []*CheckError `json:"checkErrors,omitempty"`
// OperationId: The same operation_id value used in the
// CheckRequest.
// Used for logging and diagnostics purposes.
OperationId string `json:"operationId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CheckErrors") 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 *CheckResponse) MarshalJSON() ([]byte, error) {
type noMethod CheckResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Distribution: Distribution represents a frequency distribution of
// double-valued sample
// points. It contains the size of the population of sample points
// plus
// additional optional information:
//
// - the arithmetic mean of the samples
// - the minimum and maximum of the samples
// - the sum-squared-deviation of the samples, used to compute
// variance
// - a histogram of the values of the sample points
type Distribution struct {
// BucketCounts: The number of samples in each histogram bucket.
// `bucket_counts` are
// optional. If present, they must sum to the `count` value.
//
// The buckets are defined below in `bucket_option`. There are N
// buckets.
// `bucket_counts[0]` is the number of samples in the underflow
// bucket.
// `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of
// samples
// in each of the finite buckets. And `bucket_counts[N] is the number
// of samples in the overflow bucket. See the comments of
// `bucket_option`
// below for more details.
//
// Any suffix of trailing zeros may be omitted.
BucketCounts googleapi.Int64s `json:"bucketCounts,omitempty"`
// Count: The total number of samples in the distribution. Must be >= 0.
Count int64 `json:"count,omitempty,string"`
// ExplicitBuckets: Buckets with arbitrary user-provided width.
ExplicitBuckets *ExplicitBuckets `json:"explicitBuckets,omitempty"`
// ExponentialBuckets: Buckets with exponentially growing width.
ExponentialBuckets *ExponentialBuckets `json:"exponentialBuckets,omitempty"`
// LinearBuckets: Buckets with constant width.
LinearBuckets *LinearBuckets `json:"linearBuckets,omitempty"`
// Maximum: The maximum of the population of values. Ignored if `count`
// is zero.
Maximum float64 `json:"maximum,omitempty"`
// Mean: The arithmetic mean of the samples in the distribution. If
// `count` is
// zero then this field must be zero.
Mean float64 `json:"mean,omitempty"`
// Minimum: The minimum of the population of values. Ignored if `count`
// is zero.
Minimum float64 `json:"minimum,omitempty"`
// SumOfSquaredDeviation: The sum of squared deviations from the mean:
// Sum[i=1..count]((x_i - mean)^2)
// where each x_i is a sample values. If `count` is zero then this
// field
// must be zero, otherwise validation of the request fails.
SumOfSquaredDeviation float64 `json:"sumOfSquaredDeviation,omitempty"`
// ForceSendFields is a list of field names (e.g. "BucketCounts") 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 *Distribution) MarshalJSON() ([]byte, error) {
type noMethod Distribution
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ExplicitBuckets: Describing buckets with arbitrary user-provided
// width.
type ExplicitBuckets struct {
// Bounds: 'bound' is a list of strictly increasing boundaries
// between
// buckets. Note that a list of length N-1 defines N buckets because
// of fenceposting. See comments on `bucket_options` for details.
//
// The i'th finite bucket covers the interval
// [bound[i-1], bound[i])
// where i ranges from 1 to bound_size() - 1. Note that there are
// no
// finite buckets at all if 'bound' only contains a single element;
// in
// that special case the single bound defines the boundary between
// the
// underflow and overflow buckets.
//
// bucket number lower bound upper bound
// i == 0 (underflow) -inf bound[i]
// 0 < i < bound_size() bound[i-1] bound[i]
// i == bound_size() (overflow) bound[i-1] +inf
Bounds []float64 `json:"bounds,omitempty"`
// ForceSendFields is a list of field names (e.g. "Bounds") 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 *ExplicitBuckets) MarshalJSON() ([]byte, error) {
type noMethod ExplicitBuckets
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ExponentialBuckets: Describing buckets with exponentially growing
// width.
type ExponentialBuckets struct {
// GrowthFactor: The i'th exponential bucket covers the interval
// [scale * growth_factor^(i-1), scale * growth_factor^i)
// where i ranges from 1 to num_finite_buckets inclusive.
// Must be larger than 1.0.
GrowthFactor float64 `json:"growthFactor,omitempty"`
// NumFiniteBuckets: The number of finite buckets. With the underflow
// and overflow buckets,
// the total number of buckets is `num_finite_buckets` + 2.
// See comments on `bucket_options` for details.
NumFiniteBuckets int64 `json:"numFiniteBuckets,omitempty"`
// Scale: The i'th exponential bucket covers the interval
// [scale * growth_factor^(i-1), scale * growth_factor^i)
// where i ranges from 1 to num_finite_buckets inclusive.
// Must be > 0.
Scale float64 `json:"scale,omitempty"`
// ForceSendFields is a list of field names (e.g. "GrowthFactor") 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 *ExponentialBuckets) MarshalJSON() ([]byte, error) {
type noMethod ExponentialBuckets
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// LinearBuckets: Describing buckets with constant width.
type LinearBuckets struct {
// NumFiniteBuckets: The number of finite buckets. With the underflow
// and overflow buckets,
// the total number of buckets is `num_finite_buckets` + 2.
// See comments on `bucket_options` for details.
NumFiniteBuckets int64 `json:"numFiniteBuckets,omitempty"`
// Offset: The i'th linear bucket covers the interval
// [offset + (i-1) * width, offset + i * width)
// where i ranges from 1 to num_finite_buckets, inclusive.
Offset float64 `json:"offset,omitempty"`
// Width: The i'th linear bucket covers the interval
// [offset + (i-1) * width, offset + i * width)
// where i ranges from 1 to num_finite_buckets, inclusive.
// Must be strictly positive.
Width float64 `json:"width,omitempty"`
// ForceSendFields is a list of field names (e.g. "NumFiniteBuckets") 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 *LinearBuckets) MarshalJSON() ([]byte, error) {
type noMethod LinearBuckets
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// LogEntry: An individual log entry.
type LogEntry struct {
// InsertId: A unique ID for the log entry used for deduplication. If
// omitted,
// the implementation will generate one based on operation_id.
InsertId string `json:"insertId,omitempty"`
// Labels: A set of user-defined (key, value) data that provides
// additional
// information about the log entry.
Labels map[string]string `json:"labels,omitempty"`
// Name: Required. The log to which this log entry belongs. Examples:
// "syslog",
// "book_log".
Name string `json:"name,omitempty"`
// ProtoPayload: The log entry payload, represented as a protocol buffer
// that is
// expressed as a JSON object. You can only pass `protoPayload`
// values that belong to a set of approved types.
ProtoPayload LogEntryProtoPayload `json:"protoPayload,omitempty"`
// Severity: The severity of the log entry. The default value
// is
// `LogSeverity.DEFAULT`.
//
// Possible values:
// "DEFAULT" - The log entry has no assigned severity level.
// "DEBUG" - Debug or trace information.
// "INFO" - Routine information, such as ongoing status or
// performance.
// "NOTICE" - Normal but significant events, such as start up, shut
// down, or
// configuration.
// "WARNING" - Warning events might cause problems.
// "ERROR" - Error events are likely to cause problems.
// "CRITICAL" - Critical events cause more severe problems or brief
// outages.
// "ALERT" - A person must take an action immediately.
// "EMERGENCY" - One or more systems are unusable.
Severity string `json:"severity,omitempty"`
// StructPayload: The log entry payload, represented as a structure
// that
// is expressed as a JSON object.
StructPayload LogEntryStructPayload `json:"structPayload,omitempty"`
// TextPayload: The log entry payload, represented as a Unicode string
// (UTF-8).
TextPayload string `json:"textPayload,omitempty"`
// Timestamp: The time the event described by the log entry occurred.
// If
// omitted, defaults to operation start time.
Timestamp string `json:"timestamp,omitempty"`
// ForceSendFields is a list of field names (e.g. "InsertId") 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 *LogEntry) MarshalJSON() ([]byte, error) {
type noMethod LogEntry
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
type LogEntryProtoPayload interface{}
type LogEntryStructPayload interface{}
// MetricValue: Represents a single metric value.
type MetricValue struct {
// BoolValue: A boolean value.
BoolValue bool `json:"boolValue,omitempty"`
// DistributionValue: A distribution value.
DistributionValue *Distribution `json:"distributionValue,omitempty"`
// DoubleValue: A double precision floating point value.
DoubleValue float64 `json:"doubleValue,omitempty"`
// EndTime: The end of the time period over which this metric value's
// measurement
// applies.
EndTime string `json:"endTime,omitempty"`
// Int64Value: A signed 64-bit integer value.
Int64Value int64 `json:"int64Value,omitempty,string"`
// Labels: The labels describing the metric value.
// See comments on google.api.servicecontrol.v1.Operation.labels for
// the overriding relationship.
Labels map[string]string `json:"labels,omitempty"`
// StartTime: The start of the time period over which this metric
// value's measurement
// applies. The time period has different semantics for different
// metric
// types (cumulative, delta, and gauge). See the metric
// definition
// documentation in the service configuration for details.
StartTime string `json:"startTime,omitempty"`
// StringValue: A text string value.
StringValue string `json:"stringValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "BoolValue") 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 *MetricValue) MarshalJSON() ([]byte, error) {
type noMethod MetricValue
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// MetricValueSet: Represents a set of metric values in the same
// metric.
// Each metric value in the set should have a unique combination of
// start time,
// end time, and label values.
type MetricValueSet struct {
// MetricName: The metric name defined in the service configuration.
MetricName string `json:"metricName,omitempty"`
// MetricValues: The values in this metric.
MetricValues []*MetricValue `json:"metricValues,omitempty"`
// ForceSendFields is a list of field names (e.g. "MetricName") 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 *MetricValueSet) MarshalJSON() ([]byte, error) {
type noMethod MetricValueSet
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Operation: Represents information regarding an operation.
type Operation struct {
// ConsumerId: Identity of the consumer who is using the service.
// This field should be filled in for the operations initiated by
// a
// consumer, but not for service-initiated operations that are
// not related to a specific consumer.
//
// This can be in one of the following formats:
// project:<project_id>,
// project_number:<project_number>,
// api_key:<api_key>.
ConsumerId string `json:"consumerId,omitempty"`
// EndTime: End time of the operation.
// Required when the operation is used in ServiceController.Report,
// but optional when the operation is used in ServiceController.Check.
EndTime string `json:"endTime,omitempty"`
// Importance: The importance of the data contained in the operation.
//
// Possible values:
// "LOW" - The operation doesn't contain significant monetary value or
// audit
// trail. The API implementation may cache and aggregate the data.
// There is no deduplication based on `operation_id`. The data
// may be lost when rare and unexpected system failures occur.
// "HIGH" - The operation contains significant monetary value or audit
// trail.
// The API implementation doesn't cache and aggregate the
// data.
// Deduplication based on `operation_id` is performed for
// monetary
// values. If the method returns successfully, it's guaranteed that
// the data are persisted in durable storage.
Importance string `json:"importance,omitempty"`
// Labels: Labels describing the operation. Only the following labels
// are allowed:
//
// - Labels describing monitored resources as defined in
// the service configuration.
// - Default labels of metric values. When specified, labels defined in
// the
// metric value override these default.
// - The following labels defined by Google Cloud Platform:
// - `cloud.googleapis.com/location` describing the location where
// the
// operation happened,
// - `servicecontrol.googleapis.com/user_agent` describing the user
// agent
// of the API request,
// - `servicecontrol.googleapis.com/service_agent` describing the
// service
// used to handle the API request (e.g. ESP),
// - `servicecontrol.googleapis.com/platform` describing the
// platform
// where the API is served (e.g. GAE, GCE, GKE).
Labels map[string]string `json:"labels,omitempty"`
// LogEntries: Represents information to be logged.
LogEntries []*LogEntry `json:"logEntries,omitempty"`
// MetricValueSets: Represents information about this operation. Each
// MetricValueSet
// corresponds to a metric defined in the service configuration.
// The data type used in the MetricValueSet must agree with
// the data type specified in the metric definition.
//
// Within a single operation, it is not allowed to have more than
// one
// MetricValue instances that have the same metric names and
// identical
// label value combinations. If a request has such duplicated
// MetricValue
// instances, the entire request is rejected with
// an invalid argument error.
MetricValueSets []*MetricValueSet `json:"metricValueSets,omitempty"`
// OperationId: Identity of the operation. This must be unique within
// the scope of the
// service that generated the operation. If the service calls
// Check() and Report() on the same operation, the two calls should
// carry
// the same id.
//
// UUID version 4 is recommended, though not required.
// In scenarios where an operation is computed from existing
// information
// and an idempotent id is desirable for deduplication purpose, UUID
// version 5
// is recommended. See RFC 4122 for details.
OperationId string `json:"operationId,omitempty"`
// OperationName: Fully qualified name of the operation. Reserved for
// future use.
OperationName string `json:"operationName,omitempty"`
// StartTime: Required. Start time of the operation.
StartTime string `json:"startTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConsumerId") 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 *Operation) MarshalJSON() ([]byte, error) {
type noMethod Operation
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ReportError: Represents the processing error of one `Operation` in
// the request.
type ReportError struct {
// OperationId: The Operation.operation_id value from the request.
OperationId string `json:"operationId,omitempty"`
// Status: Details of the error when processing the `Operation`.
Status *Status `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperationId") 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 *ReportError) MarshalJSON() ([]byte, error) {
type noMethod ReportError
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ReportRequest: Request message for the Report method.
type ReportRequest struct {
// Operations: Operations to be reported.
//
// Typically the service should report one operation per
// request.
// Putting multiple operations into a single request is allowed, but
// should
// be used only when multiple operations are natually available at the
// time
// of the report.
//
// If multiple operations are in a single request, the total request
// size
// should be no larger than 1MB. See ReportResponse.report_errors
// for
// partial failure behavior.
Operations []*Operation `json:"operations,omitempty"`
// ForceSendFields is a list of field names (e.g. "Operations") 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 *ReportRequest) MarshalJSON() ([]byte, error) {
type noMethod ReportRequest
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ReportResponse: Response message for the Report method.
type ReportResponse struct {
// ReportErrors: Partial failures, one for each `Operation` in the
// request that failed
// processing. There are three possible combinations of the RPC
// status:
//
// 1. The combination of a successful RPC status and an empty
// `report_errors`
// list indicates a complete success where all `Operations` in the
// request are processed successfully.
// 2. The combination of a successful RPC status and a non-empty
// `report_errors` list indicates a partial success where some
// `Operations` in the request succeeded. Each
// `Operation` that failed processing has a corresponding item
// in this list.
// 3. A failed RPC status indicates a complete failure where none of
// the
// `Operations` in the request succeeded.
ReportErrors []*ReportError `json:"reportErrors,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ReportErrors") 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 *ReportResponse) MarshalJSON() ([]byte, error) {
type noMethod ReportResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Status: The `Status` type defines a logical error model that is
// suitable for different
// programming environments, including REST APIs and RPC APIs. It is
// used by
// [gRPC](https://github.com/grpc). The error model is designed to
// be:
//
// - Simple to use and understand for most users
// - Flexible enough to meet unexpected needs
//
// # Overview
//
// The `Status` message contains three pieces of data: error code, error
// message,
// and error details. The error code should be an enum value
// of
// google.rpc.Code, but it may accept additional error codes if needed.
// The
// error message should be a developer-facing English message that
// helps
// developers *understand* and *resolve* the error. If a localized
// user-facing
// error message is needed, put the localized message in the error
// details or
// localize it in the client. The optional error details may contain
// arbitrary
// information about the error. There is a predefined set of error
// detail types
// in the package `google.rpc` which can be used for common error
// conditions.
//
// # Language mapping
//
// The `Status` message is the logical representation of the error
// model, but it
// is not necessarily the actual wire format. When the `Status` message
// is
// exposed in different client libraries and different wire protocols,
// it can be
// mapped differently. For example, it will likely be mapped to some
// exceptions
// in Java, but more likely mapped to some error codes in C.
//
// # Other uses
//
// The error model and the `Status` message can be used in a variety
// of
// environments, either with or without APIs, to provide a
// consistent developer experience across different
// environments.
//
// Example uses of this error model include:
//
// - Partial errors. If a service needs to return partial errors to the
// client,
// it may embed the `Status` in the normal response to indicate the
// partial
// errors.
//
// - Workflow errors. A typical workflow has multiple steps. Each step
// may
// have a `Status` message for error reporting purpose.
//
// - Batch operations. If a client uses batch request and batch
// response, the
// `Status` message should be used directly inside batch response,
// one for
// each error sub-response.
//
// - Asynchronous operations. If an API call embeds asynchronous
// operation
// results in its response, the status of those operations should
// be
// represented directly using the `Status` message.
//
// - Logging. If some API errors are stored in logs, the message
// `Status` could
// be used directly after any stripping needed for security/privacy
// reasons.
type Status struct {
// Code: The status code, which should be an enum value of
// google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There will
// be a
// common set of message types for APIs to use.
Details []StatusDetails `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in
// English. Any
// user-facing error message should be localized and sent in
// the
// google.rpc.Status.details field, or localized by the client.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") 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 *Status) MarshalJSON() ([]byte, error) {
type noMethod Status
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
type StatusDetails interface{}
// method id "servicecontrol.services.check":
type ServicesCheckCall struct {
s *Service
serviceName string
checkrequest *CheckRequest
urlParams_ gensupport.URLParams
ctx_ context.Context
}
// Check: Checks an operation with Google Service Control to decide
// whether
// the given operation should proceed. It should be called before
// the
// operation is executed.
//
// This method requires the `servicemanagement.services.check`
// permission
// on the specified service. For more information, see
// [Google Cloud IAM](https://cloud.google.com/iam).
func (r *ServicesService) Check(serviceName string, checkrequest *CheckRequest) *ServicesCheckCall {
c := &ServicesCheckCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.serviceName = serviceName
c.checkrequest = checkrequest
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ServicesCheckCall) Fields(s ...googleapi.Field) *ServicesCheckCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *ServicesCheckCall) Context(ctx context.Context) *ServicesCheckCall {
c.ctx_ = ctx
return c
}
func (c *ServicesCheckCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.checkrequest)
if err != nil {
return nil, err
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/services/{serviceName}:check")
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"serviceName": c.serviceName,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "servicecontrol.services.check" call.
// Exactly one of *CheckResponse or error will be non-nil. Any non-2xx
// status code is an error. Response headers are in either
// *CheckResponse.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 *ServicesCheckCall) Do(opts ...googleapi.CallOption) (*CheckResponse, 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, &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, err
}
ret := &CheckResponse{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := json.NewDecoder(res.Body).Decode(target); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
// "flatPath": "v1/services/{serviceName}:check",
// "httpMethod": "POST",
// "id": "servicecontrol.services.check",
// "parameterOrder": [
// "serviceName"
// ],
// "parameters": {
// "serviceName": {
// "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
// "location": "path",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/services/{serviceName}:check",
// "request": {
// "$ref": "CheckRequest"
// },
// "response": {
// "$ref": "CheckResponse"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/servicecontrol"