Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / servicemanagement_v1.services.html
blob: 3e4049cc969cf8ecac74fe7530ba776dea256e08 [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="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_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">
78 <code><a href="servicemanagement_v1.services.configs.html">configs()</a></code>
79</p>
80<p class="firstline">Returns the configs Resource.</p>
81
82<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]83 <code><a href="servicemanagement_v1.services.consumers.html">consumers()</a></code>
84</p>
85<p class="firstline">Returns the consumers Resource.</p>
86
87<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]88 <code><a href="servicemanagement_v1.services.rollouts.html">rollouts()</a></code>
89</p>
90<p class="firstline">Returns the rollouts Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
94<p class="firstline">Creates a new managed service.</p>
95<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]96 <code><a href="#delete">delete(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]97<p class="firstline">Deletes a managed service. This method will change the service to the</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code><a href="#disable">disable(serviceName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100<p class="firstline">Disables a service for a project, so it can no longer be</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]102 <code><a href="#enable">enable(serviceName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103<p class="firstline">Enables a service for a project, so it can be used</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#generateConfigReport">generateConfigReport(body, x__xgafv=None)</a></code></p>
106<p class="firstline">Generates and returns a report (errors, warnings and changes from</p>
107<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]108 <code><a href="#get">get(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]109<p class="firstline">Gets a managed service. Authentication is required unless the service is</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]110<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]111 <code><a href="#getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]112<p class="firstline">Gets a service configuration (version) for a managed service.</p>
113<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]114 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115<p class="firstline">Gets the access control policy for a resource.</p>
116<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]117 <code><a href="#list">list(producerProjectId=None, pageSize=None, pageToken=None, consumerId=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]118<p class="firstline">Lists managed services.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]119<p class="toc_element">
120 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
121<p class="firstline">Retrieves the next page of results.</p>
122<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]123 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]124<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
125<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]126 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]127<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
128<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]129 <code><a href="#undelete">undelete(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]130<p class="firstline">Revives a previously deleted managed service. The method restores the</p>
131<h3>Method Details</h3>
132<div class="method">
133 <code class="details" id="create">create(body, x__xgafv=None)</code>
134 <pre>Creates a new managed service.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]135Please note one producer project can own no more than 20 services.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136
137Operation<response: ManagedService>
138
139Args:
140 body: object, The request body. (required)
141 The object takes the form of:
142
143{ # The full representation of a Service that is managed by
144 # Google Service Management.
145 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
146 # for naming requirements.
147 "producerProjectId": "A String", # ID of the project that produces and owns this service.
148}
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155Returns:
156 An object of the form:
157
158 { # This resource represents a long-running operation that is the result of a
159 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160 "response": { # The normal response of the operation in case of success. If the original
161 # method returns no data on success, such as `Delete`, the response is
162 # `google.protobuf.Empty`. If the original method is standard
163 # `Get`/`Create`/`Update`, the response should be the resource. For other
164 # methods, the response should have the type `XxxResponse`, where `Xxx`
165 # is the original method name. For example, if the original method name
166 # is `TakeSnapshot()`, the inferred response type is
167 # `TakeSnapshotResponse`.
168 "a_key": "", # Properties of the object. Contains field @type with type URL.
169 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]170 "metadata": { # Service-specific metadata associated with the operation. It typically
171 # contains progress information and common metadata such as create time.
172 # Some services might not provide such metadata. Any method that returns a
173 # long-running operation should document the metadata type, if any.
174 "a_key": "", # Properties of the object. Contains field @type with type URL.
175 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]176 "done": True or False, # If the value is `false`, it means the operation is still in progress.
177 # If `true`, the operation is completed, and either `error` or `response` is
178 # available.
179 "name": "A String", # The server-assigned name, which is only unique within the same service that
180 # originally returns it. If you use the default HTTP mapping, the
181 # `name` should be a resource name ending with `operations/{unique_id}`.
182 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
183 # different programming environments, including REST APIs and RPC APIs. It is
184 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
185 # three pieces of data: error code, error message, and error details.
186 #
187 # You can find out more about this error model and how to work with it in the
188 # [API Design Guide](https://cloud.google.com/apis/design/errors).
189 "message": "A String", # A developer-facing error message, which should be in English. Any
190 # user-facing error message should be localized and sent in the
191 # google.rpc.Status.details field, or localized by the client.
192 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
193 "details": [ # A list of messages that carry the error details. There is a common set of
194 # message types for APIs to use.
195 {
196 "a_key": "", # Properties of the object. Contains field @type with type URL.
197 },
198 ],
199 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]200 }</pre>
201</div>
202
203<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]204 <code class="details" id="delete">delete(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]205 <pre>Deletes a managed service. This method will change the service to the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]206`Soft-Delete` state for 30 days. Within this period, service producers may
207call UndeleteService to restore the service.
208After 30 days, the service will be permanently deleted.
209
210Operation<response: google.protobuf.Empty>
211
212Args:
213 serviceName: string, The name of the service. See the [overview](/service-management/overview)
214for naming requirements. For example: `example.googleapis.com`. (required)
215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220Returns:
221 An object of the form:
222
223 { # This resource represents a long-running operation that is the result of a
224 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]225 "response": { # The normal response of the operation in case of success. If the original
226 # method returns no data on success, such as `Delete`, the response is
227 # `google.protobuf.Empty`. If the original method is standard
228 # `Get`/`Create`/`Update`, the response should be the resource. For other
229 # methods, the response should have the type `XxxResponse`, where `Xxx`
230 # is the original method name. For example, if the original method name
231 # is `TakeSnapshot()`, the inferred response type is
232 # `TakeSnapshotResponse`.
233 "a_key": "", # Properties of the object. Contains field @type with type URL.
234 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]235 "metadata": { # Service-specific metadata associated with the operation. It typically
236 # contains progress information and common metadata such as create time.
237 # Some services might not provide such metadata. Any method that returns a
238 # long-running operation should document the metadata type, if any.
239 "a_key": "", # Properties of the object. Contains field @type with type URL.
240 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]241 "done": True or False, # If the value is `false`, it means the operation is still in progress.
242 # If `true`, the operation is completed, and either `error` or `response` is
243 # available.
244 "name": "A String", # The server-assigned name, which is only unique within the same service that
245 # originally returns it. If you use the default HTTP mapping, the
246 # `name` should be a resource name ending with `operations/{unique_id}`.
247 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
248 # different programming environments, including REST APIs and RPC APIs. It is
249 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
250 # three pieces of data: error code, error message, and error details.
251 #
252 # You can find out more about this error model and how to work with it in the
253 # [API Design Guide](https://cloud.google.com/apis/design/errors).
254 "message": "A String", # A developer-facing error message, which should be in English. Any
255 # user-facing error message should be localized and sent in the
256 # google.rpc.Status.details field, or localized by the client.
257 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
258 "details": [ # A list of messages that carry the error details. There is a common set of
259 # message types for APIs to use.
260 {
261 "a_key": "", # Properties of the object. Contains field @type with type URL.
262 },
263 ],
264 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]269 <code class="details" id="disable">disable(serviceName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]270 <pre>Disables a service for a project, so it can no longer be
271be used for the project. It prevents accidental usage that may cause
272unexpected billing charges or security leaks.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]273
274Operation<response: DisableServiceResponse>
275
276Args:
277 serviceName: string, Name of the service to disable. Specifying an unknown service name
278will cause the request to fail. (required)
279 body: object, The request body. (required)
280 The object takes the form of:
281
282{ # Request message for DisableService method.
283 "consumerId": "A String", # The identity of consumer resource which service disablement will be
284 # applied to.
285 #
286 # The Google Service Management implementation accepts the following
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]287 # forms:
288 # - "project:<project_id>"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]289 #
290 # Note: this is made compatible with
291 # google.api.servicecontrol.v1.Operation.consumer_id.
292 }
293
294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
298
299Returns:
300 An object of the form:
301
302 { # This resource represents a long-running operation that is the result of a
303 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]304 "response": { # The normal response of the operation in case of success. If the original
305 # method returns no data on success, such as `Delete`, the response is
306 # `google.protobuf.Empty`. If the original method is standard
307 # `Get`/`Create`/`Update`, the response should be the resource. For other
308 # methods, the response should have the type `XxxResponse`, where `Xxx`
309 # is the original method name. For example, if the original method name
310 # is `TakeSnapshot()`, the inferred response type is
311 # `TakeSnapshotResponse`.
312 "a_key": "", # Properties of the object. Contains field @type with type URL.
313 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]314 "metadata": { # Service-specific metadata associated with the operation. It typically
315 # contains progress information and common metadata such as create time.
316 # Some services might not provide such metadata. Any method that returns a
317 # long-running operation should document the metadata type, if any.
318 "a_key": "", # Properties of the object. Contains field @type with type URL.
319 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]320 "done": True or False, # If the value is `false`, it means the operation is still in progress.
321 # If `true`, the operation is completed, and either `error` or `response` is
322 # available.
323 "name": "A String", # The server-assigned name, which is only unique within the same service that
324 # originally returns it. If you use the default HTTP mapping, the
325 # `name` should be a resource name ending with `operations/{unique_id}`.
326 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
327 # different programming environments, including REST APIs and RPC APIs. It is
328 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
329 # three pieces of data: error code, error message, and error details.
330 #
331 # You can find out more about this error model and how to work with it in the
332 # [API Design Guide](https://cloud.google.com/apis/design/errors).
333 "message": "A String", # A developer-facing error message, which should be in English. Any
334 # user-facing error message should be localized and sent in the
335 # google.rpc.Status.details field, or localized by the client.
336 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
337 "details": [ # A list of messages that carry the error details. There is a common set of
338 # message types for APIs to use.
339 {
340 "a_key": "", # Properties of the object. Contains field @type with type URL.
341 },
342 ],
343 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]344 }</pre>
345</div>
346
347<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]348 <code class="details" id="enable">enable(serviceName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]349 <pre>Enables a service for a project, so it can be used
350for the project. See
351[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
352more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]353
354Operation<response: EnableServiceResponse>
355
356Args:
357 serviceName: string, Name of the service to enable. Specifying an unknown service name will
358cause the request to fail. (required)
359 body: object, The request body. (required)
360 The object takes the form of:
361
362{ # Request message for EnableService method.
363 "consumerId": "A String", # The identity of consumer resource which service enablement will be
364 # applied to.
365 #
366 # The Google Service Management implementation accepts the following
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]367 # forms:
368 # - "project:<project_id>"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]369 #
370 # Note: this is made compatible with
371 # google.api.servicecontrol.v1.Operation.consumer_id.
372 }
373
374 x__xgafv: string, V1 error format.
375 Allowed values
376 1 - v1 error format
377 2 - v2 error format
378
379Returns:
380 An object of the form:
381
382 { # This resource represents a long-running operation that is the result of a
383 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]384 "response": { # The normal response of the operation in case of success. If the original
385 # method returns no data on success, such as `Delete`, the response is
386 # `google.protobuf.Empty`. If the original method is standard
387 # `Get`/`Create`/`Update`, the response should be the resource. For other
388 # methods, the response should have the type `XxxResponse`, where `Xxx`
389 # is the original method name. For example, if the original method name
390 # is `TakeSnapshot()`, the inferred response type is
391 # `TakeSnapshotResponse`.
392 "a_key": "", # Properties of the object. Contains field @type with type URL.
393 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]394 "metadata": { # Service-specific metadata associated with the operation. It typically
395 # contains progress information and common metadata such as create time.
396 # Some services might not provide such metadata. Any method that returns a
397 # long-running operation should document the metadata type, if any.
398 "a_key": "", # Properties of the object. Contains field @type with type URL.
399 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]400 "done": True or False, # If the value is `false`, it means the operation is still in progress.
401 # If `true`, the operation is completed, and either `error` or `response` is
402 # available.
403 "name": "A String", # The server-assigned name, which is only unique within the same service that
404 # originally returns it. If you use the default HTTP mapping, the
405 # `name` should be a resource name ending with `operations/{unique_id}`.
406 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
407 # different programming environments, including REST APIs and RPC APIs. It is
408 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
409 # three pieces of data: error code, error message, and error details.
410 #
411 # You can find out more about this error model and how to work with it in the
412 # [API Design Guide](https://cloud.google.com/apis/design/errors).
413 "message": "A String", # A developer-facing error message, which should be in English. Any
414 # user-facing error message should be localized and sent in the
415 # google.rpc.Status.details field, or localized by the client.
416 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
417 "details": [ # A list of messages that carry the error details. There is a common set of
418 # message types for APIs to use.
419 {
420 "a_key": "", # Properties of the object. Contains field @type with type URL.
421 },
422 ],
423 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]424 }</pre>
425</div>
426
427<div class="method">
428 <code class="details" id="generateConfigReport">generateConfigReport(body, x__xgafv=None)</code>
429 <pre>Generates and returns a report (errors, warnings and changes from
430existing configurations) associated with
431GenerateConfigReportRequest.new_value
432
433If GenerateConfigReportRequest.old_value is specified,
434GenerateConfigReportRequest will contain a single ChangeReport based on the
435comparison between GenerateConfigReportRequest.new_value and
436GenerateConfigReportRequest.old_value.
437If GenerateConfigReportRequest.old_value is not specified, this method
438will compare GenerateConfigReportRequest.new_value with the last pushed
439service configuration.
440
441Args:
442 body: object, The request body. (required)
443 The object takes the form of:
444
445{ # Request message for GenerateConfigReport method.
446 "newConfig": { # Service configuration for which we want to generate the report.
447 # For this version of API, the supported types are
448 # google.api.servicemanagement.v1.ConfigRef,
449 # google.api.servicemanagement.v1.ConfigSource,
450 # and google.api.Service
451 "a_key": "", # Properties of the object. Contains field @type with type URL.
452 },
453 "oldConfig": { # Service configuration against which the comparison will be done.
454 # For this version of API, the supported types are
455 # google.api.servicemanagement.v1.ConfigRef,
456 # google.api.servicemanagement.v1.ConfigSource,
457 # and google.api.Service
458 "a_key": "", # Properties of the object. Contains field @type with type URL.
459 },
460 }
461
462 x__xgafv: string, V1 error format.
463 Allowed values
464 1 - v1 error format
465 2 - v2 error format
466
467Returns:
468 An object of the form:
469
470 { # Response message for GenerateConfigReport method.
471 "serviceName": "A String", # Name of the service this report belongs to.
472 "changeReports": [ # list of ChangeReport, each corresponding to comparison between two
473 # service configurations.
474 { # Change report associated with a particular service configuration.
475 #
476 # It contains a list of ConfigChanges based on the comparison between
477 # two service configurations.
478 "configChanges": [ # List of changes between two service configurations.
479 # The changes will be alphabetically sorted based on the identifier
480 # of each change.
481 # A ConfigChange identifier is a dot separated path to the configuration.
482 # Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
483 { # Output generated from semantically comparing two versions of a service
484 # configuration.
485 #
486 # Includes detailed information about a field that have changed with
487 # applicable advice about potential consequences for the change, such as
488 # backwards-incompatibility.
489 "advices": [ # Collection of advice provided for this change, useful for determining the
490 # possible impact of this change.
491 { # Generated advice about this change, used for providing more
492 # information about how a change will affect the existing service.
493 "description": "A String", # Useful description for why this advice was applied and what actions should
494 # be taken to mitigate any implied risks.
495 },
496 ],
497 "changeType": "A String", # The type for this change, either ADDED, REMOVED, or MODIFIED.
498 "newValue": "A String", # Value of the changed object in the new Service configuration,
499 # in JSON format. This field will not be populated if ChangeType == REMOVED.
500 "oldValue": "A String", # Value of the changed object in the old Service configuration,
501 # in JSON format. This field will not be populated if ChangeType == ADDED.
502 "element": "A String", # Object hierarchy path to the change, with levels separated by a '.'
503 # character. For repeated fields, an applicable unique identifier field is
504 # used for the index (usually selector, name, or id). For maps, the term
505 # 'key' is used. If the field has no unique identifier, the numeric index
506 # is used.
507 # Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]508 # - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]509 # - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
510 # - logging.producer_destinations[0]
511 },
512 ],
513 },
514 ],
515 "id": "A String", # ID of the service configuration this report belongs to.
516 "diagnostics": [ # Errors / Linter warnings associated with the service definition this
517 # report
518 # belongs to.
519 { # Represents a diagnostic message (error or warning)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]520 "kind": "A String", # The kind of diagnostic information provided.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]521 "message": "A String", # Message describing the error or warning.
522 "location": "A String", # File name and line number of the error or warning.
523 },
524 ],
525 }</pre>
526</div>
527
528<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]529 <code class="details" id="get">get(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]530 <pre>Gets a managed service. Authentication is required unless the service is
531public.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]532
533Args:
534 serviceName: string, The name of the service. See the `ServiceManager` overview for naming
535requirements. For example: `example.googleapis.com`. (required)
536 x__xgafv: string, V1 error format.
537 Allowed values
538 1 - v1 error format
539 2 - v2 error format
540
541Returns:
542 An object of the form:
543
544 { # The full representation of a Service that is managed by
545 # Google Service Management.
546 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
547 # for naming requirements.
548 "producerProjectId": "A String", # ID of the project that produces and owns this service.
549 }</pre>
550</div>
551
552<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]553 <code class="details" id="getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]554 <pre>Gets a service configuration (version) for a managed service.
555
556Args:
557 serviceName: string, The name of the service. See the [overview](/service-management/overview)
558for naming requirements. For example: `example.googleapis.com`. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]559 configId: string, The id of the service configuration resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]560
561This field must be specified for the server to return all fields, including
562`SourceInfo`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]563 x__xgafv: string, V1 error format.
564 Allowed values
565 1 - v1 error format
566 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]567 view: string, Specifies which parts of the Service Config should be returned in the
568response.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]569
570Returns:
571 An object of the form:
572
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]573 { # `Service` is the root object of Google service configuration schema. It
574 # describes basic information about a service, such as the name and the
575 # title, and delegates other aspects to sub-sections. Each sub-section is
576 # either a proto message or a repeated proto message that configures a
577 # specific aspect, such as auth. See each proto message definition for details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]578 #
579 # Example:
580 #
581 # type: google.api.Service
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]582 # config_version: 3
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]583 # name: calendar.googleapis.com
584 # title: Google Calendar API
585 # apis:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]586 # - name: google.calendar.v3.Calendar
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]587 # authentication:
588 # providers:
589 # - id: google_calendar_auth
590 # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
591 # issuer: https://securetoken.google.com
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]592 # rules:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]593 # - selector: "*"
594 # requirements:
595 # provider_id: google_calendar_auth
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]596 "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
597 # service controller handles features like abuse, quota, billing, logging,
598 # monitoring, etc.
599 "environment": "A String", # The service control environment to use. If empty, no control plane
600 # feature (like quota and billing) will be enabled.
601 },
602 "monitoredResources": [ # Defines the monitored resources used by this service. This is required
603 # by the Service.monitoring and Service.logging configurations.
604 { # An object that describes the schema of a MonitoredResource object using a
605 # type name and a set of labels. For example, the monitored resource
606 # descriptor for Google Compute Engine VM instances has a type of
607 # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
608 # `"zone"` to identify particular VM instances.
609 #
610 # Different APIs can support different monitored resource types. APIs generally
611 # provide a `list` method that returns the monitored resource descriptors used
612 # by the API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]613 #
614 # Next ID: 10
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]615 "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
616 # displayed in user interfaces. It should be a Title Cased Noun Phrase,
617 # without any article or other determiners. For example,
618 # `"Google Cloud SQL Database"`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]619 "name": "A String", # Optional. The resource name of the monitored resource descriptor:
620 # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
621 # {type} is the value of the `type` field in this object and
622 # {project_id} is a project ID that provides API-specific context for
623 # accessing the type. APIs that do not use project information can use the
624 # resource name format `"monitoredResourceDescriptors/{type}"`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]625 "labels": [ # Required. A set of labels used to describe instances of this monitored
626 # resource type. For example, an individual Google Cloud SQL database is
627 # identified by values for the labels `"database_id"` and `"zone"`.
628 { # A description of a label.
629 "valueType": "A String", # The type of data that can be assigned to the label.
630 "description": "A String", # A human-readable description for the label.
631 "key": "A String", # The label key.
632 },
633 ],
634 "launchStage": "A String", # Optional. The launch stage of the monitored resource definition.
635 "type": "A String", # Required. The monitored resource type. For example, the type
636 # `"cloudsql_database"` represents databases in Google Cloud SQL.
637 # The maximum length of this value is 256 characters.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]638 "description": "A String", # Optional. A detailed description of the monitored resource type that might
639 # be used in documentation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]640 },
641 ],
642 "logs": [ # Defines the logs used by this service.
643 { # A description of a log type. Example in YAML format:
644 #
645 # - name: library.googleapis.com/activity_history
646 # description: The history of borrowing and returning library items.
647 # display_name: Activity
648 # labels:
649 # - key: /customer_id
650 # description: Identifier of a library customer
651 "labels": [ # The set of labels that are available to describe a specific log entry.
652 # Runtime requests that contain labels not specified here are
653 # considered invalid.
654 { # A description of a label.
655 "valueType": "A String", # The type of data that can be assigned to the label.
656 "description": "A String", # A human-readable description for the label.
657 "key": "A String", # The label key.
658 },
659 ],
660 "displayName": "A String", # The human-readable name for this log. This information appears on
661 # the user interface and should be concise.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]662 "name": "A String", # The name of the log. It must be less than 512 characters long and can
663 # include the following characters: upper- and lower-case alphanumeric
664 # characters [A-Za-z0-9], and punctuation characters including
665 # slash, underscore, hyphen, period [/_-.].
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]666 "description": "A String", # A human-readable description of this log. This information appears in
667 # the documentation and can contain details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]668 },
669 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]670 "systemParameters": { # ### System parameter configuration # System parameter configuration.
671 #
672 # A system parameter is a special kind of parameter defined by the API
673 # system, not by an individual API. It is typically mapped to an HTTP header
674 # and/or a URL query parameter. This configuration specifies which methods
675 # change the names of the system parameters.
676 "rules": [ # Define system parameters.
677 #
678 # The parameters defined here will override the default parameters
679 # implemented by the system. If this field is missing from the service
680 # config, default system parameters will be used. Default system parameters
681 # and names is implementation-dependent.
682 #
683 # Example: define api key for all methods
684 #
685 # system_parameters
686 # rules:
687 # - selector: "*"
688 # parameters:
689 # - name: api_key
690 # url_query_parameter: api_key
691 #
692 #
693 # Example: define 2 api key names for a specific method.
694 #
695 # system_parameters
696 # rules:
697 # - selector: "/ListShelves"
698 # parameters:
699 # - name: api_key
700 # http_header: Api-Key1
701 # - name: api_key
702 # http_header: Api-Key2
703 #
704 # **NOTE:** All service configuration rules follow "last one wins" order.
705 { # Define a system parameter rule mapping system parameter definitions to
706 # methods.
707 "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
708 # For a given method call, only one of them should be used. If multiple
709 # names are used the behavior is implementation-dependent.
710 # If none of the specified names are present the behavior is
711 # parameter-dependent.
712 { # Define a parameter's name and location. The parameter may be passed as either
713 # an HTTP header or a URL query parameter, and if both are passed the behavior
714 # is implementation-dependent.
715 "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
716 # sensitive.
717 "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
718 # insensitive.
719 "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
720 },
721 ],
722 "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
723 # methods in all APIs.
724 #
725 # Refer to selector for syntax details.
726 },
727 ],
728 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]729 "id": "A String", # A unique ID for a specific instance of this message, typically assigned
730 # by the client for tracking purpose. If empty, the server may choose to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]731 # generate one instead. Must be no longer than 60 characters.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]732 "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
733 "rules": [ # A list of API backend rules that apply to individual API methods.
734 #
735 # **NOTE:** All service configuration rules follow "last one wins" order.
736 { # A backend rule provides configuration for an individual API element.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]737 "jwtAudience": "A String", # The JWT audience is used when generating a JWT id token for the backend.
738 "pathTranslation": "A String",
739 "minDeadline": 3.14, # Minimum deadline in seconds needed for this method. Calls having deadline
740 # value lower than this will be rejected.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]741 "selector": "A String", # Selects the methods to which this rule applies.
742 #
743 # Refer to selector for syntax details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]744 "operationDeadline": 3.14, # The number of seconds to wait for the completion of a long running
745 # operation. The default is no deadline.
746 "deadline": 3.14, # The number of seconds to wait for a response from a request. The default
747 # deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]748 "address": "A String", # The address of the API backend.
749 },
750 ],
751 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]752 "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]753 #
754 # The example below shows how to configure monitored resources and metrics
755 # for monitoring. In the example, a monitored resource and two metrics are
756 # defined. The `library.googleapis.com/book/returned_count` metric is sent
757 # to both producer and consumer projects, whereas the
758 # `library.googleapis.com/book/overdue_count` metric is only sent to the
759 # consumer project.
760 #
761 # monitored_resources:
762 # - type: library.googleapis.com/branch
763 # labels:
764 # - key: /city
765 # description: The city where the library branch is located in.
766 # - key: /name
767 # description: The name of the branch.
768 # metrics:
769 # - name: library.googleapis.com/book/returned_count
770 # metric_kind: DELTA
771 # value_type: INT64
772 # labels:
773 # - key: /customer_id
774 # - name: library.googleapis.com/book/overdue_count
775 # metric_kind: GAUGE
776 # value_type: INT64
777 # labels:
778 # - key: /customer_id
779 # monitoring:
780 # producer_destinations:
781 # - monitored_resource: library.googleapis.com/branch
782 # metrics:
783 # - library.googleapis.com/book/returned_count
784 # consumer_destinations:
785 # - monitored_resource: library.googleapis.com/branch
786 # metrics:
787 # - library.googleapis.com/book/returned_count
788 # - library.googleapis.com/book/overdue_count
789 "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]790 # There can be multiple producer destinations. A monitored resouce type may
791 # appear in multiple monitoring destinations if different aggregations are
792 # needed for different sets of metrics associated with that monitored
793 # resource type. A monitored resource and metric pair may only be used once
794 # in the Monitoring configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]795 { # Configuration of a specific monitoring destination (the producer project
796 # or the consumer project).
797 "monitoredResource": "A String", # The monitored resource type. The type must be defined in
798 # Service.monitored_resources section.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]799 "metrics": [ # Types of the metrics to report to this monitoring destination.
800 # Each type must be defined in Service.metrics section.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]801 "A String",
802 ],
803 },
804 ],
805 "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]806 # There can be multiple consumer destinations. A monitored resouce type may
807 # appear in multiple monitoring destinations if different aggregations are
808 # needed for different sets of metrics associated with that monitored
809 # resource type. A monitored resource and metric pair may only be used once
810 # in the Monitoring configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]811 { # Configuration of a specific monitoring destination (the producer project
812 # or the consumer project).
813 "monitoredResource": "A String", # The monitored resource type. The type must be defined in
814 # Service.monitored_resources section.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]815 "metrics": [ # Types of the metrics to report to this monitoring destination.
816 # Each type must be defined in Service.metrics section.
817 "A String",
818 ],
819 },
820 ],
821 },
822 "billing": { # Billing related configuration of the service. # Billing configuration.
823 #
824 # The following example shows how to configure monitored resources and metrics
825 # for billing:
826 #
827 # monitored_resources:
828 # - type: library.googleapis.com/branch
829 # labels:
830 # - key: /city
831 # description: The city where the library branch is located in.
832 # - key: /name
833 # description: The name of the branch.
834 # metrics:
835 # - name: library.googleapis.com/book/borrowed_count
836 # metric_kind: DELTA
837 # value_type: INT64
838 # billing:
839 # consumer_destinations:
840 # - monitored_resource: library.googleapis.com/branch
841 # metrics:
842 # - library.googleapis.com/book/borrowed_count
843 "consumerDestinations": [ # Billing configurations for sending metrics to the consumer project.
844 # There can be multiple consumer destinations per service, each one must have
845 # a different monitored resource type. A metric can be used in at most
846 # one consumer destination.
847 { # Configuration of a specific billing destination (Currently only support
848 # bill against consumer project).
849 "monitoredResource": "A String", # The monitored resource type. The type must be defined in
850 # Service.monitored_resources section.
851 "metrics": [ # Names of the metrics to report to this billing destination.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]852 # Each name must be defined in Service.metrics section.
853 "A String",
854 ],
855 },
856 ],
857 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]858 "title": "A String", # The product title for this service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]859 "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
860 #
861 # Example for an API targeted for external use:
862 #
863 # name: calendar.googleapis.com
864 # authentication:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]865 # providers:
866 # - id: google_calendar_auth
867 # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
868 # issuer: https://securetoken.google.com
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]869 # rules:
870 # - selector: "*"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]871 # requirements:
872 # provider_id: google_calendar_auth
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]873 "rules": [ # A list of authentication rules that apply to individual API methods.
874 #
875 # **NOTE:** All service configuration rules follow "last one wins" order.
876 { # Authentication rules for the service.
877 #
878 # By default, if a method has any authentication requirements, every request
879 # must include a valid credential matching one of the requirements.
880 # It's an error to include more than one kind of credential in a single
881 # request.
882 #
883 # If a method doesn't have any auth requirements, request credentials will be
884 # ignored.
885 "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
886 # there are scopes defined for "Read-only access to Google Calendar" and
887 # "Access to Cloud Platform". Users can consent to a scope for an application,
888 # giving it permission to access that data on their behalf.
889 #
890 # OAuth scope specifications should be fairly coarse grained; a user will need
891 # to see and understand the text description of what your scope means.
892 #
893 # In most cases: use one or at most two OAuth scopes for an entire family of
894 # products. If your product has multiple APIs, you should probably be sharing
895 # the OAuth scope across all of those APIs.
896 #
897 # When you need finer grained OAuth consent screens: talk with your product
898 # management about how developers will use them in practice.
899 #
900 # Please note that even though each of the canonical scopes is enough for a
901 # request to be accepted and passed to the backend, a request can still fail
902 # due to the backend requiring additional scopes or permissions.
903 "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
904 # OAuth token containing any of these scopes will be accepted.
905 #
906 # Example:
907 #
908 # canonical_scopes: https://www.googleapis.com/auth/calendar,
909 # https://www.googleapis.com/auth/calendar.read
910 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]911 "allowWithoutCredential": True or False, # If true, the service accepts API keys without any other credential.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]912 "requirements": [ # Requirements for additional authentication providers.
913 { # User-defined authentication requirements, including support for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]914 # [JSON Web Token
915 # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]916 "providerId": "A String", # id from authentication provider.
917 #
918 # Example:
919 #
920 # provider_id: bookstore_auth
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]921 "audiences": "A String", # NOTE: This will be deprecated soon, once AuthProvider.audiences is
922 # implemented and accepted in all the runtime components.
923 #
924 # The list of JWT
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]925 # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
926 # that are allowed to access. A JWT containing any of these audiences will
927 # be accepted. When this setting is absent, only JWTs with audience
928 # "https://Service_name/API_name"
929 # will be accepted. For example, if no audiences are in the setting,
930 # LibraryService API will only accept JWTs with the following audience
931 # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
932 #
933 # Example:
934 #
935 # audiences: bookstore_android.apps.googleusercontent.com,
936 # bookstore_web.apps.googleusercontent.com
937 },
938 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]939 "selector": "A String", # Selects the methods to which this rule applies.
940 #
941 # Refer to selector for syntax details.
942 },
943 ],
944 "providers": [ # Defines a set of authentication providers that a service supports.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]945 { # Configuration for an authentication provider, including support for
946 # [JSON Web Token
947 # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
948 "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
949 # [OpenID
950 # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
951 # Optional if the key set document:
952 # - can be retrieved from
953 # [OpenID
954 # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
955 # the issuer.
956 # - can be inferred from the email domain of the issuer (e.g. a Google
957 # service account).
958 #
959 # Example: https://www.googleapis.com/oauth2/v1/certs
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]960 "audiences": "A String", # The list of JWT
961 # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
962 # that are allowed to access. A JWT containing any of these audiences will
963 # be accepted. When this setting is absent, only JWTs with audience
964 # "https://Service_name/API_name"
965 # will be accepted. For example, if no audiences are in the setting,
966 # LibraryService API will only accept JWTs with the following audience
967 # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
968 #
969 # Example:
970 #
971 # audiences: bookstore_android.apps.googleusercontent.com,
972 # bookstore_web.apps.googleusercontent.com
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]973 "id": "A String", # The unique identifier of the auth provider. It will be referred to by
974 # `AuthRequirement.provider_id`.
975 #
976 # Example: "bookstore_auth".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]977 "authorizationUrl": "A String", # Redirect URL if JWT token is required but not present or is expired.
978 # Implement authorizationUrl of securityDefinitions in OpenAPI spec.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]979 "issuer": "A String", # Identifies the principal that issued the JWT. See
980 # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
981 # Usually a URL or an email address.
982 #
983 # Example: https://securetoken.google.com
984 # Example: 1234567-compute@developer.gserviceaccount.com
985 },
986 ],
987 },
988 "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
989 "rules": [ # A list of usage rules that apply to individual API methods.
990 #
991 # **NOTE:** All service configuration rules follow "last one wins" order.
992 { # Usage configuration rules for the service.
993 #
994 # NOTE: Under development.
995 #
996 #
997 # Use this rule to configure unregistered calls for the service. Unregistered
998 # calls are calls that do not contain consumer project identity.
999 # (Example: calls that do not contain an API key).
1000 # By default, API methods do not allow unregistered calls, and each method call
1001 # must be identified by a consumer project identity. Use this rule to
1002 # allow/disallow unregistered calls.
1003 #
1004 # Example of an API that wants to allow unregistered calls for entire service.
1005 #
1006 # usage:
1007 # rules:
1008 # - selector: "*"
1009 # allow_unregistered_calls: true
1010 #
1011 # Example of a method that wants to allow unregistered calls.
1012 #
1013 # usage:
1014 # rules:
1015 # - selector: "google.example.library.v1.LibraryService.CreateBook"
1016 # allow_unregistered_calls: true
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1017 "skipServiceControl": True or False, # If true, the selected method should skip service control and the control
1018 # plane features, such as quota and billing, will not be available.
1019 # This flag is used by Google Cloud Endpoints to bypass checks for internal
1020 # methods, such as service health check methods.
1021 "allowUnregisteredCalls": True or False, # If true, the selected method allows unregistered calls, e.g. calls
1022 # that don't identify any user or application.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1023 "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
1024 # methods in all APIs.
1025 #
1026 # Refer to selector for syntax details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1027 },
1028 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1029 "producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
1030 # service producer.
1031 #
1032 # Google Service Management currently only supports
1033 # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
1034 # channel. To use Google Cloud Pub/Sub as the channel, this must be the name
1035 # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
1036 # documented in https://cloud.google.com/pubsub/docs/overview.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1037 "requirements": [ # Requirements that must be satisfied before a consumer project can use the
1038 # service. Each requirement is of the form <service.name>/<requirement-id>;
1039 # for example 'serviceusage.googleapis.com/billing-enabled'.
1040 "A String",
1041 ],
1042 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1043 "configVersion": 42, # The semantic version of the service configuration. The config version
1044 # affects the interpretation of the service configuration. For example,
1045 # certain features are enabled by default for certain config versions.
1046 # The latest config version is `3`.
1047 "producerProjectId": "A String", # The Google project that owns this service.
1048 "http": { # Defines the HTTP configuration for an API service. It contains a list of # HTTP configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1049 # HttpRule, each specifying the mapping of an RPC method
1050 # to one or more HTTP REST API methods.
1051 "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
1052 #
1053 # **NOTE:** All service configuration rules follow "last one wins" order.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1054 { # # gRPC Transcoding
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1055 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1056 # gRPC Transcoding is a feature for mapping between a gRPC method and one or
1057 # more HTTP REST endpoints. It allows developers to build a single API service
1058 # that supports both gRPC APIs and REST APIs. Many systems, including [Google
1059 # APIs](https://github.com/googleapis/googleapis),
1060 # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
1061 # Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
1062 # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
1063 # and use it for large scale production services.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1064 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1065 # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
1066 # how different portions of the gRPC request message are mapped to the URL
1067 # path, URL query parameters, and HTTP request body. It also controls how the
1068 # gRPC response message is mapped to the HTTP response body. `HttpRule` is
1069 # typically specified as an `google.api.http` annotation on the gRPC method.
1070 #
1071 # Each mapping specifies a URL path template and an HTTP method. The path
1072 # template may refer to one or more fields in the gRPC request message, as long
1073 # as each field is a non-repeated field with a primitive (non-message) type.
1074 # The path template controls how fields of the request message are mapped to
1075 # the URL path.
1076 #
1077 # Example:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1078 #
1079 # service Messaging {
1080 # rpc GetMessage(GetMessageRequest) returns (Message) {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1081 # option (google.api.http) = {
1082 # get: "/v1/{name=messages/*}"
1083 # };
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1084 # }
1085 # }
1086 # message GetMessageRequest {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1087 # string name = 1; // Mapped to URL path.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1088 # }
1089 # message Message {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1090 # string text = 1; // The resource content.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1091 # }
1092 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1093 # This enables an HTTP REST to gRPC mapping as below:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1094 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1095 # HTTP | gRPC
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1096 # -----|-----
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1097 # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1098 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1099 # Any fields in the request message which are not bound by the path template
1100 # automatically become HTTP query parameters if there is no HTTP request body.
1101 # For example:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1102 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1103 # service Messaging {
1104 # rpc GetMessage(GetMessageRequest) returns (Message) {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1105 # option (google.api.http) = {
1106 # get:"/v1/messages/{message_id}"
1107 # };
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1108 # }
1109 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1110 # message GetMessageRequest {
1111 # message SubMessage {
1112 # string subfield = 1;
1113 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1114 # string message_id = 1; // Mapped to URL path.
1115 # int64 revision = 2; // Mapped to URL query parameter `revision`.
1116 # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1117 # }
1118 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1119 # This enables a HTTP JSON to RPC mapping as below:
1120 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1121 # HTTP | gRPC
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1122 # -----|-----
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1123 # `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
1124 # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
1125 # "foo"))`
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1126 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1127 # Note that fields which are mapped to URL query parameters must have a
1128 # primitive type or a repeated primitive type or a non-repeated message type.
1129 # In the case of a repeated type, the parameter can be repeated in the URL
1130 # as `...?param=A&param=B`. In the case of a message type, each field of the
1131 # message is mapped to a separate parameter, such as
1132 # `...?foo.a=A&foo.b=B&foo.c=C`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1133 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1134 # For HTTP methods that allow a request body, the `body` field
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1135 # specifies the mapping. Consider a REST update method on the
1136 # message resource collection:
1137 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1138 # service Messaging {
1139 # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
1140 # option (google.api.http) = {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1141 # patch: "/v1/messages/{message_id}"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1142 # body: "message"
1143 # };
1144 # }
1145 # }
1146 # message UpdateMessageRequest {
1147 # string message_id = 1; // mapped to the URL
1148 # Message message = 2; // mapped to the body
1149 # }
1150 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1151 # The following HTTP JSON to RPC mapping is enabled, where the
1152 # representation of the JSON in the request body is determined by
1153 # protos JSON encoding:
1154 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1155 # HTTP | gRPC
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1156 # -----|-----
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1157 # `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
1158 # "123456" message { text: "Hi!" })`
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1159 #
1160 # The special name `*` can be used in the body mapping to define that
1161 # every field not bound by the path template should be mapped to the
1162 # request body. This enables the following alternative definition of
1163 # the update method:
1164 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1165 # service Messaging {
1166 # rpc UpdateMessage(Message) returns (Message) {
1167 # option (google.api.http) = {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1168 # patch: "/v1/messages/{message_id}"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1169 # body: "*"
1170 # };
1171 # }
1172 # }
1173 # message Message {
1174 # string message_id = 1;
1175 # string text = 2;
1176 # }
1177 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1178 #
1179 # The following HTTP JSON to RPC mapping is enabled:
1180 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1181 # HTTP | gRPC
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1182 # -----|-----
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1183 # `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
1184 # "123456" text: "Hi!")`
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1185 #
1186 # Note that when using `*` in the body mapping, it is not possible to
1187 # have HTTP parameters, as all fields not bound by the path end in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1188 # the body. This makes this option more rarely used in practice when
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1189 # defining REST APIs. The common usage of `*` is in custom methods
1190 # which don't use the URL at all for transferring data.
1191 #
1192 # It is possible to define multiple HTTP methods for one RPC by using
1193 # the `additional_bindings` option. Example:
1194 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1195 # service Messaging {
1196 # rpc GetMessage(GetMessageRequest) returns (Message) {
1197 # option (google.api.http) = {
1198 # get: "/v1/messages/{message_id}"
1199 # additional_bindings {
1200 # get: "/v1/users/{user_id}/messages/{message_id}"
1201 # }
1202 # };
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1203 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1204 # }
1205 # message GetMessageRequest {
1206 # string message_id = 1;
1207 # string user_id = 2;
1208 # }
1209 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1210 # This enables the following two alternative HTTP JSON to RPC mappings:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1211 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1212 # HTTP | gRPC
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1213 # -----|-----
1214 # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1215 # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
1216 # "123456")`
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1217 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1218 # ## Rules for HTTP mapping
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1219 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1220 # 1. Leaf request fields (recursive expansion nested messages in the request
1221 # message) are classified into three categories:
1222 # - Fields referred by the path template. They are passed via the URL path.
1223 # - Fields referred by the HttpRule.body. They are passed via the HTTP
1224 # request body.
1225 # - All other fields are passed via the URL query parameters, and the
1226 # parameter name is the field path in the request message. A repeated
1227 # field can be represented as multiple query parameters under the same
1228 # name.
1229 # 2. If HttpRule.body is "*", there is no URL query parameter, all fields
1230 # are passed via URL path and HTTP request body.
1231 # 3. If HttpRule.body is omitted, there is no HTTP request body, all
1232 # fields are passed via URL path and URL query parameters.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1233 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1234 # ### Path template syntax
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1235 #
1236 # Template = "/" Segments [ Verb ] ;
1237 # Segments = Segment { "/" Segment } ;
1238 # Segment = "*" | "**" | LITERAL | Variable ;
1239 # Variable = "{" FieldPath [ "=" Segments ] "}" ;
1240 # FieldPath = IDENT { "." IDENT } ;
1241 # Verb = ":" LITERAL ;
1242 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1243 # The syntax `*` matches a single URL path segment. The syntax `**` matches
1244 # zero or more URL path segments, which must be the last part of the URL path
1245 # except the `Verb`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1246 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1247 # The syntax `Variable` matches part of the URL path as specified by its
1248 # template. A variable template must not contain other variables. If a variable
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1249 # matches a single path segment, its template may be omitted, e.g. `{var}`
1250 # is equivalent to `{var=*}`.
1251 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1252 # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
1253 # contains any reserved character, such characters should be percent-encoded
1254 # before the matching.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1255 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1256 # If a variable contains exactly one path segment, such as `"{var}"` or
1257 # `"{var=*}"`, when such a variable is expanded into a URL path on the client
1258 # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
1259 # server side does the reverse decoding. Such variables show up in the
1260 # [Discovery
1261 # Document](https://developers.google.com/discovery/v1/reference/apis) as
1262 # `{var}`.
1263 #
1264 # If a variable contains multiple path segments, such as `"{var=foo/*}"`
1265 # or `"{var=**}"`, when such a variable is expanded into a URL path on the
1266 # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
1267 # The server side does the reverse decoding, except "%2F" and "%2f" are left
1268 # unchanged. Such variables show up in the
1269 # [Discovery
1270 # Document](https://developers.google.com/discovery/v1/reference/apis) as
1271 # `{+var}`.
1272 #
1273 # ## Using gRPC API Service Configuration
1274 #
1275 # gRPC API Service Configuration (service config) is a configuration language
1276 # for configuring a gRPC service to become a user-facing product. The
1277 # service config is simply the YAML representation of the `google.api.Service`
1278 # proto message.
1279 #
1280 # As an alternative to annotating your proto file, you can configure gRPC
1281 # transcoding in your service config YAML files. You do this by specifying a
1282 # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
1283 # effect as the proto annotation. This can be particularly useful if you
1284 # have a proto that is reused in multiple services. Note that any transcoding
1285 # specified in the service config will override any matching transcoding
1286 # configuration in the proto.
1287 #
1288 # Example:
1289 #
1290 # http:
1291 # rules:
1292 # # Selects a gRPC method and applies HttpRule to it.
1293 # - selector: example.v1.Messaging.GetMessage
1294 # get: /v1/messages/{message_id}/{sub.subfield}
1295 #
1296 # ## Special notes
1297 #
1298 # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
1299 # proto to JSON conversion must follow the [proto3
1300 # specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
1301 #
1302 # While the single segment variable follows the semantics of
1303 # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
1304 # Expansion, the multi segment variable **does not** follow RFC 6570 Section
1305 # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
1306 # does not expand special characters like `?` and `#`, which would lead
1307 # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
1308 # for multi segment variables.
1309 #
1310 # The path variables **must not** refer to any repeated or mapped field,
1311 # because client libraries are not capable of handling such variable expansion.
1312 #
1313 # The path variables **must not** capture the leading "/" character. The reason
1314 # is that the most common use case "{var}" does not capture the leading "/"
1315 # character. For consistency, all path variables must share the same behavior.
1316 #
1317 # Repeated message fields must not be mapped to URL query parameters, because
1318 # no client library can support such complicated mapping.
1319 #
1320 # If an API needs to use a JSON array for request or response body, it can map
1321 # the request or response body to a repeated field. However, some gRPC
1322 # Transcoding implementations may not support this feature.
1323 "body": "A String", # The name of the request field whose value is mapped to the HTTP request
1324 # body, or `*` for mapping all request fields not captured by the path
1325 # pattern to the HTTP body, or omitted for not having any HTTP request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1326 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1327 # NOTE: the referred field must be present at the top-level of the request
1328 # message type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1329 "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
1330 # not contain an `additional_bindings` field themselves (that is,
1331 # the nesting may only be one level deep).
1332 # Object with schema name: HttpRule
1333 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1334 "get": "A String", # Maps to HTTP GET. Used for listing and getting information about
1335 # resources.
1336 "patch": "A String", # Maps to HTTP PATCH. Used for updating a resource.
1337 "custom": { # A custom pattern is used for defining custom HTTP verb. # The custom pattern is used for specifying an HTTP method that is not
1338 # included in the `pattern` field, such as HEAD, or "*" to leave the
1339 # HTTP method unspecified for this rule. The wild-card rule is useful
1340 # for services that provide content to Web (HTML) clients.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1341 "path": "A String", # The path matched by this custom verb.
1342 "kind": "A String", # The name of this custom HTTP verb.
1343 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1344 "responseBody": "A String", # Optional. The name of the response field whose value is mapped to the HTTP
1345 # response body. When omitted, the entire response message will be used
1346 # as the HTTP response body.
1347 #
1348 # NOTE: The referred field must be present at the top-level of the response
1349 # message type.
1350 "put": "A String", # Maps to HTTP PUT. Used for replacing a resource.
1351 "post": "A String", # Maps to HTTP POST. Used for creating a resource or performing an action.
1352 "selector": "A String", # Selects a method to which this rule applies.
1353 #
1354 # Refer to selector for syntax details.
1355 "delete": "A String", # Maps to HTTP DELETE. Used for deleting a resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1356 },
1357 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1358 "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1359 # cases of single segment matches in reserved expansion, where "%2F" will be
1360 # left encoded.
1361 #
1362 # The default behavior is to not decode RFC 6570 reserved characters in multi
1363 # segment matches.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1364 },
1365 "apis": [ # A list of API interfaces exported by this service. Only the `name` field
1366 # of the google.protobuf.Api needs to be provided by the configuration
1367 # author, as the remaining fields will be derived from the IDL during the
1368 # normalization process. It is an error to specify an API interface here
1369 # which cannot be resolved against the associated IDL files.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1370 { # Api is a light-weight descriptor for an API Interface.
1371 #
1372 # Interfaces are also described as "protocol buffer services" in some contexts,
1373 # such as by the "service" keyword in a .proto file, but they are different
1374 # from API Services, which represent a concrete implementation of an interface
1375 # as opposed to simply a description of methods and bindings. They are also
1376 # sometimes simply referred to as "APIs" in other contexts, such as the name of
1377 # this message itself. See https://cloud.google.com/apis/design/glossary for
1378 # detailed terminology.
1379 "methods": [ # The methods of this interface, in unspecified order.
1380 { # Method represents a method of an API interface.
1381 "name": "A String", # The simple name of this method.
1382 "requestStreaming": True or False, # If true, the request is streamed.
1383 "responseTypeUrl": "A String", # The URL of the output message type.
1384 "requestTypeUrl": "A String", # A URL of the input message type.
1385 "responseStreaming": True or False, # If true, the response is streamed.
1386 "syntax": "A String", # The source syntax of this method.
1387 "options": [ # Any metadata attached to the method.
1388 { # A protocol buffer option, which can be attached to a message, field,
1389 # enumeration, etc.
1390 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1391 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1392 # For custom options, it should be the fully-qualified name. For example,
1393 # `"google.api.http"`.
1394 "value": { # The option's value packed in an Any message. If the value is a primitive,
1395 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1396 # should be used. If the value is an enum, it should be stored as an int32
1397 # value using the google.protobuf.Int32Value type.
1398 "a_key": "", # Properties of the object. Contains field @type with type URL.
1399 },
1400 },
1401 ],
1402 },
1403 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1404 "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
1405 # message.
1406 # protobuf element, like the file in which it is defined.
1407 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1408 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1409 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1410 "mixins": [ # Included interfaces. See Mixin.
1411 { # Declares an API Interface to be included in this interface. The including
1412 # interface must redeclare all the methods from the included interface, but
1413 # documentation and options are inherited as follows:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1414 #
1415 # - If after comment and whitespace stripping, the documentation
1416 # string of the redeclared method is empty, it will be inherited
1417 # from the original method.
1418 #
1419 # - Each annotation belonging to the service config (http,
1420 # visibility) which is not set in the redeclared method will be
1421 # inherited.
1422 #
1423 # - If an http annotation is inherited, the path pattern will be
1424 # modified as follows. Any version prefix will be replaced by the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1425 # version of the including interface plus the root path if
1426 # specified.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1427 #
1428 # Example of a simple mixin:
1429 #
1430 # package google.acl.v1;
1431 # service AccessControl {
1432 # // Get the underlying ACL object.
1433 # rpc GetAcl(GetAclRequest) returns (Acl) {
1434 # option (google.api.http).get = "/v1/{resource=**}:getAcl";
1435 # }
1436 # }
1437 #
1438 # package google.storage.v2;
1439 # service Storage {
1440 # // rpc GetAcl(GetAclRequest) returns (Acl);
1441 #
1442 # // Get a data record.
1443 # rpc GetData(GetDataRequest) returns (Data) {
1444 # option (google.api.http).get = "/v2/{resource=**}";
1445 # }
1446 # }
1447 #
1448 # Example of a mixin configuration:
1449 #
1450 # apis:
1451 # - name: google.storage.v2.Storage
1452 # mixins:
1453 # - name: google.acl.v1.AccessControl
1454 #
1455 # The mixin construct implies that all methods in `AccessControl` are
1456 # also declared with same name and request/response types in
1457 # `Storage`. A documentation generator or annotation processor will
1458 # see the effective `Storage.GetAcl` method after inherting
1459 # documentation and annotations as follows:
1460 #
1461 # service Storage {
1462 # // Get the underlying ACL object.
1463 # rpc GetAcl(GetAclRequest) returns (Acl) {
1464 # option (google.api.http).get = "/v2/{resource=**}:getAcl";
1465 # }
1466 # ...
1467 # }
1468 #
1469 # Note how the version in the path pattern changed from `v1` to `v2`.
1470 #
1471 # If the `root` field in the mixin is specified, it should be a
1472 # relative path under which inherited HTTP paths are placed. Example:
1473 #
1474 # apis:
1475 # - name: google.storage.v2.Storage
1476 # mixins:
1477 # - name: google.acl.v1.AccessControl
1478 # root: acls
1479 #
1480 # This implies the following inherited HTTP annotation:
1481 #
1482 # service Storage {
1483 # // Get the underlying ACL object.
1484 # rpc GetAcl(GetAclRequest) returns (Acl) {
1485 # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
1486 # }
1487 # ...
1488 # }
1489 "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
1490 # are rooted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1491 "name": "A String", # The fully qualified name of the interface which is included.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1492 },
1493 ],
1494 "syntax": "A String", # The source syntax of the service.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1495 "version": "A String", # A version string for this interface. If specified, must have the form
1496 # `major-version.minor-version`, as in `1.10`. If the minor version is
1497 # omitted, it defaults to zero. If the entire version field is empty, the
1498 # major version is derived from the package name, as outlined below. If the
1499 # field is not empty, the version in the package name will be verified to be
1500 # consistent with what is provided here.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1501 #
1502 # The versioning schema uses [semantic
1503 # versioning](http://semver.org) where the major version number
1504 # indicates a breaking change and the minor version an additive,
1505 # non-breaking change. Both version numbers are signals to users
1506 # what to expect from different versions, and should be carefully
1507 # chosen based on the product plan.
1508 #
1509 # The major version is also reflected in the package name of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1510 # interface, which must end in `v<major-version>`, as in
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1511 # `google.feature.v1`. For major versions 0 and 1, the suffix can
1512 # be omitted. Zero major versions must only be used for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1513 # experimental, non-GA interfaces.
1514 "options": [ # Any metadata attached to the interface.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1515 { # A protocol buffer option, which can be attached to a message, field,
1516 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1517 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1518 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1519 # For custom options, it should be the fully-qualified name. For example,
1520 # `"google.api.http"`.
1521 "value": { # The option's value packed in an Any message. If the value is a primitive,
1522 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1523 # should be used. If the value is an enum, it should be stored as an int32
1524 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1525 "a_key": "", # Properties of the object. Contains field @type with type URL.
1526 },
1527 },
1528 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1529 "name": "A String", # The fully qualified name of this interface, including package name
1530 # followed by the interface's simple name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1531 },
1532 ],
1533 "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
1534 # specific protobuf types that can appear in error detail lists of
1535 # error responses.
1536 #
1537 # Example:
1538 #
1539 # custom_error:
1540 # types:
1541 # - google.foo.v1.CustomError
1542 # - google.foo.v1.AnotherError
1543 "rules": [ # The list of custom error rules that apply to individual API messages.
1544 #
1545 # **NOTE:** All service configuration rules follow "last one wins" order.
1546 { # A custom error rule.
1547 "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
1548 # objects of this type will be filtered when they appear in error payload.
1549 "selector": "A String", # Selects messages to which this rule applies.
1550 #
1551 # Refer to selector for syntax details.
1552 },
1553 ],
1554 "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
1555 "A String",
1556 ],
1557 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1558 "quota": { # Quota configuration helps to achieve fairness and budgeting in service # Quota configuration.
1559 # usage.
1560 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1561 # The metric based quota configuration works this way:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1562 # - The service configuration defines a set of metrics.
1563 # - For API calls, the quota.metric_rules maps methods to metrics with
1564 # corresponding costs.
1565 # - The quota.limits defines limits on the metrics, which will be used for
1566 # quota checks at runtime.
1567 #
1568 # An example quota configuration in yaml format:
1569 #
1570 # quota:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1571 # limits:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1572 #
1573 # - name: apiWriteQpsPerProject
1574 # metric: library.googleapis.com/write_calls
1575 # unit: "1/min/{project}" # rate limit for consumer projects
1576 # values:
1577 # STANDARD: 10000
1578 #
1579 #
1580 # # The metric rules bind all methods to the read_calls metric,
1581 # # except for the UpdateBook and DeleteBook methods. These two methods
1582 # # are mapped to the write_calls metric, with the UpdateBook method
1583 # # consuming at twice rate as the DeleteBook method.
1584 # metric_rules:
1585 # - selector: "*"
1586 # metric_costs:
1587 # library.googleapis.com/read_calls: 1
1588 # - selector: google.example.library.v1.LibraryService.UpdateBook
1589 # metric_costs:
1590 # library.googleapis.com/write_calls: 2
1591 # - selector: google.example.library.v1.LibraryService.DeleteBook
1592 # metric_costs:
1593 # library.googleapis.com/write_calls: 1
1594 #
1595 # Corresponding Metric definition:
1596 #
1597 # metrics:
1598 # - name: library.googleapis.com/read_calls
1599 # display_name: Read requests
1600 # metric_kind: DELTA
1601 # value_type: INT64
1602 #
1603 # - name: library.googleapis.com/write_calls
1604 # display_name: Write requests
1605 # metric_kind: DELTA
1606 # value_type: INT64
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1607 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1608 "metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one
1609 # or more metrics.
1610 { # Bind API methods to metrics. Binding a method to a metric causes that
1611 # metric's configured quota behaviors to apply to the method call.
1612 "metricCosts": { # Metrics to update when the selected methods are called, and the associated
1613 # cost applied to each metric.
1614 #
1615 # The key of the map is the metric name, and the values are the amount
1616 # increased for the metric against which the quota limits are defined.
1617 # The value must not be negative.
1618 "a_key": "A String",
1619 },
1620 "selector": "A String", # Selects the methods to which this rule applies.
1621 #
1622 # Refer to selector for syntax details.
1623 },
1624 ],
1625 "limits": [ # List of `QuotaLimit` definitions for the service.
1626 { # `QuotaLimit` defines a specific limit that applies over a specified duration
1627 # for a limit type. There can be at most one limit for a duration and limit
1628 # type combination defined within a `QuotaGroup`.
1629 "displayName": "A String", # User-visible display name for this limit.
1630 # Optional. If not set, the UI will provide a default display name based on
1631 # the quota configuration. This field can be used to override the default
1632 # display name generated from the configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1633 "name": "A String", # Name of the quota limit.
1634 #
1635 # The name must be provided, and it must be unique within the service. The
1636 # name can only include alphanumeric characters as well as '-'.
1637 #
1638 # The maximum length of the limit name is 64 characters.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1639 "defaultLimit": "A String", # Default number of tokens that can be consumed during the specified
1640 # duration. This is the number of tokens assigned when a client
1641 # application developer activates the service for his/her project.
1642 #
1643 # Specifying a value of 0 will block all requests. This can be used if you
1644 # are provisioning quota to selected consumers and blocking others.
1645 # Similarly, a value of -1 will indicate an unlimited quota. No other
1646 # negative values are allowed.
1647 #
1648 # Used by group-based quotas only.
1649 "metric": "A String", # The name of the metric this quota limit applies to. The quota limits with
1650 # the same metric will be checked together during runtime. The metric must be
1651 # defined within the service config.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1652 "values": { # Tiered limit values. You must specify this as a key:value pair, with an
1653 # integer value that is the maximum number of requests allowed for the
1654 # specified unit. Currently only STANDARD is supported.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1655 "a_key": "A String",
1656 },
1657 "maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified
1658 # duration. Client application developers can override the default limit up
1659 # to this maximum. If specified, this value cannot be set to a value less
1660 # than the default limit. If not specified, it is set to the default limit.
1661 #
1662 # To allow clients to apply overrides with no upper bound, set this to -1,
1663 # indicating unlimited maximum quota.
1664 #
1665 # Used by group-based quotas only.
1666 "duration": "A String", # Duration of this limit in textual notation. Example: "100s", "24h", "1d".
1667 # For duration longer than a day, only multiple of days is supported. We
1668 # support only "100s" and "1d" for now. Additional support will be added in
1669 # the future. "0" indicates indefinite duration.
1670 #
1671 # Used by group-based quotas only.
1672 "freeTier": "A String", # Free tier value displayed in the Developers Console for this limit.
1673 # The free tier is the number of tokens that will be subtracted from the
1674 # billed amount when billing is enabled.
1675 # This field can only be set on a limit with duration "1d", in a billable
1676 # group; it is invalid on any other limit. If this field is not set, it
1677 # defaults to 0, indicating that there is no free tier for this service.
1678 #
1679 # Used by group-based quotas only.
1680 "unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as
1681 # Metric.unit. The supported unit kinds are determined by the quota
1682 # backend system.
1683 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1684 # Here are some examples:
1685 # * "1/min/{project}" for quota per minute per project.
1686 #
1687 # Note: the order of unit components is insignificant.
1688 # The "1" at the beginning is required to follow the metric unit syntax.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1689 "description": "A String", # Optional. User-visible, extended description for this quota limit.
1690 # Should be used only when more context is needed to understand this limit
1691 # than provided by the limit's display name (see: `display_name`).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1692 },
1693 ],
1694 },
1695 "metrics": [ # Defines the metrics used by this service.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1696 { # Defines a metric type and its schema. Once a metric descriptor is created,
1697 # deleting or altering it stops data collection and makes the metric type's
1698 # existing data unusable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1699 "description": "A String", # A detailed description of the metric, which can be used in documentation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1700 "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
1701 # Use sentence case without an ending period, for example "Request count".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1702 # This field is optional but it is recommended to be set for any metrics
1703 # associated with user-visible concepts, such as Quota.
1704 "name": "A String", # The resource name of the metric descriptor.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1705 "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1706 # Some combinations of `metric_kind` and `value_type` might not be supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1707 "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1708 # Some combinations of `metric_kind` and `value_type` might not be supported.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1709 "labels": [ # The set of labels that can be used to describe a specific
1710 # instance of this metric type. For example, the
1711 # `appengine.googleapis.com/http/server/response_latencies` metric
1712 # type has a label for the HTTP response code, `response_code`, so
1713 # you can look at latencies for successful responses or just
1714 # for responses that failed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1715 { # A description of a label.
1716 "valueType": "A String", # The type of data that can be assigned to the label.
1717 "description": "A String", # A human-readable description for the label.
1718 "key": "A String", # The label key.
1719 },
1720 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1721 "launchStage": "A String", # Optional. The launch stage of the metric definition.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1722 "type": "A String", # The metric type, including its DNS name prefix. The type is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1723 # URL-encoded. All user-defined metric types have the DNS name
1724 # `custom.googleapis.com` or `external.googleapis.com`. Metric types should
1725 # use a natural hierarchical grouping. For example:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1726 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1727 # "custom.googleapis.com/invoice/paid/amount"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1728 # "external.googleapis.com/prometheus/up"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1729 # "appengine.googleapis.com/http/server/response_latencies"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1730 "unit": "A String", # The unit in which the metric value is reported. It is only applicable
1731 # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
1732 # supported units are a subset of [The Unified Code for Units of
1733 # Measure](http://unitsofmeasure.org/ucum.html) standard:
1734 #
1735 # **Basic units (UNIT)**
1736 #
1737 # * `bit` bit
1738 # * `By` byte
1739 # * `s` second
1740 # * `min` minute
1741 # * `h` hour
1742 # * `d` day
1743 #
1744 # **Prefixes (PREFIX)**
1745 #
1746 # * `k` kilo (10**3)
1747 # * `M` mega (10**6)
1748 # * `G` giga (10**9)
1749 # * `T` tera (10**12)
1750 # * `P` peta (10**15)
1751 # * `E` exa (10**18)
1752 # * `Z` zetta (10**21)
1753 # * `Y` yotta (10**24)
1754 # * `m` milli (10**-3)
1755 # * `u` micro (10**-6)
1756 # * `n` nano (10**-9)
1757 # * `p` pico (10**-12)
1758 # * `f` femto (10**-15)
1759 # * `a` atto (10**-18)
1760 # * `z` zepto (10**-21)
1761 # * `y` yocto (10**-24)
1762 # * `Ki` kibi (2**10)
1763 # * `Mi` mebi (2**20)
1764 # * `Gi` gibi (2**30)
1765 # * `Ti` tebi (2**40)
1766 #
1767 # **Grammar**
1768 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1769 # The grammar also includes these connectors:
1770 #
1771 # * `/` division (as an infix operator, e.g. `1/s`).
1772 # * `.` multiplication (as an infix operator, e.g. `GBy.d`)
1773 #
1774 # The grammar for a unit is as follows:
1775 #
1776 # Expression = Component { "." Component } { "/" Component } ;
1777 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1778 # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1779 # | Annotation
1780 # | "1"
1781 # ;
1782 #
1783 # Annotation = "{" NAME "}" ;
1784 #
1785 # Notes:
1786 #
1787 # * `Annotation` is just a comment if it follows a `UNIT` and is
1788 # equivalent to `1` if it is used alone. For examples,
1789 # `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
1790 # * `NAME` is a sequence of non-blank printable ASCII characters not
1791 # containing '{' or '}'.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1792 # * `1` represents dimensionless value 1, such as in `1/s`.
1793 # * `%` represents dimensionless value 1/100, and annotates values giving
1794 # a percentage.
1795 "metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric.
1796 "launchStage": "A String", # Deprecated. Please use the MetricDescriptor.launch_stage instead.
1797 # The launch stage of the metric definition.
1798 "ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this
1799 # age are guaranteed to be ingested and available to be read, excluding
1800 # data loss due to errors.
1801 "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written
1802 # periodically, consecutive data points are stored at this time interval,
1803 # excluding data loss due to errors. Metrics with a higher granularity have
1804 # a smaller sampling period.
1805 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1806 },
1807 ],
1808 "enums": [ # A list of all enum types included in this API service. Enums
1809 # referenced directly or indirectly by the `apis` are automatically
1810 # included. Enums which are not referenced but shall be included
1811 # should be listed here by name. Example:
1812 #
1813 # enums:
1814 # - name: google.someapi.v1.SomeEnum
1815 { # Enum type definition.
1816 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
1817 # protobuf element, like the file in which it is defined.
1818 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1819 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1820 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1821 "enumvalue": [ # Enum value definitions.
1822 { # Enum value definition.
1823 "options": [ # Protocol buffer options.
1824 { # A protocol buffer option, which can be attached to a message, field,
1825 # enumeration, etc.
1826 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1827 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1828 # For custom options, it should be the fully-qualified name. For example,
1829 # `"google.api.http"`.
1830 "value": { # The option's value packed in an Any message. If the value is a primitive,
1831 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1832 # should be used. If the value is an enum, it should be stored as an int32
1833 # value using the google.protobuf.Int32Value type.
1834 "a_key": "", # Properties of the object. Contains field @type with type URL.
1835 },
1836 },
1837 ],
1838 "name": "A String", # Enum value name.
1839 "number": 42, # Enum value number.
1840 },
1841 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1842 "options": [ # Protocol buffer options.
1843 { # A protocol buffer option, which can be attached to a message, field,
1844 # enumeration, etc.
1845 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1846 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1847 # For custom options, it should be the fully-qualified name. For example,
1848 # `"google.api.http"`.
1849 "value": { # The option's value packed in an Any message. If the value is a primitive,
1850 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1851 # should be used. If the value is an enum, it should be stored as an int32
1852 # value using the google.protobuf.Int32Value type.
1853 "a_key": "", # Properties of the object. Contains field @type with type URL.
1854 },
1855 },
1856 ],
1857 "name": "A String", # Enum type name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1858 "syntax": "A String", # The source syntax.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1859 },
1860 ],
1861 "types": [ # A list of all proto message types included in this API service.
1862 # Types referenced directly or indirectly by the `apis` are
1863 # automatically included. Messages which are not referenced but
1864 # shall be included, such as types used by the `google.protobuf.Any` type,
1865 # should be listed here by name. Example:
1866 #
1867 # types:
1868 # - name: google.protobuf.Int32
1869 { # A protocol buffer message type.
1870 "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
1871 "A String",
1872 ],
1873 "name": "A String", # The fully qualified message name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1874 "fields": [ # The list of fields.
1875 { # A single field of a message type.
1876 "kind": "A String", # The field type.
1877 "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
1878 # types. The first type has index 1; zero means the type is not in the list.
1879 "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
1880 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
1881 "name": "A String", # The field name.
1882 "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
1883 "jsonName": "A String", # The field JSON name.
1884 "number": 42, # The field number.
1885 "cardinality": "A String", # The field cardinality.
1886 "options": [ # The protocol buffer options.
1887 { # A protocol buffer option, which can be attached to a message, field,
1888 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1889 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1890 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1891 # For custom options, it should be the fully-qualified name. For example,
1892 # `"google.api.http"`.
1893 "value": { # The option's value packed in an Any message. If the value is a primitive,
1894 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1895 # should be used. If the value is an enum, it should be stored as an int32
1896 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1897 "a_key": "", # Properties of the object. Contains field @type with type URL.
1898 },
1899 },
1900 ],
1901 "packed": True or False, # Whether to use alternative packed wire representation.
1902 },
1903 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1904 "syntax": "A String", # The source syntax.
1905 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
1906 # protobuf element, like the file in which it is defined.
1907 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1908 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1909 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1910 "options": [ # The protocol buffer options.
1911 { # A protocol buffer option, which can be attached to a message, field,
1912 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1913 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1914 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1915 # For custom options, it should be the fully-qualified name. For example,
1916 # `"google.api.http"`.
1917 "value": { # The option's value packed in an Any message. If the value is a primitive,
1918 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1919 # should be used. If the value is an enum, it should be stored as an int32
1920 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1921 "a_key": "", # Properties of the object. Contains field @type with type URL.
1922 },
1923 },
1924 ],
1925 },
1926 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1927 "logging": { # Logging configuration of the service. # Logging configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1928 #
1929 # The following example shows how to configure logs to be sent to the
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1930 # producer and consumer projects. In the example, the `activity_history`
1931 # log is sent to both the producer and consumer projects, whereas the
1932 # `purchase_history` log is only sent to the producer project.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1933 #
1934 # monitored_resources:
1935 # - type: library.googleapis.com/branch
1936 # labels:
1937 # - key: /city
1938 # description: The city where the library branch is located in.
1939 # - key: /name
1940 # description: The name of the branch.
1941 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1942 # - name: activity_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1943 # labels:
1944 # - key: /customer_id
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1945 # - name: purchase_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1946 # logging:
1947 # producer_destinations:
1948 # - monitored_resource: library.googleapis.com/branch
1949 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1950 # - activity_history
1951 # - purchase_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1952 # consumer_destinations:
1953 # - monitored_resource: library.googleapis.com/branch
1954 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1955 # - activity_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1956 "producerDestinations": [ # Logging configurations for sending logs to the producer project.
1957 # There can be multiple producer destinations, each one must have a
1958 # different monitored resource type. A log can be used in at most
1959 # one producer destination.
1960 { # Configuration of a specific logging destination (the producer project
1961 # or the consumer project).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1962 "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1963 # Service.monitored_resources section.
1964 "logs": [ # Names of the logs to be sent to this destination. Each name must
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1965 # be defined in the Service.logs section. If the log name is
1966 # not a domain scoped name, it will be automatically prefixed with
1967 # the service name followed by "/".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1968 "A String",
1969 ],
1970 },
1971 ],
1972 "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
1973 # There can be multiple consumer destinations, each one must have a
1974 # different monitored resource type. A log can be used in at most
1975 # one consumer destination.
1976 { # Configuration of a specific logging destination (the producer project
1977 # or the consumer project).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1978 "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1979 # Service.monitored_resources section.
1980 "logs": [ # Names of the logs to be sent to this destination. Each name must
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1981 # be defined in the Service.logs section. If the log name is
1982 # not a domain scoped name, it will be automatically prefixed with
1983 # the service name followed by "/".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1984 "A String",
1985 ],
1986 },
1987 ],
1988 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1989 "name": "A String", # The service name, which is a DNS-like logical identifier for the
1990 # service, such as `calendar.googleapis.com`. The service name
1991 # typically goes through DNS verification to make sure the owner
1992 # of the service also owns the DNS name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1993 "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
1994 #
1995 # Example:
1996 # <pre><code>documentation:
1997 # summary: >
1998 # The Google Calendar API gives access
1999 # to most calendar features.
2000 # pages:
2001 # - name: Overview
2002 # content: &#40;== include google/foo/overview.md ==&#41;
2003 # - name: Tutorial
2004 # content: &#40;== include google/foo/tutorial.md ==&#41;
2005 # subpages;
2006 # - name: Java
2007 # content: &#40;== include google/foo/tutorial_java.md ==&#41;
2008 # rules:
2009 # - selector: google.calendar.Calendar.Get
2010 # description: >
2011 # ...
2012 # - selector: google.calendar.Calendar.Put
2013 # description: >
2014 # ...
2015 # </code></pre>
2016 # Documentation is provided in markdown syntax. In addition to
2017 # standard markdown features, definition lists, tables and fenced
2018 # code blocks are supported. Section headers can be provided and are
2019 # interpreted relative to the section nesting of the context where
2020 # a documentation fragment is embedded.
2021 #
2022 # Documentation from the IDL is merged with documentation defined
2023 # via the config at normalization time, where documentation provided
2024 # by config rules overrides IDL provided.
2025 #
2026 # A number of constructs specific to the API platform are supported
2027 # in documentation text.
2028 #
2029 # In order to reference a proto element, the following
2030 # notation can be used:
2031 # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
2032 # To override the display text used for the link, this can be used:
2033 # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
2034 # Text can be excluded from doc using the following notation:
2035 # <pre><code>&#40;-- internal comment --&#41;</code></pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2036 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2037 # A few directives are available in documentation. Note that
2038 # directives must appear on a single line to be properly
2039 # identified. The `include` directive includes a markdown file from
2040 # an external source:
2041 # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
2042 # The `resource_for` directive marks a message to be the resource of
2043 # a collection in REST view. If it is not specified, tools attempt
2044 # to infer the resource from the operations in a collection:
2045 # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
2046 # The directive `suppress_warning` does not directly affect documentation
2047 # and is documented together with service config validation.
2048 "rules": [ # A list of documentation rules that apply to individual API elements.
2049 #
2050 # **NOTE:** All service configuration rules follow "last one wins" order.
2051 { # A documentation rule provides information about individual API elements.
2052 "description": "A String", # Description of the selected API(s).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2053 "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if
2054 # an element is marked as `deprecated`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2055 "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
2056 # qualified name of the element which may end in "*", indicating a wildcard.
2057 # Wildcards are only allowed at the end and for a whole component of the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2058 # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A
2059 # wildcard will match one or more components. To specify a default for all
2060 # applicable elements, the whole pattern "*" is used.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2061 },
2062 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2063 "documentationRootUrl": "A String", # The URL to the root of documentation.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2064 "overview": "A String", # Declares a single overview page. For example:
2065 # <pre><code>documentation:
2066 # summary: ...
2067 # overview: &#40;== include overview.md ==&#41;
2068 # </code></pre>
2069 # This is a shortcut for the following declaration (using pages style):
2070 # <pre><code>documentation:
2071 # summary: ...
2072 # pages:
2073 # - name: Overview
2074 # content: &#40;== include overview.md ==&#41;
2075 # </code></pre>
2076 # Note: you cannot specify both `overview` field and `pages` field.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2077 "pages": [ # The top level pages for the documentation set.
2078 { # Represents a documentation page. A page can contain subpages to represent
2079 # nested documentation set structure.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2080 "content": "A String", # The Markdown content of the page. You can use <code>&#40;== include {path}
2081 # ==&#41;</code> to include content from a Markdown file.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2082 "subpages": [ # Subpages of this page. The order of subpages specified here will be
2083 # honored in the generated docset.
2084 # Object with schema name: Page
2085 ],
2086 "name": "A String", # The name of the page. It will be used as an identity of the page to
2087 # generate URI of the page, text of the link to this page in navigation,
2088 # etc. The full page name (start from the root page name to this page
2089 # concatenated with `.`) can be used as reference to the page in your
2090 # documentation. For example:
2091 # <pre><code>pages:
2092 # - name: Tutorial
2093 # content: &#40;== include tutorial.md ==&#41;
2094 # subpages:
2095 # - name: Java
2096 # content: &#40;== include tutorial_java.md ==&#41;
2097 # </code></pre>
2098 # You can reference `Java` page using Markdown reference link syntax:
2099 # `Java`.
2100 },
2101 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2102 "summary": "A String", # A short summary of what the service does. Can only be provided by
2103 # plain text.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2104 },
2105 "sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
2106 "sourceFiles": [ # All files used during config generation.
2107 {
2108 "a_key": "", # Properties of the object. Contains field @type with type URL.
2109 },
2110 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2111 },
2112 "systemTypes": [ # A list of all proto message types included in this API service.
2113 # It serves similar purpose as [google.api.Service.types], except that
2114 # these types are not needed by user-defined APIs. Therefore, they will not
2115 # show up in the generated discovery doc. This field should only be used
2116 # to define system APIs in ESF.
2117 { # A protocol buffer message type.
2118 "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
2119 "A String",
2120 ],
2121 "name": "A String", # The fully qualified message name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2122 "fields": [ # The list of fields.
2123 { # A single field of a message type.
2124 "kind": "A String", # The field type.
2125 "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
2126 # types. The first type has index 1; zero means the type is not in the list.
2127 "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
2128 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
2129 "name": "A String", # The field name.
2130 "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
2131 "jsonName": "A String", # The field JSON name.
2132 "number": 42, # The field number.
2133 "cardinality": "A String", # The field cardinality.
2134 "options": [ # The protocol buffer options.
2135 { # A protocol buffer option, which can be attached to a message, field,
2136 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2137 "name": "A String", # The option's name. For protobuf built-in options (options defined in
2138 # descriptor.proto), this is the short name. For example, `"map_entry"`.
2139 # For custom options, it should be the fully-qualified name. For example,
2140 # `"google.api.http"`.
2141 "value": { # The option's value packed in an Any message. If the value is a primitive,
2142 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
2143 # should be used. If the value is an enum, it should be stored as an int32
2144 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2145 "a_key": "", # Properties of the object. Contains field @type with type URL.
2146 },
2147 },
2148 ],
2149 "packed": True or False, # Whether to use alternative packed wire representation.
2150 },
2151 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2152 "syntax": "A String", # The source syntax.
2153 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
2154 # protobuf element, like the file in which it is defined.
2155 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
2156 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
2157 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2158 "options": [ # The protocol buffer options.
2159 { # A protocol buffer option, which can be attached to a message, field,
2160 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2161 "name": "A String", # The option's name. For protobuf built-in options (options defined in
2162 # descriptor.proto), this is the short name. For example, `"map_entry"`.
2163 # For custom options, it should be the fully-qualified name. For example,
2164 # `"google.api.http"`.
2165 "value": { # The option's value packed in an Any message. If the value is a primitive,
2166 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
2167 # should be used. If the value is an enum, it should be stored as an int32
2168 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2169 "a_key": "", # Properties of the object. Contains field @type with type URL.
2170 },
2171 },
2172 ],
2173 },
2174 ],
2175 "context": { # `Context` defines which contexts an API requests. # Context configuration.
2176 #
2177 # Example:
2178 #
2179 # context:
2180 # rules:
2181 # - selector: "*"
2182 # requested:
2183 # - google.rpc.context.ProjectContext
2184 # - google.rpc.context.OriginContext
2185 #
2186 # The above specifies that all methods in the API request
2187 # `google.rpc.context.ProjectContext` and
2188 # `google.rpc.context.OriginContext`.
2189 #
2190 # Available context types are defined in package
2191 # `google.rpc.context`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2192 #
2193 # This also provides mechanism to whitelist any protobuf message extension that
2194 # can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
2195 # “x-goog-ext-<extension_id>-jspb” format. For example, list any service
2196 # specific protobuf types that can appear in grpc metadata as follows in your
2197 # yaml file:
2198 #
2199 # Example:
2200 #
2201 # context:
2202 # rules:
2203 # - selector: "google.example.library.v1.LibraryService.CreateBook"
2204 # allowed_request_extensions:
2205 # - google.foo.v1.NewExtension
2206 # allowed_response_extensions:
2207 # - google.foo.v1.NewExtension
2208 #
2209 # You can also specify extension ID instead of fully qualified extension name
2210 # here.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2211 "rules": [ # A list of RPC context rules that apply to individual API methods.
2212 #
2213 # **NOTE:** All service configuration rules follow "last one wins" order.
2214 { # A context rule provides information about the context for an individual API
2215 # element.
2216 "provided": [ # A list of full type names of provided contexts.
2217 "A String",
2218 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2219 "allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc
2220 # side channel from backend to client.
2221 "A String",
2222 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]2223 "selector": "A String", # Selects the methods to which this rule applies.
2224 #
2225 # Refer to selector for syntax details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2226 "allowedRequestExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc
2227 # side channel from client to backend.
2228 "A String",
2229 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2230 "requested": [ # A list of full type names of requested contexts.
2231 "A String",
2232 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2233 },
2234 ],
2235 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]2236 "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
2237 # with the same name as the service is automatically generated to service all
2238 # defined APIs.
2239 { # `Endpoint` describes a network endpoint that serves a set of APIs.
2240 # A service may expose any number of endpoints, and all endpoints share the
2241 # same service configuration, such as quota configuration and monitoring
2242 # configuration.
2243 #
2244 # Example service configuration:
2245 #
2246 # name: library-example.googleapis.com
2247 # endpoints:
2248 # # Below entry makes 'google.example.library.v1.Library'
2249 # # API be served from endpoint address library-example.googleapis.com.
2250 # # It also allows HTTP OPTIONS calls to be passed to the backend, for
2251 # # it to decide whether the subsequent cross-origin request is
2252 # # allowed to proceed.
2253 # - name: library-example.googleapis.com
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]2254 # allow_cors: true
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]2255 "allowCors": True or False, # Allowing
2256 # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
2257 # cross-domain traffic, would allow the backends served from this endpoint to
2258 # receive and respond to HTTP OPTIONS requests. The response will be used by
2259 # the browser to determine whether the subsequent cross-origin request is
2260 # allowed to proceed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2261 "target": "A String", # The specification of an Internet routable address of API frontend that will
2262 # handle requests to this [API
2263 # Endpoint](https://cloud.google.com/apis/design/glossary). It should be
2264 # either a valid IPv4 address or a fully-qualified domain name. For example,
2265 # "8.8.8.8" or "myservice.appspot.com".
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]2266 "features": [ # The list of features enabled on this endpoint.
2267 "A String",
2268 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2269 "name": "A String", # The canonical name of this endpoint.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]2270 "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2271 # please specify multiple google.api.Endpoint for each of the intended
2272 # aliases.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]2273 #
2274 # Additional names that this endpoint will be hosted on.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]2275 "A String",
2276 ],
2277 },
2278 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2279 }</pre>
2280</div>
2281
2282<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2283 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2284 <pre>Gets the access control policy for a resource.
2285Returns an empty policy if the resource exists and does not have a policy
2286set.
2287
2288Args:
2289 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2290See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2291 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2292 The object takes the form of:
2293
2294{ # Request message for `GetIamPolicy` method.
2295 }
2296
2297 x__xgafv: string, V1 error format.
2298 Allowed values
2299 1 - v1 error format
2300 2 - v2 error format
2301
2302Returns:
2303 An object of the form:
2304
2305 { # Defines an Identity and Access Management (IAM) policy. It is used to
2306 # specify access control policies for Cloud Platform resources.
2307 #
2308 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2309 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2310 # `members` to a `role`, where the members can be user accounts, Google groups,
2311 # Google domains, and service accounts. A `role` is a named list of permissions
2312 # defined by IAM.
2313 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2314 # **JSON Example**
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2315 #
2316 # {
2317 # "bindings": [
2318 # {
2319 # "role": "roles/owner",
2320 # "members": [
2321 # "user:mike@example.com",
2322 # "group:admins@example.com",
2323 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2324 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2325 # ]
2326 # },
2327 # {
2328 # "role": "roles/viewer",
2329 # "members": ["user:sean@example.com"]
2330 # }
2331 # ]
2332 # }
2333 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2334 # **YAML Example**
2335 #
2336 # bindings:
2337 # - members:
2338 # - user:mike@example.com
2339 # - group:admins@example.com
2340 # - domain:google.com
2341 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
2342 # role: roles/owner
2343 # - members:
2344 # - user:sean@example.com
2345 # role: roles/viewer
2346 #
2347 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2348 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2349 # [IAM developer's guide](https://cloud.google.com/iam/docs).
2350 "bindings": [ # Associates a list of `members` to a `role`.
2351 # `bindings` with no members will result in an error.
2352 { # Associates `members` with a `role`.
2353 "role": "A String", # Role that is assigned to `members`.
2354 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2355 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2356 # `members` can have the following values:
2357 #
2358 # * `allUsers`: A special identifier that represents anyone who is
2359 # on the internet; with or without a Google account.
2360 #
2361 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2362 # who is authenticated with a Google account or a service account.
2363 #
2364 # * `user:{emailid}`: An email address that represents a specific Google
2365 # account. For example, `alice@gmail.com` .
2366 #
2367 #
2368 # * `serviceAccount:{emailid}`: An email address that represents a service
2369 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2370 #
2371 # * `group:{emailid}`: An email address that represents a Google group.
2372 # For example, `admins@example.com`.
2373 #
2374 #
2375 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2376 # users of that domain. For example, `google.com` or `example.com`.
2377 #
2378 "A String",
2379 ],
2380 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
2381 # NOTE: An unsatisfied condition will not allow user access via current
2382 # binding. Different bindings, including their conditions, are examined
2383 # independently.
2384 #
2385 # title: "User account presence"
2386 # description: "Determines whether the request has a user account"
2387 # expression: "size(request.user) > 0"
2388 "location": "A String", # An optional string indicating the location of the expression for error
2389 # reporting, e.g. a file name and a position in the file.
2390 "expression": "A String", # Textual representation of an expression in
2391 # Common Expression Language syntax.
2392 #
2393 # The application context of the containing message determines which
2394 # well-known feature set of CEL is supported.
2395 "description": "A String", # An optional description of the expression. This is a longer text which
2396 # describes the expression, e.g. when hovered over it in a UI.
2397 "title": "A String", # An optional title for the expression, i.e. a short string describing
2398 # its purpose. This can be used e.g. in UIs which allow to enter the
2399 # expression.
2400 },
2401 },
2402 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2403 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2404 { # Specifies the audit configuration for a service.
2405 # The configuration determines which permission types are logged, and what
2406 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2407 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2408 #
2409 # If there are AuditConfigs for both `allServices` and a specific service,
2410 # the union of the two AuditConfigs is used for that service: the log_types
2411 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2412 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2413 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2414 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2415 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2416 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2417 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2418 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2419 # "service": "allServices"
2420 # "audit_log_configs": [
2421 # {
2422 # "log_type": "DATA_READ",
2423 # "exempted_members": [
2424 # "user:foo@gmail.com"
2425 # ]
2426 # },
2427 # {
2428 # "log_type": "DATA_WRITE",
2429 # },
2430 # {
2431 # "log_type": "ADMIN_READ",
2432 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2433 # ]
2434 # },
2435 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2436 # "service": "fooservice.googleapis.com"
2437 # "audit_log_configs": [
2438 # {
2439 # "log_type": "DATA_READ",
2440 # },
2441 # {
2442 # "log_type": "DATA_WRITE",
2443 # "exempted_members": [
2444 # "user:bar@gmail.com"
2445 # ]
2446 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2447 # ]
2448 # }
2449 # ]
2450 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2451 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2452 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2453 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2454 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2455 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2456 { # Provides the configuration for logging a type of permissions.
2457 # Example:
2458 #
2459 # {
2460 # "audit_log_configs": [
2461 # {
2462 # "log_type": "DATA_READ",
2463 # "exempted_members": [
2464 # "user:foo@gmail.com"
2465 # ]
2466 # },
2467 # {
2468 # "log_type": "DATA_WRITE",
2469 # }
2470 # ]
2471 # }
2472 #
2473 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2474 # foo@gmail.com from DATA_READ logging.
2475 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2476 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2477 # Follows the same format of Binding.members.
2478 "A String",
2479 ],
2480 "logType": "A String", # The log type that this config enables.
2481 },
2482 ],
2483 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2484 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2485 # `allServices` is a special value that covers all services.
2486 },
2487 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2488 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2489 # prevent simultaneous updates of a policy from overwriting each other.
2490 # It is strongly suggested that systems make use of the `etag` in the
2491 # read-modify-write cycle to perform policy updates in order to avoid race
2492 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2493 # systems are expected to put that etag in the request to `setIamPolicy` to
2494 # ensure that their change will be applied to the same version of the policy.
2495 #
2496 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2497 # policy is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2498 "version": 42, # Deprecated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2499 }</pre>
2500</div>
2501
2502<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2503 <code class="details" id="list">list(producerProjectId=None, pageSize=None, pageToken=None, consumerId=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2504 <pre>Lists managed services.
2505
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2506Returns all public services. For authenticated users, also returns all
2507services the calling user has "servicemanagement.services.get" permission
2508for.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2509
2510**BETA:** If the caller specifies the `consumer_id`, it returns only the
2511services enabled on the consumer. The `consumer_id` must have the format
2512of "project:{PROJECT-ID}".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2513
2514Args:
2515 producerProjectId: string, Include services produced by the specified project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2516 pageSize: integer, The max number of items to include in the response list. Page size is 50
2517if not specified. Maximum value is 100.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2518 pageToken: string, Token identifying which result to start with; returned by a previous list
2519call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2520 consumerId: string, Include services consumed by the specified consumer.
2521
2522The Google Service Management implementation accepts the following
2523forms:
2524- project:<project_id>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2525 x__xgafv: string, V1 error format.
2526 Allowed values
2527 1 - v1 error format
2528 2 - v2 error format
2529
2530Returns:
2531 An object of the form:
2532
2533 { # Response message for `ListServices` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2534 "services": [ # The returned services will only have the name field set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2535 { # The full representation of a Service that is managed by
2536 # Google Service Management.
2537 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
2538 # for naming requirements.
2539 "producerProjectId": "A String", # ID of the project that produces and owns this service.
2540 },
2541 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2542 "nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2543 }</pre>
2544</div>
2545
2546<div class="method">
2547 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2548 <pre>Retrieves the next page of results.
2549
2550Args:
2551 previous_request: The request for the previous page. (required)
2552 previous_response: The response from the request for the previous page. (required)
2553
2554Returns:
2555 A request object that you can call 'execute()' on to request the next
2556 page. Returns None if there are no more items in the collection.
2557 </pre>
2558</div>
2559
2560<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]2561 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2562 <pre>Sets the access control policy on the specified resource. Replaces any
2563existing policy.
2564
2565Args:
2566 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2567See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2568 body: object, The request body. (required)
2569 The object takes the form of:
2570
2571{ # Request message for `SetIamPolicy` method.
2572 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
2573 # the policy is limited to a few 10s of KB. An empty policy is a
2574 # valid policy but certain Cloud Platform services (such as Projects)
2575 # might reject them.
2576 # specify access control policies for Cloud Platform resources.
2577 #
2578 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2579 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2580 # `members` to a `role`, where the members can be user accounts, Google groups,
2581 # Google domains, and service accounts. A `role` is a named list of permissions
2582 # defined by IAM.
2583 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2584 # **JSON Example**
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2585 #
2586 # {
2587 # "bindings": [
2588 # {
2589 # "role": "roles/owner",
2590 # "members": [
2591 # "user:mike@example.com",
2592 # "group:admins@example.com",
2593 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2594 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2595 # ]
2596 # },
2597 # {
2598 # "role": "roles/viewer",
2599 # "members": ["user:sean@example.com"]
2600 # }
2601 # ]
2602 # }
2603 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2604 # **YAML Example**
2605 #
2606 # bindings:
2607 # - members:
2608 # - user:mike@example.com
2609 # - group:admins@example.com
2610 # - domain:google.com
2611 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
2612 # role: roles/owner
2613 # - members:
2614 # - user:sean@example.com
2615 # role: roles/viewer
2616 #
2617 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2618 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2619 # [IAM developer's guide](https://cloud.google.com/iam/docs).
2620 "bindings": [ # Associates a list of `members` to a `role`.
2621 # `bindings` with no members will result in an error.
2622 { # Associates `members` with a `role`.
2623 "role": "A String", # Role that is assigned to `members`.
2624 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2625 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2626 # `members` can have the following values:
2627 #
2628 # * `allUsers`: A special identifier that represents anyone who is
2629 # on the internet; with or without a Google account.
2630 #
2631 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2632 # who is authenticated with a Google account or a service account.
2633 #
2634 # * `user:{emailid}`: An email address that represents a specific Google
2635 # account. For example, `alice@gmail.com` .
2636 #
2637 #
2638 # * `serviceAccount:{emailid}`: An email address that represents a service
2639 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2640 #
2641 # * `group:{emailid}`: An email address that represents a Google group.
2642 # For example, `admins@example.com`.
2643 #
2644 #
2645 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2646 # users of that domain. For example, `google.com` or `example.com`.
2647 #
2648 "A String",
2649 ],
2650 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
2651 # NOTE: An unsatisfied condition will not allow user access via current
2652 # binding. Different bindings, including their conditions, are examined
2653 # independently.
2654 #
2655 # title: "User account presence"
2656 # description: "Determines whether the request has a user account"
2657 # expression: "size(request.user) > 0"
2658 "location": "A String", # An optional string indicating the location of the expression for error
2659 # reporting, e.g. a file name and a position in the file.
2660 "expression": "A String", # Textual representation of an expression in
2661 # Common Expression Language syntax.
2662 #
2663 # The application context of the containing message determines which
2664 # well-known feature set of CEL is supported.
2665 "description": "A String", # An optional description of the expression. This is a longer text which
2666 # describes the expression, e.g. when hovered over it in a UI.
2667 "title": "A String", # An optional title for the expression, i.e. a short string describing
2668 # its purpose. This can be used e.g. in UIs which allow to enter the
2669 # expression.
2670 },
2671 },
2672 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2673 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2674 { # Specifies the audit configuration for a service.
2675 # The configuration determines which permission types are logged, and what
2676 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2677 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2678 #
2679 # If there are AuditConfigs for both `allServices` and a specific service,
2680 # the union of the two AuditConfigs is used for that service: the log_types
2681 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2682 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2683 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2684 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2685 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2686 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2687 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2688 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2689 # "service": "allServices"
2690 # "audit_log_configs": [
2691 # {
2692 # "log_type": "DATA_READ",
2693 # "exempted_members": [
2694 # "user:foo@gmail.com"
2695 # ]
2696 # },
2697 # {
2698 # "log_type": "DATA_WRITE",
2699 # },
2700 # {
2701 # "log_type": "ADMIN_READ",
2702 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2703 # ]
2704 # },
2705 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2706 # "service": "fooservice.googleapis.com"
2707 # "audit_log_configs": [
2708 # {
2709 # "log_type": "DATA_READ",
2710 # },
2711 # {
2712 # "log_type": "DATA_WRITE",
2713 # "exempted_members": [
2714 # "user:bar@gmail.com"
2715 # ]
2716 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2717 # ]
2718 # }
2719 # ]
2720 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2721 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2722 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2723 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2724 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2725 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2726 { # Provides the configuration for logging a type of permissions.
2727 # Example:
2728 #
2729 # {
2730 # "audit_log_configs": [
2731 # {
2732 # "log_type": "DATA_READ",
2733 # "exempted_members": [
2734 # "user:foo@gmail.com"
2735 # ]
2736 # },
2737 # {
2738 # "log_type": "DATA_WRITE",
2739 # }
2740 # ]
2741 # }
2742 #
2743 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2744 # foo@gmail.com from DATA_READ logging.
2745 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2746 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2747 # Follows the same format of Binding.members.
2748 "A String",
2749 ],
2750 "logType": "A String", # The log type that this config enables.
2751 },
2752 ],
2753 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2754 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2755 # `allServices` is a special value that covers all services.
2756 },
2757 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2758 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2759 # prevent simultaneous updates of a policy from overwriting each other.
2760 # It is strongly suggested that systems make use of the `etag` in the
2761 # read-modify-write cycle to perform policy updates in order to avoid race
2762 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2763 # systems are expected to put that etag in the request to `setIamPolicy` to
2764 # ensure that their change will be applied to the same version of the policy.
2765 #
2766 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2767 # policy is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2768 "version": 42, # Deprecated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2769 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2770 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2771 # the fields in the mask will be modified. If no mask is provided, the
2772 # following default mask is used:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2773 # paths: "bindings, etag"
2774 # This field is only used by Cloud IAM.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2775 }
2776
2777 x__xgafv: string, V1 error format.
2778 Allowed values
2779 1 - v1 error format
2780 2 - v2 error format
2781
2782Returns:
2783 An object of the form:
2784
2785 { # Defines an Identity and Access Management (IAM) policy. It is used to
2786 # specify access control policies for Cloud Platform resources.
2787 #
2788 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2789 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2790 # `members` to a `role`, where the members can be user accounts, Google groups,
2791 # Google domains, and service accounts. A `role` is a named list of permissions
2792 # defined by IAM.
2793 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2794 # **JSON Example**
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2795 #
2796 # {
2797 # "bindings": [
2798 # {
2799 # "role": "roles/owner",
2800 # "members": [
2801 # "user:mike@example.com",
2802 # "group:admins@example.com",
2803 # "domain:google.com",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2804 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2805 # ]
2806 # },
2807 # {
2808 # "role": "roles/viewer",
2809 # "members": ["user:sean@example.com"]
2810 # }
2811 # ]
2812 # }
2813 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2814 # **YAML Example**
2815 #
2816 # bindings:
2817 # - members:
2818 # - user:mike@example.com
2819 # - group:admins@example.com
2820 # - domain:google.com
2821 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
2822 # role: roles/owner
2823 # - members:
2824 # - user:sean@example.com
2825 # role: roles/viewer
2826 #
2827 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2828 # For a description of IAM and its features, see the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2829 # [IAM developer's guide](https://cloud.google.com/iam/docs).
2830 "bindings": [ # Associates a list of `members` to a `role`.
2831 # `bindings` with no members will result in an error.
2832 { # Associates `members` with a `role`.
2833 "role": "A String", # Role that is assigned to `members`.
2834 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2835 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2836 # `members` can have the following values:
2837 #
2838 # * `allUsers`: A special identifier that represents anyone who is
2839 # on the internet; with or without a Google account.
2840 #
2841 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2842 # who is authenticated with a Google account or a service account.
2843 #
2844 # * `user:{emailid}`: An email address that represents a specific Google
2845 # account. For example, `alice@gmail.com` .
2846 #
2847 #
2848 # * `serviceAccount:{emailid}`: An email address that represents a service
2849 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2850 #
2851 # * `group:{emailid}`: An email address that represents a Google group.
2852 # For example, `admins@example.com`.
2853 #
2854 #
2855 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2856 # users of that domain. For example, `google.com` or `example.com`.
2857 #
2858 "A String",
2859 ],
2860 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
2861 # NOTE: An unsatisfied condition will not allow user access via current
2862 # binding. Different bindings, including their conditions, are examined
2863 # independently.
2864 #
2865 # title: "User account presence"
2866 # description: "Determines whether the request has a user account"
2867 # expression: "size(request.user) > 0"
2868 "location": "A String", # An optional string indicating the location of the expression for error
2869 # reporting, e.g. a file name and a position in the file.
2870 "expression": "A String", # Textual representation of an expression in
2871 # Common Expression Language syntax.
2872 #
2873 # The application context of the containing message determines which
2874 # well-known feature set of CEL is supported.
2875 "description": "A String", # An optional description of the expression. This is a longer text which
2876 # describes the expression, e.g. when hovered over it in a UI.
2877 "title": "A String", # An optional title for the expression, i.e. a short string describing
2878 # its purpose. This can be used e.g. in UIs which allow to enter the
2879 # expression.
2880 },
2881 },
2882 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2883 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2884 { # Specifies the audit configuration for a service.
2885 # The configuration determines which permission types are logged, and what
2886 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2887 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2888 #
2889 # If there are AuditConfigs for both `allServices` and a specific service,
2890 # the union of the two AuditConfigs is used for that service: the log_types
2891 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2892 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2893 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2894 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2895 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2896 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2897 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2898 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2899 # "service": "allServices"
2900 # "audit_log_configs": [
2901 # {
2902 # "log_type": "DATA_READ",
2903 # "exempted_members": [
2904 # "user:foo@gmail.com"
2905 # ]
2906 # },
2907 # {
2908 # "log_type": "DATA_WRITE",
2909 # },
2910 # {
2911 # "log_type": "ADMIN_READ",
2912 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2913 # ]
2914 # },
2915 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2916 # "service": "fooservice.googleapis.com"
2917 # "audit_log_configs": [
2918 # {
2919 # "log_type": "DATA_READ",
2920 # },
2921 # {
2922 # "log_type": "DATA_WRITE",
2923 # "exempted_members": [
2924 # "user:bar@gmail.com"
2925 # ]
2926 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2927 # ]
2928 # }
2929 # ]
2930 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2931 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2932 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2933 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2934 # bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2935 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2936 { # Provides the configuration for logging a type of permissions.
2937 # Example:
2938 #
2939 # {
2940 # "audit_log_configs": [
2941 # {
2942 # "log_type": "DATA_READ",
2943 # "exempted_members": [
2944 # "user:foo@gmail.com"
2945 # ]
2946 # },
2947 # {
2948 # "log_type": "DATA_WRITE",
2949 # }
2950 # ]
2951 # }
2952 #
2953 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2954 # foo@gmail.com from DATA_READ logging.
2955 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2956 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2957 # Follows the same format of Binding.members.
2958 "A String",
2959 ],
2960 "logType": "A String", # The log type that this config enables.
2961 },
2962 ],
2963 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2964 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2965 # `allServices` is a special value that covers all services.
2966 },
2967 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2968 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2969 # prevent simultaneous updates of a policy from overwriting each other.
2970 # It is strongly suggested that systems make use of the `etag` in the
2971 # read-modify-write cycle to perform policy updates in order to avoid race
2972 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2973 # systems are expected to put that etag in the request to `setIamPolicy` to
2974 # ensure that their change will be applied to the same version of the policy.
2975 #
2976 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2977 # policy is overwritten blindly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]2978 "version": 42, # Deprecated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2979 }</pre>
2980</div>
2981
2982<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]2983 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2984 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2985If the resource does not exist, this will return an empty set of
2986permissions, not a NOT_FOUND error.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2987
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2988Note: This operation is designed to be used for building permission-aware
2989UIs and command-line tools, not for authorization checking. This operation
2990may "fail open" without warning.
2991
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2992Args:
2993 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2994See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]2995 body: object, The request body. (required)
2996 The object takes the form of:
2997
2998{ # Request message for `TestIamPermissions` method.
2999 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
3000 # wildcards (such as '*' or 'storage.*') are not allowed. For more
3001 # information see
3002 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
3003 "A String",
3004 ],
3005 }
3006
3007 x__xgafv: string, V1 error format.
3008 Allowed values
3009 1 - v1 error format
3010 2 - v2 error format
3011
3012Returns:
3013 An object of the form:
3014
3015 { # Response message for `TestIamPermissions` method.
3016 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3017 # allowed.
3018 "A String",
3019 ],
3020 }</pre>
3021</div>
3022
3023<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]3024 <code class="details" id="undelete">undelete(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]3025 <pre>Revives a previously deleted managed service. The method restores the
3026service using the configuration at the time the service was deleted.
3027The target service must exist and must have been deleted within the
3028last 30 days.
3029
3030Operation<response: UndeleteServiceResponse>
3031
3032Args:
3033 serviceName: string, The name of the service. See the [overview](/service-management/overview)
3034for naming requirements. For example: `example.googleapis.com`. (required)
3035 x__xgafv: string, V1 error format.
3036 Allowed values
3037 1 - v1 error format
3038 2 - v2 error format
3039
3040Returns:
3041 An object of the form:
3042
3043 { # This resource represents a long-running operation that is the result of a
3044 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3045 "response": { # The normal response of the operation in case of success. If the original
3046 # method returns no data on success, such as `Delete`, the response is
3047 # `google.protobuf.Empty`. If the original method is standard
3048 # `Get`/`Create`/`Update`, the response should be the resource. For other
3049 # methods, the response should have the type `XxxResponse`, where `Xxx`
3050 # is the original method name. For example, if the original method name
3051 # is `TakeSnapshot()`, the inferred response type is
3052 # `TakeSnapshotResponse`.
3053 "a_key": "", # Properties of the object. Contains field @type with type URL.
3054 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3055 "metadata": { # Service-specific metadata associated with the operation. It typically
3056 # contains progress information and common metadata such as create time.
3057 # Some services might not provide such metadata. Any method that returns a
3058 # long-running operation should document the metadata type, if any.
3059 "a_key": "", # Properties of the object. Contains field @type with type URL.
3060 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]3061 "done": True or False, # If the value is `false`, it means the operation is still in progress.
3062 # If `true`, the operation is completed, and either `error` or `response` is
3063 # available.
3064 "name": "A String", # The server-assigned name, which is only unique within the same service that
3065 # originally returns it. If you use the default HTTP mapping, the
3066 # `name` should be a resource name ending with `operations/{unique_id}`.
3067 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
3068 # different programming environments, including REST APIs and RPC APIs. It is
3069 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3070 # three pieces of data: error code, error message, and error details.
3071 #
3072 # You can find out more about this error model and how to work with it in the
3073 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3074 "message": "A String", # A developer-facing error message, which should be in English. Any
3075 # user-facing error message should be localized and sent in the
3076 # google.rpc.Status.details field, or localized by the client.
3077 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
3078 "details": [ # A list of messages that carry the error details. There is a common set of
3079 # message types for APIs to use.
3080 {
3081 "a_key": "", # Properties of the object. Contains field @type with type URL.
3082 },
3083 ],
3084 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]3085 }</pre>
3086</div>
3087
3088</body></html>