Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / servicecontrol_v1.services.html
blob: ca06b23a4f72480c1abad9531eeca91b11f55419 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="servicecontrol_v1.html">Service Control API</a> . <a href="servicecontrol_v1.services.html">services</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#allocateQuota">allocateQuota(serviceName, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Attempts to allocate quota for the specified consumer. It should be called</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#check">check(serviceName, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Checks whether an operation on a service should be allowed to proceed</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#report">report(serviceName, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Reports operation results to Google Service Control, such as logs and</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88 <code class="details" id="allocateQuota">allocateQuota(serviceName, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]89 <pre>Attempts to allocate quota for the specified consumer. It should be called
90before the operation is executed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]91
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92This method requires the `servicemanagement.services.quota`
93permission on the specified service. For more information, see
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94[Cloud IAM](https://cloud.google.com/iam).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]95
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96**NOTE:** The client **must** fail-open on server errors `INTERNAL`,
97`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
98reliability, the server may inject these errors to prohibit any hard
99dependency on the quota functionality.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]100
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]102 serviceName: string, Name of the service as specified in the service configuration. For example,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103`&quot;pubsub.googleapis.com&quot;`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104
105See google.api.Service for the definition of a service name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107 The object takes the form of:
108
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109{ # Request message for the AllocateQuota method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;serviceConfigId&quot;: &quot;A String&quot;, # Specifies which version of service configuration should be used to process
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111 # the request. If unspecified or no matching version can be found, the latest
112 # one will be used.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;allocateOperation&quot;: { # Represents information regarding a quota operation. # Operation that describes the quota allocation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]114 &quot;labels&quot;: { # Labels describing the operation.
115 &quot;a_key&quot;: &quot;A String&quot;,
116 },
117 &quot;consumerId&quot;: &quot;A String&quot;, # Identity of the consumer for whom this quota operation is being performed.
118 #
119 # This can be in one of the following formats:
120 # project:&lt;project_id&gt;,
121 # project_number:&lt;project_number&gt;,
122 # api_key:&lt;api_key&gt;.
123 &quot;operationId&quot;: &quot;A String&quot;, # Identity of the operation. This is expected to be unique within the scope
124 # of the service that generated the operation, and guarantees idempotency in
125 # case of retries.
126 #
127 # In order to ensure best performance and latency in the Quota backends,
128 # operation_ids are optimally associated with time, so that related
129 # operations can be accessed fast in storage. For this reason, the
130 # recommended token for services that intend to operate at a high QPS is
131 # Unix time in nanos + UUID
132 &quot;methodName&quot;: &quot;A String&quot;, # Fully qualified name of the API method for which this quota operation is
133 # requested. This name is used for matching quota rules or metric rules and
134 # billing status rules defined in service configuration.
135 #
136 # This field should not be set if any of the following is true:
137 # (1) the quota operation is performed on non-API resources.
138 # (2) quota_metrics is set because the caller is doing quota override.
139 #
140 # Example of an RPC method name:
141 # google.example.library.v1.LibraryService.CreateShelf
142 &quot;quotaMode&quot;: &quot;A String&quot;, # Quota mode for this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;quotaMetrics&quot;: [ # Represents information about this operation. Each MetricValueSet
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]144 # corresponds to a metric defined in the service configuration.
145 # The data type used in the MetricValueSet must agree with
146 # the data type specified in the metric definition.
147 #
148 # Within a single operation, it is not allowed to have more than one
149 # MetricValue instances that have the same metric names and identical
150 # label value combinations. If a request has such duplicated MetricValue
151 # instances, the entire request is rejected with
152 # an invalid argument error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 #
154 # This field is mutually exclusive with method_name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]155 { # Represents a set of metric values in the same metric.
156 # Each metric value in the set should have a unique combination of start time,
157 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]158 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;metricValues&quot;: [ # The values in this metric.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]160 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
162 # applies. The time period has different semantics for different metric
163 # types (cumulative, delta, and gauge). See the metric definition
164 # documentation in the service configuration for details.
165 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]167 # The value must be between -999,999,999 and +999,999,999 inclusive.
168 # If `units` is positive, `nanos` must be positive or zero.
169 # If `units` is zero, `nanos` can be positive, zero, or negative.
170 # If `units` is negative, `nanos` must be negative or zero.
171 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]172 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
173 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
174 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]175 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;labels&quot;: { # The labels describing the metric value.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]177 # See comments on google.api.servicecontrol.v1.Operation.labels for
178 # the overriding relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]179 # Note that this map must not contain monitored resource labels.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]180 &quot;a_key&quot;: &quot;A String&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]182 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
184 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
185 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]186 # points. It contains the size of the population of sample points plus
187 # additional optional information:
188 #
189 # - the arithmetic mean of the samples
190 # - the minimum and maximum of the samples
191 # - the sum-squared-deviation of the samples, used to compute variance
192 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]194 # Sum[i=1..count]((x_i - mean)^2)
195 # where each x_i is a sample values. If `count` is zero then this field
196 # must be zero, otherwise validation of the request fails.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]198 { # Exemplars are example points that may be used to annotate aggregated
199 # distribution values. They are metadata that gives information about a
200 # particular value added to a Distribution bucket, such as a trace ID that
201 # was active when a value was added. They may contain further information,
202 # such as a example values and timestamps, origin, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
204 # exemplar belongs.
205 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
206 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]207 #
208 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
209 #
210 # Literal string: type.googleapis.com/google.protobuf.StringValue
211 #
212 # Labels dropped during aggregation:
213 # type.googleapis.com/google.monitoring.v3.DroppedLabels
214 #
215 # There may be only a single attachment of any given message type in a
216 # single exemplar, and this is enforced by the system.
217 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]219 },
220 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]221 },
222 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
224 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
225 # [scale * growth_factor^(i-1), scale * growth_factor^i)
226 # where i ranges from 1 to num_finite_buckets inclusive.
227 # Must be larger than 1.0.
228 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
229 # [scale * growth_factor^(i-1), scale * growth_factor^i)
230 # where i ranges from 1 to num_finite_buckets inclusive.
231 # Must be &gt; 0.
232 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
233 # the total number of buckets is `num_finite_buckets` + 2.
234 # See comments on `bucket_options` for details.
235 },
236 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
237 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]238 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
239 # the total number of buckets is `num_finite_buckets` + 2.
240 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]242 # [offset + (i-1) * width, offset + i * width)
243 # where i ranges from 1 to num_finite_buckets, inclusive.
244 # Must be strictly positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]246 # [offset + (i-1) * width, offset + i * width)
247 # where i ranges from 1 to num_finite_buckets, inclusive.
248 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]250 # zero then this field must be zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
252 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
253 # optional. If present, they must sum to the `count` value.
254 #
255 # The buckets are defined below in `bucket_option`. There are N buckets.
256 # `bucket_counts[0]` is the number of samples in the underflow bucket.
257 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
258 # in each of the finite buckets. And `bucket_counts[N] is the number
259 # of samples in the overflow bucket. See the comments of `bucket_option`
260 # below for more details.
261 #
262 # Any suffix of trailing zeros may be omitted.
263 &quot;A String&quot;,
264 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]265 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
266 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
267 # buckets. Note that a list of length N-1 defines N buckets because
268 # of fenceposting. See comments on `bucket_options` for details.
269 #
270 # The i&#x27;th finite bucket covers the interval
271 # [bound[i-1], bound[i])
272 # where i ranges from 1 to bound_size() - 1. Note that there are no
273 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
274 # that special case the single bound defines the boundary between the
275 # underflow and overflow buckets.
276 #
277 # bucket number lower bound upper bound
278 # i == 0 (underflow) -inf bound[i]
279 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
280 # i == bound_size() (overflow) bound[i-1] +inf
281 3.14,
282 ],
283 },
284 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]285 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]287 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
288 # applies.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]289 },
290 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]291 },
292 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]293 },
294 }
295
296 x__xgafv: string, V1 error format.
297 Allowed values
298 1 - v1 error format
299 2 - v2 error format
300
301Returns:
302 An object of the form:
303
304 { # Response message for the AllocateQuota method.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]305 &quot;operationId&quot;: &quot;A String&quot;, # The same operation_id value used in the AllocateQuotaRequest. Used for
306 # logging and diagnostics purposes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 &quot;serviceConfigId&quot;: &quot;A String&quot;, # ID of the actual config used to process the request.
308 &quot;allocateInfo&quot;: { # WARNING: DO NOT use this field until this warning message is removed.
309 &quot;unusedArguments&quot;: [ # A list of label keys that were unused by the server in processing the
310 # request. Thus, for similar requests repeated in a certain future time
311 # window, the caller can choose to ignore these labels in the requests
312 # to achieve better client-side cache hits and quota aggregation for rate
313 # quota. This field is not populated for allocation quota checks.
314 &quot;A String&quot;,
315 ],
316 },
317 &quot;allocateErrors&quot;: [ # Indicates the decision of the allocate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 { # Represents error information for QuotaOperation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]319 &quot;subject&quot;: &quot;A String&quot;, # Subject to whom this error applies. See the specific enum for more details
320 # on this field. For example, &quot;clientip:&lt;ip address of client&gt;&quot; or
321 # &quot;project:&lt;Google developer project id&gt;&quot;.
322 &quot;description&quot;: &quot;A String&quot;, # Free-form text that provides details on the cause of the error.
323 &quot;code&quot;: &quot;A String&quot;, # Error code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 },
325 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 &quot;quotaMetrics&quot;: [ # Quota metrics to indicate the result of allocation. Depending on the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]327 # request, one or more of the following metrics will be included:
328 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 # 1. Per quota group or per quota metric incremental usage will be specified
330 # using the following delta metric :
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331 # &quot;serviceruntime.googleapis.com/api/consumer/quota_used_count&quot;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]332 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 # 2. The quota limit reached condition will be specified using the following
334 # boolean metric :
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 # &quot;serviceruntime.googleapis.com/quota/exceeded&quot;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]336 { # Represents a set of metric values in the same metric.
337 # Each metric value in the set should have a unique combination of start time,
338 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]339 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]340 &quot;metricValues&quot;: [ # The values in this metric.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]341 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]342 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
343 # applies. The time period has different semantics for different metric
344 # types (cumulative, delta, and gauge). See the metric definition
345 # documentation in the service configuration for details.
346 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]347 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]348 # The value must be between -999,999,999 and +999,999,999 inclusive.
349 # If `units` is positive, `nanos` must be positive or zero.
350 # If `units` is zero, `nanos` can be positive, zero, or negative.
351 # If `units` is negative, `nanos` must be negative or zero.
352 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]353 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
354 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
355 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]356 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]357 &quot;labels&quot;: { # The labels describing the metric value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]358 # See comments on google.api.servicecontrol.v1.Operation.labels for
359 # the overriding relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 # Note that this map must not contain monitored resource labels.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]362 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]363 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
365 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
366 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]367 # points. It contains the size of the population of sample points plus
368 # additional optional information:
369 #
370 # - the arithmetic mean of the samples
371 # - the minimum and maximum of the samples
372 # - the sum-squared-deviation of the samples, used to compute variance
373 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]374 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]375 # Sum[i=1..count]((x_i - mean)^2)
376 # where each x_i is a sample values. If `count` is zero then this field
377 # must be zero, otherwise validation of the request fails.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]379 { # Exemplars are example points that may be used to annotate aggregated
380 # distribution values. They are metadata that gives information about a
381 # particular value added to a Distribution bucket, such as a trace ID that
382 # was active when a value was added. They may contain further information,
383 # such as a example values and timestamps, origin, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
385 # exemplar belongs.
386 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
387 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]388 #
389 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
390 #
391 # Literal string: type.googleapis.com/google.protobuf.StringValue
392 #
393 # Labels dropped during aggregation:
394 # type.googleapis.com/google.monitoring.v3.DroppedLabels
395 #
396 # There may be only a single attachment of any given message type in a
397 # single exemplar, and this is enforced by the system.
398 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]399 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]400 },
401 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]402 },
403 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
405 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
406 # [scale * growth_factor^(i-1), scale * growth_factor^i)
407 # where i ranges from 1 to num_finite_buckets inclusive.
408 # Must be larger than 1.0.
409 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
410 # [scale * growth_factor^(i-1), scale * growth_factor^i)
411 # where i ranges from 1 to num_finite_buckets inclusive.
412 # Must be &gt; 0.
413 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
414 # the total number of buckets is `num_finite_buckets` + 2.
415 # See comments on `bucket_options` for details.
416 },
417 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
418 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]419 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
420 # the total number of buckets is `num_finite_buckets` + 2.
421 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]423 # [offset + (i-1) * width, offset + i * width)
424 # where i ranges from 1 to num_finite_buckets, inclusive.
425 # Must be strictly positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]427 # [offset + (i-1) * width, offset + i * width)
428 # where i ranges from 1 to num_finite_buckets, inclusive.
429 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]431 # zero then this field must be zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]432 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
433 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
434 # optional. If present, they must sum to the `count` value.
435 #
436 # The buckets are defined below in `bucket_option`. There are N buckets.
437 # `bucket_counts[0]` is the number of samples in the underflow bucket.
438 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
439 # in each of the finite buckets. And `bucket_counts[N] is the number
440 # of samples in the overflow bucket. See the comments of `bucket_option`
441 # below for more details.
442 #
443 # Any suffix of trailing zeros may be omitted.
444 &quot;A String&quot;,
445 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]446 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
447 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
448 # buckets. Note that a list of length N-1 defines N buckets because
449 # of fenceposting. See comments on `bucket_options` for details.
450 #
451 # The i&#x27;th finite bucket covers the interval
452 # [bound[i-1], bound[i])
453 # where i ranges from 1 to bound_size() - 1. Note that there are no
454 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
455 # that special case the single bound defines the boundary between the
456 # underflow and overflow buckets.
457 #
458 # bucket number lower bound upper bound
459 # i == 0 (underflow) -inf bound[i]
460 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
461 # i == bound_size() (overflow) bound[i-1] +inf
462 3.14,
463 ],
464 },
465 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]466 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]467 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]468 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
469 # applies.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]470 },
471 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]472 },
473 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]474 }</pre>
475</div>
476
477<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]478 <code class="details" id="check">check(serviceName, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 <pre>Checks whether an operation on a service should be allowed to proceed
480based on the configuration of the service and related policies. It must be
481called before the operation is executed.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]482
483If feasible, the client should cache the check results and reuse them for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]48460 seconds. In case of any server errors, the client should rely on the
485cached results for much longer time to avoid outage.
486WARNING: There is general 60s delay for the configuration and policy
487propagation, therefore callers MUST NOT depend on the `Check` method having
488the latest policy information.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]489
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490NOTE: the CheckRequest has the size limit of 64KB.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]491
492This method requires the `servicemanagement.services.check` permission
493on the specified service. For more information, see
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494[Cloud IAM](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]495
496Args:
497 serviceName: string, The service name as specified in its service configuration. For example,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]498`&quot;pubsub.googleapis.com&quot;`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]499
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500See
501[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
502for the definition of a service name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]503 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]504 The object takes the form of:
505
506{ # Request message for the Check method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;skipActivationCheck&quot;: True or False, # Indicates if service activation check should be skipped for this request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]508 # Default behavior is to perform the check and apply relevant quota.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]509 # WARNING: Setting this flag to &quot;true&quot; will disable quota enforcement.
510 &quot;operation&quot;: { # Represents information regarding an operation. # The operation to be checked.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]511 &quot;operationId&quot;: &quot;A String&quot;, # Identity of the operation. This must be unique within the scope of the
512 # service that generated the operation. If the service calls
513 # Check() and Report() on the same operation, the two calls should carry
514 # the same id.
515 #
516 # UUID version 4 is recommended, though not required.
517 # In scenarios where an operation is computed from existing information
518 # and an idempotent id is desirable for deduplication purpose, UUID version 5
519 # is recommended. See RFC 4122 for details.
520 &quot;operationName&quot;: &quot;A String&quot;, # Fully qualified name of the operation. Reserved for future use.
521 &quot;endTime&quot;: &quot;A String&quot;, # End time of the operation.
522 # Required when the operation is used in ServiceController.Report,
523 # but optional when the operation is used in ServiceController.Check.
524 &quot;startTime&quot;: &quot;A String&quot;, # Required. Start time of the operation.
525 &quot;importance&quot;: &quot;A String&quot;, # DO NOT USE. This is an experimental field.
526 &quot;labels&quot;: { # Labels describing the operation. Only the following labels are allowed:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]527 #
528 # - Labels describing monitored resources as defined in
529 # the service configuration.
530 # - Default labels of metric values. When specified, labels defined in the
531 # metric value override these default.
532 # - The following labels defined by Google Cloud Platform:
533 # - `cloud.googleapis.com/location` describing the location where the
534 # operation happened,
535 # - `servicecontrol.googleapis.com/user_agent` describing the user agent
536 # of the API request,
537 # - `servicecontrol.googleapis.com/service_agent` describing the service
538 # used to handle the API request (e.g. ESP),
539 # - `servicecontrol.googleapis.com/platform` describing the platform
540 # where the API is served, such as App Engine, Compute Engine, or
541 # Kubernetes Engine.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]542 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]544 &quot;resources&quot;: [ # The resources that are involved in the operation.
545 # The maximum supported number of entries in this field is 100.
546 { # Describes a resource associated with this operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]547 &quot;resourceName&quot;: &quot;A String&quot;, # Name of the resource. This is used for auditing purposes.
548 &quot;resourceLocation&quot;: &quot;A String&quot;, # The location of the resource. If not empty, the resource will be checked
549 # against location policy. The value must be a valid zone, region or
550 # multiregion. For example: &quot;europe-west4&quot; or &quot;northamerica-northeast1-a&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]551 &quot;resourceContainer&quot;: &quot;A String&quot;, # The identifier of the parent of this resource instance.
552 # Must be in one of the following formats:
553 # - “projects/&lt;project-id or project-number&gt;”
554 # - “folders/&lt;folder-id&gt;”
555 # - “organizations/&lt;organization-id&gt;”
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]556 },
557 ],
558 &quot;logEntries&quot;: [ # Represents information to be logged.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]559 { # An individual log entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]560 &quot;httpRequest&quot;: { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561 # log entry, if applicable.
562 # defined by the HTTP specification. Product-specific logging
563 # information MUST be defined in a separate message.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]564 &quot;referer&quot;: &quot;A String&quot;, # The referer URL of the request, as defined in
565 # [HTTP/1.1 Header Field
566 # Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]567 &quot;latency&quot;: &quot;A String&quot;, # The request processing latency on the server, from the time the request was
568 # received until the response was sent.
569 &quot;userAgent&quot;: &quot;A String&quot;, # The user agent sent by the client. Example:
570 # `&quot;Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET
571 # CLR 1.0.3705)&quot;`.
572 &quot;cacheFillBytes&quot;: &quot;A String&quot;, # The number of HTTP response bytes inserted into cache. Set only when a
573 # cache fill was attempted.
574 &quot;requestMethod&quot;: &quot;A String&quot;, # The request method. Examples: `&quot;GET&quot;`, `&quot;HEAD&quot;`, `&quot;PUT&quot;`, `&quot;POST&quot;`.
575 &quot;requestSize&quot;: &quot;A String&quot;, # The size of the HTTP request message in bytes, including the request
576 # headers and the request body.
577 &quot;responseSize&quot;: &quot;A String&quot;, # The size of the HTTP response message sent back to the client, in bytes,
578 # including the response headers and the response body.
579 &quot;protocol&quot;: &quot;A String&quot;, # Protocol used for the request. Examples: &quot;HTTP/1.1&quot;, &quot;HTTP/2&quot;, &quot;websocket&quot;
580 &quot;requestUrl&quot;: &quot;A String&quot;, # The scheme (http, https), the host name, the path, and the query
581 # portion of the URL that was requested.
582 # Example: `&quot;http://example.com/some/info?color=red&quot;`.
583 &quot;remoteIp&quot;: &quot;A String&quot;, # The IP address (IPv4 or IPv6) of the client that issued the HTTP
584 # request. Examples: `&quot;192.168.1.1&quot;`, `&quot;FE80::0202:B3FF:FE1E:8329&quot;`.
585 &quot;serverIp&quot;: &quot;A String&quot;, # The IP address (IPv4 or IPv6) of the origin server that the request was
586 # sent to.
587 &quot;cacheLookup&quot;: True or False, # Whether or not a cache lookup was attempted.
588 &quot;cacheHit&quot;: True or False, # Whether or not an entity was served from cache
589 # (with or without validation).
590 &quot;cacheValidatedWithOriginServer&quot;: True or False, # Whether or not the response was validated with the origin server before
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]591 # being served from cache. This field is only meaningful if `cache_hit` is
592 # True.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]593 &quot;status&quot;: 42, # The response code indicating the status of the response.
594 # Examples: 200, 404.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]596 &quot;operation&quot;: { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
597 # applicable.
598 # a log entry is associated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]599 &quot;id&quot;: &quot;A String&quot;, # Optional. An arbitrary operation identifier. Log entries with the
600 # same identifier are assumed to be part of the same operation.
601 &quot;producer&quot;: &quot;A String&quot;, # Optional. An arbitrary producer identifier. The combination of
602 # `id` and `producer` must be globally unique. Examples for `producer`:
603 # `&quot;MyDivision.MyBigCompany.com&quot;`, `&quot;github.com/MyProject/MyApplication&quot;`.
604 &quot;first&quot;: True or False, # Optional. Set this to True if this is the first log entry in the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]605 &quot;last&quot;: True or False, # Optional. Set this to True if this is the last log entry in the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]606 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]607 &quot;name&quot;: &quot;A String&quot;, # Required. The log to which this log entry belongs. Examples: `&quot;syslog&quot;`,
608 # `&quot;book_log&quot;`.
609 &quot;insertId&quot;: &quot;A String&quot;, # A unique ID for the log entry used for deduplication. If omitted,
610 # the implementation will generate one based on operation_id.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]611 &quot;textPayload&quot;: &quot;A String&quot;, # The log entry payload, represented as a Unicode string (UTF-8).
612 &quot;protoPayload&quot;: { # The log entry payload, represented as a protocol buffer that is
613 # expressed as a JSON object. The only accepted type currently is
614 # AuditLog.
615 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
616 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]617 &quot;labels&quot;: { # A set of user-defined (key, value) data that provides additional
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]618 # information about the log entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]619 &quot;a_key&quot;: &quot;A String&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]620 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]621 &quot;trace&quot;: &quot;A String&quot;, # Optional. Resource name of the trace associated with the log entry, if any.
622 # If this field contains a relative resource name, you can assume the name is
623 # relative to `//tracing.googleapis.com`. Example:
624 # `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]625 &quot;severity&quot;: &quot;A String&quot;, # The severity of the log entry. The default value is
626 # `LogSeverity.DEFAULT`.
627 &quot;sourceLocation&quot;: { # Additional information about the source code location that produced the log # Optional. Source code location information associated with the log entry,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]628 # if any.
629 # entry.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]630 &quot;line&quot;: &quot;A String&quot;, # Optional. Line within the source file. 1-based; 0 indicates no line number
631 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]632 &quot;file&quot;: &quot;A String&quot;, # Optional. Source file name. Depending on the runtime environment, this
633 # might be a simple name or a fully-qualified name.
634 &quot;function&quot;: &quot;A String&quot;, # Optional. Human-readable name of the function or method being invoked, with
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]635 # optional context such as the class or package name. This information may be
636 # used in contexts such as the logs viewer, where a file and line number are
637 # less meaningful. The format can vary by language. For example:
638 # `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`
639 # (Python).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]640 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]641 &quot;structPayload&quot;: { # The log entry payload, represented as a structure that
642 # is expressed as a JSON object.
643 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
644 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]645 &quot;timestamp&quot;: &quot;A String&quot;, # The time the event described by the log entry occurred. If
646 # omitted, defaults to operation start time.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]647 },
648 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]649 &quot;userLabels&quot;: { # User defined labels for the resource that this operation is associated
650 # with. Only a combination of 1000 user labels per consumer project are
651 # allowed.
652 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]653 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]654 &quot;metricValueSets&quot;: [ # Represents information about this operation. Each MetricValueSet
655 # corresponds to a metric defined in the service configuration.
656 # The data type used in the MetricValueSet must agree with
657 # the data type specified in the metric definition.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]658 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]659 # Within a single operation, it is not allowed to have more than one
660 # MetricValue instances that have the same metric names and identical
661 # label value combinations. If a request has such duplicated MetricValue
662 # instances, the entire request is rejected with
663 # an invalid argument error.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]664 { # Represents a set of metric values in the same metric.
665 # Each metric value in the set should have a unique combination of start time,
666 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]667 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]668 &quot;metricValues&quot;: [ # The values in this metric.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]669 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]670 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
671 # applies. The time period has different semantics for different metric
672 # types (cumulative, delta, and gauge). See the metric definition
673 # documentation in the service configuration for details.
674 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]675 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]676 # The value must be between -999,999,999 and +999,999,999 inclusive.
677 # If `units` is positive, `nanos` must be positive or zero.
678 # If `units` is zero, `nanos` can be positive, zero, or negative.
679 # If `units` is negative, `nanos` must be negative or zero.
680 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]681 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
682 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
683 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]684 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]685 &quot;labels&quot;: { # The labels describing the metric value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]686 # See comments on google.api.servicecontrol.v1.Operation.labels for
687 # the overriding relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]688 # Note that this map must not contain monitored resource labels.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]689 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]690 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]691 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]692 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
693 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
694 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 # points. It contains the size of the population of sample points plus
696 # additional optional information:
697 #
698 # - the arithmetic mean of the samples
699 # - the minimum and maximum of the samples
700 # - the sum-squared-deviation of the samples, used to compute variance
701 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]702 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]703 # Sum[i=1..count]((x_i - mean)^2)
704 # where each x_i is a sample values. If `count` is zero then this field
705 # must be zero, otherwise validation of the request fails.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]706 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]707 { # Exemplars are example points that may be used to annotate aggregated
708 # distribution values. They are metadata that gives information about a
709 # particular value added to a Distribution bucket, such as a trace ID that
710 # was active when a value was added. They may contain further information,
711 # such as a example values and timestamps, origin, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]712 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
713 # exemplar belongs.
714 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
715 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]716 #
717 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
718 #
719 # Literal string: type.googleapis.com/google.protobuf.StringValue
720 #
721 # Labels dropped during aggregation:
722 # type.googleapis.com/google.monitoring.v3.DroppedLabels
723 #
724 # There may be only a single attachment of any given message type in a
725 # single exemplar, and this is enforced by the system.
726 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]727 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]728 },
729 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]730 },
731 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]732 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
733 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
734 # [scale * growth_factor^(i-1), scale * growth_factor^i)
735 # where i ranges from 1 to num_finite_buckets inclusive.
736 # Must be larger than 1.0.
737 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
738 # [scale * growth_factor^(i-1), scale * growth_factor^i)
739 # where i ranges from 1 to num_finite_buckets inclusive.
740 # Must be &gt; 0.
741 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
742 # the total number of buckets is `num_finite_buckets` + 2.
743 # See comments on `bucket_options` for details.
744 },
745 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
746 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]747 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
748 # the total number of buckets is `num_finite_buckets` + 2.
749 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]750 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]751 # [offset + (i-1) * width, offset + i * width)
752 # where i ranges from 1 to num_finite_buckets, inclusive.
753 # Must be strictly positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]754 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]755 # [offset + (i-1) * width, offset + i * width)
756 # where i ranges from 1 to num_finite_buckets, inclusive.
757 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]758 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
759 # zero then this field must be zero.
760 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
761 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
762 # optional. If present, they must sum to the `count` value.
763 #
764 # The buckets are defined below in `bucket_option`. There are N buckets.
765 # `bucket_counts[0]` is the number of samples in the underflow bucket.
766 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
767 # in each of the finite buckets. And `bucket_counts[N] is the number
768 # of samples in the overflow bucket. See the comments of `bucket_option`
769 # below for more details.
770 #
771 # Any suffix of trailing zeros may be omitted.
772 &quot;A String&quot;,
773 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]774 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
775 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
776 # buckets. Note that a list of length N-1 defines N buckets because
777 # of fenceposting. See comments on `bucket_options` for details.
778 #
779 # The i&#x27;th finite bucket covers the interval
780 # [bound[i-1], bound[i])
781 # where i ranges from 1 to bound_size() - 1. Note that there are no
782 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
783 # that special case the single bound defines the boundary between the
784 # underflow and overflow buckets.
785 #
786 # bucket number lower bound upper bound
787 # i == 0 (underflow) -inf bound[i]
788 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
789 # i == bound_size() (overflow) bound[i-1] +inf
790 3.14,
791 ],
792 },
793 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]794 },
795 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]796 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
797 # applies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]798 },
799 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]800 },
801 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]802 &quot;traceSpans&quot;: [ # Unimplemented. A list of Cloud Trace spans. The span names shall contain
803 # the id of the destination project which can be either the produce or the
804 # consumer project.
805 { # A span represents a single operation within a trace. Spans can be
806 # nested to form a trace tree. Often, a trace contains a root span
807 # that describes the end-to-end latency, and one or more subspans for
808 # its sub-operations. A trace can also contain multiple root spans,
809 # or none at all. Spans do not need to be contiguous&amp;mdash;there may be
810 # gaps or overlaps between spans in a trace.
811 &quot;childSpanCount&quot;: 42, # An optional number of child spans that were generated while this span
812 # was active. If set, allows implementation to detect missing child spans.
813 &quot;sameProcessAsParentSpan&quot;: True or False, # (Optional) Set this parameter to indicate whether this span is in
814 # the same process as its parent. If you do not set this parameter,
815 # Stackdriver Trace is unable to take advantage of this helpful
816 # information.
817 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # An optional final status for this span.
818 # different programming environments, including REST APIs and RPC APIs. It is
819 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
820 # three pieces of data: error code, error message, and error details.
821 #
822 # You can find out more about this error model and how to work with it in the
823 # [API Design Guide](https://cloud.google.com/apis/design/errors).
824 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
825 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
826 # user-facing error message should be localized and sent in the
827 # google.rpc.Status.details field, or localized by the client.
828 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
829 # message types for APIs to use.
830 {
831 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
832 },
833 ],
834 },
835 &quot;name&quot;: &quot;A String&quot;, # The resource name of the span in the following format:
836 #
837 # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;
838 # it is a 32-character hexadecimal encoding of a 16-byte array.
839 #
840 # [SPAN_ID] is a unique identifier for a span within a trace; it
841 # is a 16-character hexadecimal encoding of an 8-byte array.
842 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per
843 # span.
844 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
845 # because their keys are too long or because there are too many attributes.
846 # If this value is 0 then all attributes are valid.
847 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
848 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
849 # or the Boolean values `true` and `false`. For example:
850 #
851 # &quot;/instance_id&quot;: &quot;my-instance&quot;
852 # &quot;/http/user_agent&quot;: &quot;&quot;
853 # &quot;/http/request_bytes&quot;: 300
854 # &quot;abc.com/myattribute&quot;: true
855 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
856 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
857 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
858 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
859 # value is 0, then the string was not shortened.
860 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
861 # bytes long and the limit of the string is 128 bytes, then
862 # `value` contains the first 128 bytes of the 500-byte string.
863 #
864 # Truncation always happens on a UTF8 character boundary. If there
865 # are multi-byte characters in the string, then the length of the
866 # shortened string might be less than the size limit.
867 },
868 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
869 },
870 },
871 },
872 &quot;spanId&quot;: &quot;A String&quot;, # The [SPAN_ID] portion of the span&#x27;s resource name.
873 &quot;parentSpanId&quot;: &quot;A String&quot;, # The [SPAN_ID] of this span&#x27;s parent span. If this is a root span,
874 # then this field must be empty.
875 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the span. On the client side, this is the time kept by
876 # the local machine where the span execution ends. On the server side, this
877 # is the time when the server application handler stops running.
878 &quot;spanKind&quot;: &quot;A String&quot;, # Distinguishes between spans generated in a particular context. For example,
879 # two spans with the same name may be distinguished using `CLIENT` (caller)
880 # and `SERVER` (callee) to identify an RPC call.
881 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the span. On the client side, this is the time kept by
882 # the local machine where the span execution starts. On the server side, this
883 # is the time when the server&#x27;s application handler starts running.
884 &quot;displayName&quot;: { # Represents a string that might be shortened to a specified length. # A description of the span&#x27;s operation (up to 128 bytes).
885 # Stackdriver Trace displays the description in the
886 # Google Cloud Platform Console.
887 # For example, the display name can be a qualified method name or a file name
888 # and a line number where the operation is called. A best practice is to use
889 # the same display name within an application and at the same call point.
890 # This makes it easier to correlate spans in different traces.
891 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
892 # value is 0, then the string was not shortened.
893 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
894 # bytes long and the limit of the string is 128 bytes, then
895 # `value` contains the first 128 bytes of the 500-byte string.
896 #
897 # Truncation always happens on a UTF8 character boundary. If there
898 # are multi-byte characters in the string, then the length of the
899 # shortened string might be less than the size limit.
900 },
901 },
902 ],
903 &quot;quotaProperties&quot;: { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this
904 # operation is for a quota check request. If this is not specified, no quota
905 # check will be performed.
906 &quot;quotaMode&quot;: &quot;A String&quot;, # Quota mode for this operation.
907 },
908 &quot;consumerId&quot;: &quot;A String&quot;, # Identity of the consumer who is using the service.
909 # This field should be filled in for the operations initiated by a
910 # consumer, but not for service-initiated operations that are
911 # not related to a specific consumer.
912 #
913 # - This can be in one of the following formats:
914 # - project:PROJECT_ID,
915 # - project`_`number:PROJECT_NUMBER,
916 # - projects/PROJECT_ID or PROJECT_NUMBER,
917 # - folders/FOLDER_NUMBER,
918 # - organizations/ORGANIZATION_NUMBER,
919 # - api`_`key:API_KEY.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]920 },
921 &quot;requestProjectSettings&quot;: True or False, # Requests the project settings to be returned as part of the check response.
922 &quot;serviceConfigId&quot;: &quot;A String&quot;, # Specifies which version of service configuration should be used to process
923 # the request.
924 #
925 # If unspecified or no matching version can be found, the
926 # latest one will be used.
927 }
928
929 x__xgafv: string, V1 error format.
930 Allowed values
931 1 - v1 error format
932 2 - v2 error format
933
934Returns:
935 An object of the form:
936
937 { # Response message for the Check method.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]938 &quot;serviceRolloutId&quot;: &quot;A String&quot;, # The current service rollout id used to process the request.
939 &quot;operationId&quot;: &quot;A String&quot;, # The same operation_id value used in the CheckRequest.
940 # Used for logging and diagnostics purposes.
941 &quot;checkErrors&quot;: [ # Indicate the decision of the check.
942 #
943 # If no check errors are present, the service should process the operation.
944 # Otherwise the service should use the list of errors to determine the
945 # appropriate action.
946 { # Defines the errors to be returned in
947 # google.api.servicecontrol.v1.CheckResponse.check_errors.
948 &quot;detail&quot;: &quot;A String&quot;, # Free-form text providing details on the error cause of the error.
949 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Contains public information about the check error. If available,
950 # `status.code` will be non zero and client can propagate it out as public
951 # error.
952 # different programming environments, including REST APIs and RPC APIs. It is
953 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
954 # three pieces of data: error code, error message, and error details.
955 #
956 # You can find out more about this error model and how to work with it in the
957 # [API Design Guide](https://cloud.google.com/apis/design/errors).
958 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
959 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
960 # user-facing error message should be localized and sent in the
961 # google.rpc.Status.details field, or localized by the client.
962 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
963 # message types for APIs to use.
964 {
965 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
966 },
967 ],
968 },
969 &quot;subject&quot;: &quot;A String&quot;, # Subject to whom this error applies. See the specific code enum for more
970 # details on this field. For example:
971 #
972 # - &quot;project:&lt;project-id or project-number&gt;&quot;
973 # - &quot;folder:&lt;folder-id&gt;&quot;
974 # - &quot;organization:&lt;organization-id&gt;&quot;
975 &quot;code&quot;: &quot;A String&quot;, # The error code.
976 },
977 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]978 &quot;checkInfo&quot;: { # Contains additional information about the check operation. # Feedback data returned from the server during processing a Check request.
979 &quot;unusedArguments&quot;: [ # A list of fields and label keys that are ignored by the server.
980 # The client doesn&#x27;t need to send them for following requests to improve
981 # performance and allow better aggregation.
982 &quot;A String&quot;,
983 ],
984 &quot;consumerInfo&quot;: { # `ConsumerInfo` provides information about the consumer. # Consumer info of this check.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]985 &quot;type&quot;: &quot;A String&quot;, # The type of the consumer which should have been defined in
986 # [Google Resource Manager](https://cloud.google.com/resource-manager/).
987 &quot;projectNumber&quot;: &quot;A String&quot;, # The Google cloud project number, e.g. 1234567890. A value of 0 indicates
988 # no project number is found.
989 #
990 # NOTE: This field is deprecated after Chemist support flexible consumer
991 # id. New code should not depend on this field anymore.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]992 &quot;consumerNumber&quot;: &quot;A String&quot;, # The consumer identity number, can be Google cloud project number, folder
993 # number or organization number e.g. 1234567890. A value of 0 indicates no
994 # consumer number is found.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]995 },
996 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]997 &quot;serviceConfigId&quot;: &quot;A String&quot;, # The actual config id used to process the request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]998 &quot;quotaInfo&quot;: { # Contains the quota information for a quota check response. # Quota information for the check request associated with this response.
999 &quot;limitExceeded&quot;: [ # Quota Metrics that have exceeded quota limits.
1000 # For QuotaGroup-based quota, this is QuotaGroup.name
1001 # For QuotaLimit-based quota, this is QuotaLimit.name
1002 # See: google.api.Quota
1003 # Deprecated: Use quota_metrics to get per quota group limit exceeded status.
1004 &quot;A String&quot;,
1005 ],
1006 &quot;quotaConsumed&quot;: { # Map of quota group name to the actual number of tokens consumed. If the
1007 # quota check was not successful, then this will not be populated due to no
1008 # quota consumption.
1009 #
1010 # We are not merging this field with &#x27;quota_metrics&#x27; field because of the
1011 # complexity of scaling in Chemist client code base. For simplicity, we will
1012 # keep this field for Castor (that scales quota usage) and &#x27;quota_metrics&#x27;
1013 # for SuperQuota (that doesn&#x27;t scale quota usage).
1014 &quot;a_key&quot;: 42,
1015 },
1016 &quot;quotaMetrics&quot;: [ # Quota metrics to indicate the usage. Depending on the check request, one or
1017 # more of the following metrics will be included:
1018 #
1019 # 1. For rate quota, per quota group or per quota metric incremental usage
1020 # will be specified using the following delta metric:
1021 # &quot;serviceruntime.googleapis.com/api/consumer/quota_used_count&quot;
1022 #
1023 # 2. For allocation quota, per quota metric total usage will be specified
1024 # using the following gauge metric:
1025 # &quot;serviceruntime.googleapis.com/allocation/consumer/quota_used_count&quot;
1026 #
1027 # 3. For both rate quota and allocation quota, the quota limit reached
1028 # condition will be specified using the following boolean metric:
1029 # &quot;serviceruntime.googleapis.com/quota/exceeded&quot;
1030 { # Represents a set of metric values in the same metric.
1031 # Each metric value in the set should have a unique combination of start time,
1032 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1033 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1034 &quot;metricValues&quot;: [ # The values in this metric.
1035 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1036 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
1037 # applies. The time period has different semantics for different metric
1038 # types (cumulative, delta, and gauge). See the metric definition
1039 # documentation in the service configuration for details.
1040 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1041 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
1042 # The value must be between -999,999,999 and +999,999,999 inclusive.
1043 # If `units` is positive, `nanos` must be positive or zero.
1044 # If `units` is zero, `nanos` can be positive, zero, or negative.
1045 # If `units` is negative, `nanos` must be negative or zero.
1046 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1047 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
1048 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
1049 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1050 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1051 &quot;labels&quot;: { # The labels describing the metric value.
1052 # See comments on google.api.servicecontrol.v1.Operation.labels for
1053 # the overriding relationship.
1054 # Note that this map must not contain monitored resource labels.
1055 &quot;a_key&quot;: &quot;A String&quot;,
1056 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1057 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1058 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
1059 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
1060 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
1061 # points. It contains the size of the population of sample points plus
1062 # additional optional information:
1063 #
1064 # - the arithmetic mean of the samples
1065 # - the minimum and maximum of the samples
1066 # - the sum-squared-deviation of the samples, used to compute variance
1067 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1068 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
1069 # Sum[i=1..count]((x_i - mean)^2)
1070 # where each x_i is a sample values. If `count` is zero then this field
1071 # must be zero, otherwise validation of the request fails.
1072 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
1073 { # Exemplars are example points that may be used to annotate aggregated
1074 # distribution values. They are metadata that gives information about a
1075 # particular value added to a Distribution bucket, such as a trace ID that
1076 # was active when a value was added. They may contain further information,
1077 # such as a example values and timestamps, origin, etc.
1078 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
1079 # exemplar belongs.
1080 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
1081 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
1082 #
1083 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
1084 #
1085 # Literal string: type.googleapis.com/google.protobuf.StringValue
1086 #
1087 # Labels dropped during aggregation:
1088 # type.googleapis.com/google.monitoring.v3.DroppedLabels
1089 #
1090 # There may be only a single attachment of any given message type in a
1091 # single exemplar, and this is enforced by the system.
1092 {
1093 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1094 },
1095 ],
1096 },
1097 ],
1098 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
1099 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1100 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1101 # where i ranges from 1 to num_finite_buckets inclusive.
1102 # Must be larger than 1.0.
1103 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1104 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1105 # where i ranges from 1 to num_finite_buckets inclusive.
1106 # Must be &gt; 0.
1107 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1108 # the total number of buckets is `num_finite_buckets` + 2.
1109 # See comments on `bucket_options` for details.
1110 },
1111 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
1112 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1113 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1114 # the total number of buckets is `num_finite_buckets` + 2.
1115 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1116 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
1117 # [offset + (i-1) * width, offset + i * width)
1118 # where i ranges from 1 to num_finite_buckets, inclusive.
1119 # Must be strictly positive.
1120 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
1121 # [offset + (i-1) * width, offset + i * width)
1122 # where i ranges from 1 to num_finite_buckets, inclusive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1123 },
1124 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1125 # zero then this field must be zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1126 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
1127 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
1128 # optional. If present, they must sum to the `count` value.
1129 #
1130 # The buckets are defined below in `bucket_option`. There are N buckets.
1131 # `bucket_counts[0]` is the number of samples in the underflow bucket.
1132 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
1133 # in each of the finite buckets. And `bucket_counts[N] is the number
1134 # of samples in the overflow bucket. See the comments of `bucket_option`
1135 # below for more details.
1136 #
1137 # Any suffix of trailing zeros may be omitted.
1138 &quot;A String&quot;,
1139 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1140 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
1141 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
1142 # buckets. Note that a list of length N-1 defines N buckets because
1143 # of fenceposting. See comments on `bucket_options` for details.
1144 #
1145 # The i&#x27;th finite bucket covers the interval
1146 # [bound[i-1], bound[i])
1147 # where i ranges from 1 to bound_size() - 1. Note that there are no
1148 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
1149 # that special case the single bound defines the boundary between the
1150 # underflow and overflow buckets.
1151 #
1152 # bucket number lower bound upper bound
1153 # i == 0 (underflow) -inf bound[i]
1154 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
1155 # i == bound_size() (overflow) bound[i-1] +inf
1156 3.14,
1157 ],
1158 },
1159 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1160 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1161 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1162 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
1163 # applies.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1164 },
1165 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1166 },
1167 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1168 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1169 }</pre>
1170</div>
1171
1172<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1173 <code class="details" id="report">report(serviceName, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1174 <pre>Reports operation results to Google Service Control, such as logs and
1175metrics. It should be called after an operation is completed.
1176
1177If feasible, the client should aggregate reporting data for up to 5
1178seconds to reduce API traffic. Limiting aggregation to 5 seconds is to
1179reduce data loss during client crashes. Clients should carefully choose
1180the aggregation time window to avoid data loss risk more than 0.01%
1181for business and compliance reasons.
1182
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1183NOTE: the ReportRequest has the size limit (wire-format byte size) of
11841MB.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1185
1186This method requires the `servicemanagement.services.report` permission
1187on the specified service. For more information, see
1188[Google Cloud IAM](https://cloud.google.com/iam).
1189
1190Args:
1191 serviceName: string, The service name as specified in its service configuration. For example,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1192`&quot;pubsub.googleapis.com&quot;`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1193
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1194See
1195[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
1196for the definition of a service name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1197 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1198 The object takes the form of:
1199
1200{ # Request message for the Report method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1201 &quot;operations&quot;: [ # Operations to be reported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1202 #
1203 # Typically the service should report one operation per request.
1204 # Putting multiple operations into a single request is allowed, but should
1205 # be used only when multiple operations are natually available at the time
1206 # of the report.
1207 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1208 # There is no limit on the number of operations in the same ReportRequest,
1209 # however the ReportRequest size should be no larger than 1MB. See
1210 # ReportResponse.report_errors for partial failure behavior.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1211 { # Represents information regarding an operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1212 &quot;operationId&quot;: &quot;A String&quot;, # Identity of the operation. This must be unique within the scope of the
1213 # service that generated the operation. If the service calls
1214 # Check() and Report() on the same operation, the two calls should carry
1215 # the same id.
1216 #
1217 # UUID version 4 is recommended, though not required.
1218 # In scenarios where an operation is computed from existing information
1219 # and an idempotent id is desirable for deduplication purpose, UUID version 5
1220 # is recommended. See RFC 4122 for details.
1221 &quot;operationName&quot;: &quot;A String&quot;, # Fully qualified name of the operation. Reserved for future use.
1222 &quot;endTime&quot;: &quot;A String&quot;, # End time of the operation.
1223 # Required when the operation is used in ServiceController.Report,
1224 # but optional when the operation is used in ServiceController.Check.
1225 &quot;startTime&quot;: &quot;A String&quot;, # Required. Start time of the operation.
1226 &quot;importance&quot;: &quot;A String&quot;, # DO NOT USE. This is an experimental field.
1227 &quot;labels&quot;: { # Labels describing the operation. Only the following labels are allowed:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1228 #
1229 # - Labels describing monitored resources as defined in
1230 # the service configuration.
1231 # - Default labels of metric values. When specified, labels defined in the
1232 # metric value override these default.
1233 # - The following labels defined by Google Cloud Platform:
1234 # - `cloud.googleapis.com/location` describing the location where the
1235 # operation happened,
1236 # - `servicecontrol.googleapis.com/user_agent` describing the user agent
1237 # of the API request,
1238 # - `servicecontrol.googleapis.com/service_agent` describing the service
1239 # used to handle the API request (e.g. ESP),
1240 # - `servicecontrol.googleapis.com/platform` describing the platform
1241 # where the API is served, such as App Engine, Compute Engine, or
1242 # Kubernetes Engine.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1243 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1244 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1245 &quot;resources&quot;: [ # The resources that are involved in the operation.
1246 # The maximum supported number of entries in this field is 100.
1247 { # Describes a resource associated with this operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1248 &quot;resourceName&quot;: &quot;A String&quot;, # Name of the resource. This is used for auditing purposes.
1249 &quot;resourceLocation&quot;: &quot;A String&quot;, # The location of the resource. If not empty, the resource will be checked
1250 # against location policy. The value must be a valid zone, region or
1251 # multiregion. For example: &quot;europe-west4&quot; or &quot;northamerica-northeast1-a&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1252 &quot;resourceContainer&quot;: &quot;A String&quot;, # The identifier of the parent of this resource instance.
1253 # Must be in one of the following formats:
1254 # - “projects/&lt;project-id or project-number&gt;”
1255 # - “folders/&lt;folder-id&gt;”
1256 # - “organizations/&lt;organization-id&gt;”
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1257 },
1258 ],
1259 &quot;logEntries&quot;: [ # Represents information to be logged.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1260 { # An individual log entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1261 &quot;httpRequest&quot;: { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1262 # log entry, if applicable.
1263 # defined by the HTTP specification. Product-specific logging
1264 # information MUST be defined in a separate message.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1265 &quot;referer&quot;: &quot;A String&quot;, # The referer URL of the request, as defined in
1266 # [HTTP/1.1 Header Field
1267 # Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1268 &quot;latency&quot;: &quot;A String&quot;, # The request processing latency on the server, from the time the request was
1269 # received until the response was sent.
1270 &quot;userAgent&quot;: &quot;A String&quot;, # The user agent sent by the client. Example:
1271 # `&quot;Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET
1272 # CLR 1.0.3705)&quot;`.
1273 &quot;cacheFillBytes&quot;: &quot;A String&quot;, # The number of HTTP response bytes inserted into cache. Set only when a
1274 # cache fill was attempted.
1275 &quot;requestMethod&quot;: &quot;A String&quot;, # The request method. Examples: `&quot;GET&quot;`, `&quot;HEAD&quot;`, `&quot;PUT&quot;`, `&quot;POST&quot;`.
1276 &quot;requestSize&quot;: &quot;A String&quot;, # The size of the HTTP request message in bytes, including the request
1277 # headers and the request body.
1278 &quot;responseSize&quot;: &quot;A String&quot;, # The size of the HTTP response message sent back to the client, in bytes,
1279 # including the response headers and the response body.
1280 &quot;protocol&quot;: &quot;A String&quot;, # Protocol used for the request. Examples: &quot;HTTP/1.1&quot;, &quot;HTTP/2&quot;, &quot;websocket&quot;
1281 &quot;requestUrl&quot;: &quot;A String&quot;, # The scheme (http, https), the host name, the path, and the query
1282 # portion of the URL that was requested.
1283 # Example: `&quot;http://example.com/some/info?color=red&quot;`.
1284 &quot;remoteIp&quot;: &quot;A String&quot;, # The IP address (IPv4 or IPv6) of the client that issued the HTTP
1285 # request. Examples: `&quot;192.168.1.1&quot;`, `&quot;FE80::0202:B3FF:FE1E:8329&quot;`.
1286 &quot;serverIp&quot;: &quot;A String&quot;, # The IP address (IPv4 or IPv6) of the origin server that the request was
1287 # sent to.
1288 &quot;cacheLookup&quot;: True or False, # Whether or not a cache lookup was attempted.
1289 &quot;cacheHit&quot;: True or False, # Whether or not an entity was served from cache
1290 # (with or without validation).
1291 &quot;cacheValidatedWithOriginServer&quot;: True or False, # Whether or not the response was validated with the origin server before
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1292 # being served from cache. This field is only meaningful if `cache_hit` is
1293 # True.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1294 &quot;status&quot;: 42, # The response code indicating the status of the response.
1295 # Examples: 200, 404.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1296 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1297 &quot;operation&quot;: { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if
1298 # applicable.
1299 # a log entry is associated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1300 &quot;id&quot;: &quot;A String&quot;, # Optional. An arbitrary operation identifier. Log entries with the
1301 # same identifier are assumed to be part of the same operation.
1302 &quot;producer&quot;: &quot;A String&quot;, # Optional. An arbitrary producer identifier. The combination of
1303 # `id` and `producer` must be globally unique. Examples for `producer`:
1304 # `&quot;MyDivision.MyBigCompany.com&quot;`, `&quot;github.com/MyProject/MyApplication&quot;`.
1305 &quot;first&quot;: True or False, # Optional. Set this to True if this is the first log entry in the operation.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1306 &quot;last&quot;: True or False, # Optional. Set this to True if this is the last log entry in the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1307 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1308 &quot;name&quot;: &quot;A String&quot;, # Required. The log to which this log entry belongs. Examples: `&quot;syslog&quot;`,
1309 # `&quot;book_log&quot;`.
1310 &quot;insertId&quot;: &quot;A String&quot;, # A unique ID for the log entry used for deduplication. If omitted,
1311 # the implementation will generate one based on operation_id.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1312 &quot;textPayload&quot;: &quot;A String&quot;, # The log entry payload, represented as a Unicode string (UTF-8).
1313 &quot;protoPayload&quot;: { # The log entry payload, represented as a protocol buffer that is
1314 # expressed as a JSON object. The only accepted type currently is
1315 # AuditLog.
1316 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1317 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1318 &quot;labels&quot;: { # A set of user-defined (key, value) data that provides additional
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1319 # information about the log entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1320 &quot;a_key&quot;: &quot;A String&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1321 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1322 &quot;trace&quot;: &quot;A String&quot;, # Optional. Resource name of the trace associated with the log entry, if any.
1323 # If this field contains a relative resource name, you can assume the name is
1324 # relative to `//tracing.googleapis.com`. Example:
1325 # `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1326 &quot;severity&quot;: &quot;A String&quot;, # The severity of the log entry. The default value is
1327 # `LogSeverity.DEFAULT`.
1328 &quot;sourceLocation&quot;: { # Additional information about the source code location that produced the log # Optional. Source code location information associated with the log entry,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1329 # if any.
1330 # entry.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1331 &quot;line&quot;: &quot;A String&quot;, # Optional. Line within the source file. 1-based; 0 indicates no line number
1332 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1333 &quot;file&quot;: &quot;A String&quot;, # Optional. Source file name. Depending on the runtime environment, this
1334 # might be a simple name or a fully-qualified name.
1335 &quot;function&quot;: &quot;A String&quot;, # Optional. Human-readable name of the function or method being invoked, with
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1336 # optional context such as the class or package name. This information may be
1337 # used in contexts such as the logs viewer, where a file and line number are
1338 # less meaningful. The format can vary by language. For example:
1339 # `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`
1340 # (Python).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1341 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1342 &quot;structPayload&quot;: { # The log entry payload, represented as a structure that
1343 # is expressed as a JSON object.
1344 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1345 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1346 &quot;timestamp&quot;: &quot;A String&quot;, # The time the event described by the log entry occurred. If
1347 # omitted, defaults to operation start time.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1348 },
1349 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1350 &quot;userLabels&quot;: { # User defined labels for the resource that this operation is associated
1351 # with. Only a combination of 1000 user labels per consumer project are
1352 # allowed.
1353 &quot;a_key&quot;: &quot;A String&quot;,
1354 },
1355 &quot;metricValueSets&quot;: [ # Represents information about this operation. Each MetricValueSet
1356 # corresponds to a metric defined in the service configuration.
1357 # The data type used in the MetricValueSet must agree with
1358 # the data type specified in the metric definition.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1359 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1360 # Within a single operation, it is not allowed to have more than one
1361 # MetricValue instances that have the same metric names and identical
1362 # label value combinations. If a request has such duplicated MetricValue
1363 # instances, the entire request is rejected with
1364 # an invalid argument error.
1365 { # Represents a set of metric values in the same metric.
1366 # Each metric value in the set should have a unique combination of start time,
1367 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1368 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1369 &quot;metricValues&quot;: [ # The values in this metric.
1370 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1371 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
1372 # applies. The time period has different semantics for different metric
1373 # types (cumulative, delta, and gauge). See the metric definition
1374 # documentation in the service configuration for details.
1375 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1376 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
1377 # The value must be between -999,999,999 and +999,999,999 inclusive.
1378 # If `units` is positive, `nanos` must be positive or zero.
1379 # If `units` is zero, `nanos` can be positive, zero, or negative.
1380 # If `units` is negative, `nanos` must be negative or zero.
1381 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1382 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
1383 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
1384 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1385 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1386 &quot;labels&quot;: { # The labels describing the metric value.
1387 # See comments on google.api.servicecontrol.v1.Operation.labels for
1388 # the overriding relationship.
1389 # Note that this map must not contain monitored resource labels.
1390 &quot;a_key&quot;: &quot;A String&quot;,
1391 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1392 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1393 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
1394 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
1395 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
1396 # points. It contains the size of the population of sample points plus
1397 # additional optional information:
1398 #
1399 # - the arithmetic mean of the samples
1400 # - the minimum and maximum of the samples
1401 # - the sum-squared-deviation of the samples, used to compute variance
1402 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1403 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
1404 # Sum[i=1..count]((x_i - mean)^2)
1405 # where each x_i is a sample values. If `count` is zero then this field
1406 # must be zero, otherwise validation of the request fails.
1407 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
1408 { # Exemplars are example points that may be used to annotate aggregated
1409 # distribution values. They are metadata that gives information about a
1410 # particular value added to a Distribution bucket, such as a trace ID that
1411 # was active when a value was added. They may contain further information,
1412 # such as a example values and timestamps, origin, etc.
1413 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
1414 # exemplar belongs.
1415 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
1416 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
1417 #
1418 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
1419 #
1420 # Literal string: type.googleapis.com/google.protobuf.StringValue
1421 #
1422 # Labels dropped during aggregation:
1423 # type.googleapis.com/google.monitoring.v3.DroppedLabels
1424 #
1425 # There may be only a single attachment of any given message type in a
1426 # single exemplar, and this is enforced by the system.
1427 {
1428 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1429 },
1430 ],
1431 },
1432 ],
1433 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
1434 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1435 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1436 # where i ranges from 1 to num_finite_buckets inclusive.
1437 # Must be larger than 1.0.
1438 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1439 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1440 # where i ranges from 1 to num_finite_buckets inclusive.
1441 # Must be &gt; 0.
1442 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1443 # the total number of buckets is `num_finite_buckets` + 2.
1444 # See comments on `bucket_options` for details.
1445 },
1446 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
1447 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1448 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1449 # the total number of buckets is `num_finite_buckets` + 2.
1450 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1451 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
1452 # [offset + (i-1) * width, offset + i * width)
1453 # where i ranges from 1 to num_finite_buckets, inclusive.
1454 # Must be strictly positive.
1455 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
1456 # [offset + (i-1) * width, offset + i * width)
1457 # where i ranges from 1 to num_finite_buckets, inclusive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1458 },
1459 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
1460 # zero then this field must be zero.
1461 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
1462 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
1463 # optional. If present, they must sum to the `count` value.
1464 #
1465 # The buckets are defined below in `bucket_option`. There are N buckets.
1466 # `bucket_counts[0]` is the number of samples in the underflow bucket.
1467 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
1468 # in each of the finite buckets. And `bucket_counts[N] is the number
1469 # of samples in the overflow bucket. See the comments of `bucket_option`
1470 # below for more details.
1471 #
1472 # Any suffix of trailing zeros may be omitted.
1473 &quot;A String&quot;,
1474 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1475 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
1476 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
1477 # buckets. Note that a list of length N-1 defines N buckets because
1478 # of fenceposting. See comments on `bucket_options` for details.
1479 #
1480 # The i&#x27;th finite bucket covers the interval
1481 # [bound[i-1], bound[i])
1482 # where i ranges from 1 to bound_size() - 1. Note that there are no
1483 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
1484 # that special case the single bound defines the boundary between the
1485 # underflow and overflow buckets.
1486 #
1487 # bucket number lower bound upper bound
1488 # i == 0 (underflow) -inf bound[i]
1489 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
1490 # i == bound_size() (overflow) bound[i-1] +inf
1491 3.14,
1492 ],
1493 },
1494 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1495 },
1496 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1497 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
1498 # applies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1499 },
1500 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1501 },
1502 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1503 &quot;traceSpans&quot;: [ # Unimplemented. A list of Cloud Trace spans. The span names shall contain
1504 # the id of the destination project which can be either the produce or the
1505 # consumer project.
1506 { # A span represents a single operation within a trace. Spans can be
1507 # nested to form a trace tree. Often, a trace contains a root span
1508 # that describes the end-to-end latency, and one or more subspans for
1509 # its sub-operations. A trace can also contain multiple root spans,
1510 # or none at all. Spans do not need to be contiguous&amp;mdash;there may be
1511 # gaps or overlaps between spans in a trace.
1512 &quot;childSpanCount&quot;: 42, # An optional number of child spans that were generated while this span
1513 # was active. If set, allows implementation to detect missing child spans.
1514 &quot;sameProcessAsParentSpan&quot;: True or False, # (Optional) Set this parameter to indicate whether this span is in
1515 # the same process as its parent. If you do not set this parameter,
1516 # Stackdriver Trace is unable to take advantage of this helpful
1517 # information.
1518 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # An optional final status for this span.
1519 # different programming environments, including REST APIs and RPC APIs. It is
1520 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1521 # three pieces of data: error code, error message, and error details.
1522 #
1523 # You can find out more about this error model and how to work with it in the
1524 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1525 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1526 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1527 # user-facing error message should be localized and sent in the
1528 # google.rpc.Status.details field, or localized by the client.
1529 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1530 # message types for APIs to use.
1531 {
1532 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1533 },
1534 ],
1535 },
1536 &quot;name&quot;: &quot;A String&quot;, # The resource name of the span in the following format:
1537 #
1538 # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;
1539 # it is a 32-character hexadecimal encoding of a 16-byte array.
1540 #
1541 # [SPAN_ID] is a unique identifier for a span within a trace; it
1542 # is a 16-character hexadecimal encoding of an 8-byte array.
1543 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per
1544 # span.
1545 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
1546 # because their keys are too long or because there are too many attributes.
1547 # If this value is 0 then all attributes are valid.
1548 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
1549 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
1550 # or the Boolean values `true` and `false`. For example:
1551 #
1552 # &quot;/instance_id&quot;: &quot;my-instance&quot;
1553 # &quot;/http/user_agent&quot;: &quot;&quot;
1554 # &quot;/http/request_bytes&quot;: 300
1555 # &quot;abc.com/myattribute&quot;: true
1556 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
1557 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
1558 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
1559 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
1560 # value is 0, then the string was not shortened.
1561 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
1562 # bytes long and the limit of the string is 128 bytes, then
1563 # `value` contains the first 128 bytes of the 500-byte string.
1564 #
1565 # Truncation always happens on a UTF8 character boundary. If there
1566 # are multi-byte characters in the string, then the length of the
1567 # shortened string might be less than the size limit.
1568 },
1569 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
1570 },
1571 },
1572 },
1573 &quot;spanId&quot;: &quot;A String&quot;, # The [SPAN_ID] portion of the span&#x27;s resource name.
1574 &quot;parentSpanId&quot;: &quot;A String&quot;, # The [SPAN_ID] of this span&#x27;s parent span. If this is a root span,
1575 # then this field must be empty.
1576 &quot;endTime&quot;: &quot;A String&quot;, # The end time of the span. On the client side, this is the time kept by
1577 # the local machine where the span execution ends. On the server side, this
1578 # is the time when the server application handler stops running.
1579 &quot;spanKind&quot;: &quot;A String&quot;, # Distinguishes between spans generated in a particular context. For example,
1580 # two spans with the same name may be distinguished using `CLIENT` (caller)
1581 # and `SERVER` (callee) to identify an RPC call.
1582 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the span. On the client side, this is the time kept by
1583 # the local machine where the span execution starts. On the server side, this
1584 # is the time when the server&#x27;s application handler starts running.
1585 &quot;displayName&quot;: { # Represents a string that might be shortened to a specified length. # A description of the span&#x27;s operation (up to 128 bytes).
1586 # Stackdriver Trace displays the description in the
1587 # Google Cloud Platform Console.
1588 # For example, the display name can be a qualified method name or a file name
1589 # and a line number where the operation is called. A best practice is to use
1590 # the same display name within an application and at the same call point.
1591 # This makes it easier to correlate spans in different traces.
1592 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
1593 # value is 0, then the string was not shortened.
1594 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
1595 # bytes long and the limit of the string is 128 bytes, then
1596 # `value` contains the first 128 bytes of the 500-byte string.
1597 #
1598 # Truncation always happens on a UTF8 character boundary. If there
1599 # are multi-byte characters in the string, then the length of the
1600 # shortened string might be less than the size limit.
1601 },
1602 },
1603 ],
1604 &quot;quotaProperties&quot;: { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this
1605 # operation is for a quota check request. If this is not specified, no quota
1606 # check will be performed.
1607 &quot;quotaMode&quot;: &quot;A String&quot;, # Quota mode for this operation.
1608 },
1609 &quot;consumerId&quot;: &quot;A String&quot;, # Identity of the consumer who is using the service.
1610 # This field should be filled in for the operations initiated by a
1611 # consumer, but not for service-initiated operations that are
1612 # not related to a specific consumer.
1613 #
1614 # - This can be in one of the following formats:
1615 # - project:PROJECT_ID,
1616 # - project`_`number:PROJECT_NUMBER,
1617 # - projects/PROJECT_ID or PROJECT_NUMBER,
1618 # - folders/FOLDER_NUMBER,
1619 # - organizations/ORGANIZATION_NUMBER,
1620 # - api`_`key:API_KEY.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1621 },
1622 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1623 &quot;serviceConfigId&quot;: &quot;A String&quot;, # Specifies which version of service config should be used to process the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1624 # request.
1625 #
1626 # If unspecified or no matching version can be found, the
1627 # latest one will be used.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1628 }
1629
1630 x__xgafv: string, V1 error format.
1631 Allowed values
1632 1 - v1 error format
1633 2 - v2 error format
1634
1635Returns:
1636 An object of the form:
1637
1638 { # Response message for the Report method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1639 &quot;serviceRolloutId&quot;: &quot;A String&quot;, # The current service rollout id used to process the request.
1640 &quot;reportInfos&quot;: [ # Quota usage for each quota release `Operation` request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1641 #
1642 # Fully or partially failed quota release request may or may not be present
1643 # in `report_quota_info`. For example, a failed quota release request will
1644 # have the current quota usage info when precise quota library returns the
1645 # info. A deadline exceeded quota request will not have quota usage info.
1646 #
1647 # If there is no quota release request, report_quota_info will be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1648 { # Contains additional info about the report operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1649 &quot;operationId&quot;: &quot;A String&quot;, # The Operation.operation_id value from the request.
1650 &quot;quotaInfo&quot;: { # Contains the quota information for a quota check response. # Quota usage info when processing the `Operation`.
1651 &quot;limitExceeded&quot;: [ # Quota Metrics that have exceeded quota limits.
1652 # For QuotaGroup-based quota, this is QuotaGroup.name
1653 # For QuotaLimit-based quota, this is QuotaLimit.name
1654 # See: google.api.Quota
1655 # Deprecated: Use quota_metrics to get per quota group limit exceeded status.
1656 &quot;A String&quot;,
1657 ],
1658 &quot;quotaConsumed&quot;: { # Map of quota group name to the actual number of tokens consumed. If the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1659 # quota check was not successful, then this will not be populated due to no
1660 # quota consumption.
1661 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1662 # We are not merging this field with &#x27;quota_metrics&#x27; field because of the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1663 # complexity of scaling in Chemist client code base. For simplicity, we will
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1664 # keep this field for Castor (that scales quota usage) and &#x27;quota_metrics&#x27;
1665 # for SuperQuota (that doesn&#x27;t scale quota usage).
1666 &quot;a_key&quot;: 42,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1667 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1668 &quot;quotaMetrics&quot;: [ # Quota metrics to indicate the usage. Depending on the check request, one or
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1669 # more of the following metrics will be included:
1670 #
1671 # 1. For rate quota, per quota group or per quota metric incremental usage
1672 # will be specified using the following delta metric:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1673 # &quot;serviceruntime.googleapis.com/api/consumer/quota_used_count&quot;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1674 #
1675 # 2. For allocation quota, per quota metric total usage will be specified
1676 # using the following gauge metric:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1677 # &quot;serviceruntime.googleapis.com/allocation/consumer/quota_used_count&quot;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1678 #
1679 # 3. For both rate quota and allocation quota, the quota limit reached
1680 # condition will be specified using the following boolean metric:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1681 # &quot;serviceruntime.googleapis.com/quota/exceeded&quot;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1682 { # Represents a set of metric values in the same metric.
1683 # Each metric value in the set should have a unique combination of start time,
1684 # end time, and label values.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1685 &quot;metricName&quot;: &quot;A String&quot;, # The metric name defined in the service configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1686 &quot;metricValues&quot;: [ # The values in this metric.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1687 { # Represents a single metric value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1688 &quot;startTime&quot;: &quot;A String&quot;, # The start of the time period over which this metric value&#x27;s measurement
1689 # applies. The time period has different semantics for different metric
1690 # types (cumulative, delta, and gauge). See the metric definition
1691 # documentation in the service configuration for details.
1692 &quot;moneyValue&quot;: { # Represents an amount of money with its currency type. # A money value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1693 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1694 # The value must be between -999,999,999 and +999,999,999 inclusive.
1695 # If `units` is positive, `nanos` must be positive or zero.
1696 # If `units` is zero, `nanos` can be positive, zero, or negative.
1697 # If `units` is negative, `nanos` must be negative or zero.
1698 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1699 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount.
1700 # For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
1701 &quot;currencyCode&quot;: &quot;A String&quot;, # The 3-letter currency code defined in ISO 4217.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1702 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1703 &quot;labels&quot;: { # The labels describing the metric value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1704 # See comments on google.api.servicecontrol.v1.Operation.labels for
1705 # the overriding relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1706 # Note that this map must not contain monitored resource labels.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1707 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1708 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1709 &quot;stringValue&quot;: &quot;A String&quot;, # A text string value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1710 &quot;doubleValue&quot;: 3.14, # A double precision floating point value.
1711 &quot;int64Value&quot;: &quot;A String&quot;, # A signed 64-bit integer value.
1712 &quot;distributionValue&quot;: { # Distribution represents a frequency distribution of double-valued sample # A distribution value.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1713 # points. It contains the size of the population of sample points plus
1714 # additional optional information:
1715 #
1716 # - the arithmetic mean of the samples
1717 # - the minimum and maximum of the samples
1718 # - the sum-squared-deviation of the samples, used to compute variance
1719 # - a histogram of the values of the sample points
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1720 &quot;sumOfSquaredDeviation&quot;: 3.14, # The sum of squared deviations from the mean:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1721 # Sum[i=1..count]((x_i - mean)^2)
1722 # where each x_i is a sample values. If `count` is zero then this field
1723 # must be zero, otherwise validation of the request fails.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1724 &quot;exemplars&quot;: [ # Example points. Must be in increasing order of `value` field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1725 { # Exemplars are example points that may be used to annotate aggregated
1726 # distribution values. They are metadata that gives information about a
1727 # particular value added to a Distribution bucket, such as a trace ID that
1728 # was active when a value was added. They may contain further information,
1729 # such as a example values and timestamps, origin, etc.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1730 &quot;value&quot;: 3.14, # Value of the exemplar point. This value determines to which bucket the
1731 # exemplar belongs.
1732 &quot;timestamp&quot;: &quot;A String&quot;, # The observation (sampling) time of the above value.
1733 &quot;attachments&quot;: [ # Contextual information about the example value. Examples are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1734 #
1735 # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
1736 #
1737 # Literal string: type.googleapis.com/google.protobuf.StringValue
1738 #
1739 # Labels dropped during aggregation:
1740 # type.googleapis.com/google.monitoring.v3.DroppedLabels
1741 #
1742 # There may be only a single attachment of any given message type in a
1743 # single exemplar, and this is enforced by the system.
1744 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1745 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1746 },
1747 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1748 },
1749 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1750 &quot;exponentialBuckets&quot;: { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.
1751 &quot;growthFactor&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1752 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1753 # where i ranges from 1 to num_finite_buckets inclusive.
1754 # Must be larger than 1.0.
1755 &quot;scale&quot;: 3.14, # The i&#x27;th exponential bucket covers the interval
1756 # [scale * growth_factor^(i-1), scale * growth_factor^i)
1757 # where i ranges from 1 to num_finite_buckets inclusive.
1758 # Must be &gt; 0.
1759 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1760 # the total number of buckets is `num_finite_buckets` + 2.
1761 # See comments on `bucket_options` for details.
1762 },
1763 &quot;minimum&quot;: 3.14, # The minimum of the population of values. Ignored if `count` is zero.
1764 &quot;linearBuckets&quot;: { # Describing buckets with constant width. # Buckets with constant width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1765 &quot;numFiniteBuckets&quot;: 42, # The number of finite buckets. With the underflow and overflow buckets,
1766 # the total number of buckets is `num_finite_buckets` + 2.
1767 # See comments on `bucket_options` for details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1768 &quot;width&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1769 # [offset + (i-1) * width, offset + i * width)
1770 # where i ranges from 1 to num_finite_buckets, inclusive.
1771 # Must be strictly positive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1772 &quot;offset&quot;: 3.14, # The i&#x27;th linear bucket covers the interval
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1773 # [offset + (i-1) * width, offset + i * width)
1774 # where i ranges from 1 to num_finite_buckets, inclusive.
1775 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1776 &quot;mean&quot;: 3.14, # The arithmetic mean of the samples in the distribution. If `count` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1777 # zero then this field must be zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1778 &quot;count&quot;: &quot;A String&quot;, # The total number of samples in the distribution. Must be &gt;= 0.
1779 &quot;bucketCounts&quot;: [ # The number of samples in each histogram bucket. `bucket_counts` are
1780 # optional. If present, they must sum to the `count` value.
1781 #
1782 # The buckets are defined below in `bucket_option`. There are N buckets.
1783 # `bucket_counts[0]` is the number of samples in the underflow bucket.
1784 # `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
1785 # in each of the finite buckets. And `bucket_counts[N] is the number
1786 # of samples in the overflow bucket. See the comments of `bucket_option`
1787 # below for more details.
1788 #
1789 # Any suffix of trailing zeros may be omitted.
1790 &quot;A String&quot;,
1791 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1792 &quot;explicitBuckets&quot;: { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.
1793 &quot;bounds&quot;: [ # &#x27;bound&#x27; is a list of strictly increasing boundaries between
1794 # buckets. Note that a list of length N-1 defines N buckets because
1795 # of fenceposting. See comments on `bucket_options` for details.
1796 #
1797 # The i&#x27;th finite bucket covers the interval
1798 # [bound[i-1], bound[i])
1799 # where i ranges from 1 to bound_size() - 1. Note that there are no
1800 # finite buckets at all if &#x27;bound&#x27; only contains a single element; in
1801 # that special case the single bound defines the boundary between the
1802 # underflow and overflow buckets.
1803 #
1804 # bucket number lower bound upper bound
1805 # i == 0 (underflow) -inf bound[i]
1806 # 0 &lt; i &lt; bound_size() bound[i-1] bound[i]
1807 # i == bound_size() (overflow) bound[i-1] +inf
1808 3.14,
1809 ],
1810 },
1811 &quot;maximum&quot;: 3.14, # The maximum of the population of values. Ignored if `count` is zero.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1812 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1813 &quot;boolValue&quot;: True or False, # A boolean value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1814 &quot;endTime&quot;: &quot;A String&quot;, # The end of the time period over which this metric value&#x27;s measurement
1815 # applies.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1816 },
1817 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1818 },
1819 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1820 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1821 },
1822 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1823 &quot;serviceConfigId&quot;: &quot;A String&quot;, # The actual config id used to process the request.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]1824 &quot;reportErrors&quot;: [ # Partial failures, one for each `Operation` in the request that failed
1825 # processing. There are three possible combinations of the RPC status:
1826 #
1827 # 1. The combination of a successful RPC status and an empty `report_errors`
1828 # list indicates a complete success where all `Operations` in the
1829 # request are processed successfully.
1830 # 2. The combination of a successful RPC status and a non-empty
1831 # `report_errors` list indicates a partial success where some
1832 # `Operations` in the request succeeded. Each
1833 # `Operation` that failed processing has a corresponding item
1834 # in this list.
1835 # 3. A failed RPC status indicates a general non-deterministic failure.
1836 # When this happens, it&#x27;s impossible to know which of the
1837 # &#x27;Operations&#x27; in the request succeeded or failed.
1838 { # Represents the processing error of one Operation in the request.
1839 &quot;operationId&quot;: &quot;A String&quot;, # The Operation.operation_id value from the request.
1840 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Details of the error when processing the Operation.
1841 # different programming environments, including REST APIs and RPC APIs. It is
1842 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1843 # three pieces of data: error code, error message, and error details.
1844 #
1845 # You can find out more about this error model and how to work with it in the
1846 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1847 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1848 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1849 # user-facing error message should be localized and sent in the
1850 # google.rpc.Status.details field, or localized by the client.
1851 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1852 # message types for APIs to use.
1853 {
1854 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1855 },
1856 ],
1857 },
1858 },
1859 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1860 }</pre>
1861</div>
1862
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1863</body></html>