blob: f6006ca70b59cd8c84baf4d11d0db48dfb17f664 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001<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
75<h1><a href="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.services.html">services</a></h1>
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">
83 <code><a href="servicemanagement_v1.services.rollouts.html">rollouts()</a></code>
84</p>
85<p class="firstline">Returns the rollouts Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
89<p class="firstline">Creates a new managed service.</p>
90<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070091 <code><a href="#delete">delete(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080092<p class="firstline">Deletes a managed service. This method will change the service to the</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070093<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070094 <code><a href="#disable">disable(serviceName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040095<p class="firstline">Disables a service for a project, so it can no longer be</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070096<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070097 <code><a href="#enable">enable(serviceName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040098<p class="firstline">Enables a service for a project, so it can be used</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070099<p class="toc_element">
100 <code><a href="#generateConfigReport">generateConfigReport(body, x__xgafv=None)</a></code></p>
101<p class="firstline">Generates and returns a report (errors, warnings and changes from</p>
102<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700103 <code><a href="#get">get(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800104<p class="firstline">Gets a managed service. Authentication is required unless the service is</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700105<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700106 <code><a href="#getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700107<p class="firstline">Gets a service configuration (version) for a managed service.</p>
108<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700109 <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700110<p class="firstline">Gets the access control policy for a resource.</p>
111<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400112 <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 -0800113<p class="firstline">Lists managed services.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700114<p class="toc_element">
115 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
116<p class="firstline">Retrieves the next page of results.</p>
117<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700118 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700119<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
120<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700121 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700122<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
123<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700124 <code><a href="#undelete">undelete(serviceName, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700125<p class="firstline">Revives a previously deleted managed service. The method restores the</p>
126<h3>Method Details</h3>
127<div class="method">
128 <code class="details" id="create">create(body, x__xgafv=None)</code>
129 <pre>Creates a new managed service.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700130Please note one producer project can own no more than 20 services.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700131
132Operation<response: ManagedService>
133
134Args:
135 body: object, The request body. (required)
136 The object takes the form of:
137
138{ # The full representation of a Service that is managed by
139 # Google Service Management.
140 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
141 # for naming requirements.
142 "producerProjectId": "A String", # ID of the project that produces and owns this service.
143}
144
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # This resource represents a long-running operation that is the result of a
154 # network API call.
155 "metadata": { # Service-specific metadata associated with the operation. It typically
156 # contains progress information and common metadata such as create time.
157 # Some services might not provide such metadata. Any method that returns a
158 # long-running operation should document the metadata type, if any.
159 "a_key": "", # Properties of the object. Contains field @type with type URL.
160 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700161 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700162 # programming environments, including REST APIs and RPC APIs. It is used by
163 # [gRPC](https://github.com/grpc). The error model is designed to be:
164 #
165 # - Simple to use and understand for most users
166 # - Flexible enough to meet unexpected needs
167 #
168 # # Overview
169 #
170 # The `Status` message contains three pieces of data: error code, error message,
171 # and error details. The error code should be an enum value of
172 # google.rpc.Code, but it may accept additional error codes if needed. The
173 # error message should be a developer-facing English message that helps
174 # developers *understand* and *resolve* the error. If a localized user-facing
175 # error message is needed, put the localized message in the error details or
176 # localize it in the client. The optional error details may contain arbitrary
177 # information about the error. There is a predefined set of error detail types
178 # in the package `google.rpc` which can be used for common error conditions.
179 #
180 # # Language mapping
181 #
182 # The `Status` message is the logical representation of the error model, but it
183 # is not necessarily the actual wire format. When the `Status` message is
184 # exposed in different client libraries and different wire protocols, it can be
185 # mapped differently. For example, it will likely be mapped to some exceptions
186 # in Java, but more likely mapped to some error codes in C.
187 #
188 # # Other uses
189 #
190 # The error model and the `Status` message can be used in a variety of
191 # environments, either with or without APIs, to provide a
192 # consistent developer experience across different environments.
193 #
194 # Example uses of this error model include:
195 #
196 # - Partial errors. If a service needs to return partial errors to the client,
197 # it may embed the `Status` in the normal response to indicate the partial
198 # errors.
199 #
200 # - Workflow errors. A typical workflow has multiple steps. Each step may
201 # have a `Status` message for error reporting purpose.
202 #
203 # - Batch operations. If a client uses batch request and batch response, the
204 # `Status` message should be used directly inside batch response, one for
205 # each error sub-response.
206 #
207 # - Asynchronous operations. If an API call embeds asynchronous operation
208 # results in its response, the status of those operations should be
209 # represented directly using the `Status` message.
210 #
211 # - Logging. If some API errors are stored in logs, the message `Status` could
212 # be used directly after any stripping needed for security/privacy reasons.
213 "message": "A String", # A developer-facing error message, which should be in English. Any
214 # user-facing error message should be localized and sent in the
215 # google.rpc.Status.details field, or localized by the client.
216 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
217 "details": [ # A list of messages that carry the error details. There will be a
218 # common set of message types for APIs to use.
219 {
220 "a_key": "", # Properties of the object. Contains field @type with type URL.
221 },
222 ],
223 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400224 "done": True or False, # If the value is `false`, it means the operation is still in progress.
225 # If true, the operation is completed, and either `error` or `response` is
226 # available.
227 "response": { # The normal response of the operation in case of success. If the original
228 # method returns no data on success, such as `Delete`, the response is
229 # `google.protobuf.Empty`. If the original method is standard
230 # `Get`/`Create`/`Update`, the response should be the resource. For other
231 # methods, the response should have the type `XxxResponse`, where `Xxx`
232 # is the original method name. For example, if the original method name
233 # is `TakeSnapshot()`, the inferred response type is
234 # `TakeSnapshotResponse`.
235 "a_key": "", # Properties of the object. Contains field @type with type URL.
236 },
237 "name": "A String", # The server-assigned name, which is only unique within the same service that
238 # originally returns it. If you use the default HTTP mapping, the
239 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700240 }</pre>
241</div>
242
243<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700244 <code class="details" id="delete">delete(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800245 <pre>Deletes a managed service. This method will change the service to the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700246`Soft-Delete` state for 30 days. Within this period, service producers may
247call UndeleteService to restore the service.
248After 30 days, the service will be permanently deleted.
249
250Operation<response: google.protobuf.Empty>
251
252Args:
253 serviceName: string, The name of the service. See the [overview](/service-management/overview)
254for naming requirements. For example: `example.googleapis.com`. (required)
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 { # This resource represents a long-running operation that is the result of a
264 # network API call.
265 "metadata": { # Service-specific metadata associated with the operation. It typically
266 # contains progress information and common metadata such as create time.
267 # Some services might not provide such metadata. Any method that returns a
268 # long-running operation should document the metadata type, if any.
269 "a_key": "", # Properties of the object. Contains field @type with type URL.
270 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700271 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700272 # programming environments, including REST APIs and RPC APIs. It is used by
273 # [gRPC](https://github.com/grpc). The error model is designed to be:
274 #
275 # - Simple to use and understand for most users
276 # - Flexible enough to meet unexpected needs
277 #
278 # # Overview
279 #
280 # The `Status` message contains three pieces of data: error code, error message,
281 # and error details. The error code should be an enum value of
282 # google.rpc.Code, but it may accept additional error codes if needed. The
283 # error message should be a developer-facing English message that helps
284 # developers *understand* and *resolve* the error. If a localized user-facing
285 # error message is needed, put the localized message in the error details or
286 # localize it in the client. The optional error details may contain arbitrary
287 # information about the error. There is a predefined set of error detail types
288 # in the package `google.rpc` which can be used for common error conditions.
289 #
290 # # Language mapping
291 #
292 # The `Status` message is the logical representation of the error model, but it
293 # is not necessarily the actual wire format. When the `Status` message is
294 # exposed in different client libraries and different wire protocols, it can be
295 # mapped differently. For example, it will likely be mapped to some exceptions
296 # in Java, but more likely mapped to some error codes in C.
297 #
298 # # Other uses
299 #
300 # The error model and the `Status` message can be used in a variety of
301 # environments, either with or without APIs, to provide a
302 # consistent developer experience across different environments.
303 #
304 # Example uses of this error model include:
305 #
306 # - Partial errors. If a service needs to return partial errors to the client,
307 # it may embed the `Status` in the normal response to indicate the partial
308 # errors.
309 #
310 # - Workflow errors. A typical workflow has multiple steps. Each step may
311 # have a `Status` message for error reporting purpose.
312 #
313 # - Batch operations. If a client uses batch request and batch response, the
314 # `Status` message should be used directly inside batch response, one for
315 # each error sub-response.
316 #
317 # - Asynchronous operations. If an API call embeds asynchronous operation
318 # results in its response, the status of those operations should be
319 # represented directly using the `Status` message.
320 #
321 # - Logging. If some API errors are stored in logs, the message `Status` could
322 # be used directly after any stripping needed for security/privacy reasons.
323 "message": "A String", # A developer-facing error message, which should be in English. Any
324 # user-facing error message should be localized and sent in the
325 # google.rpc.Status.details field, or localized by the client.
326 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
327 "details": [ # A list of messages that carry the error details. There will be a
328 # common set of message types for APIs to use.
329 {
330 "a_key": "", # Properties of the object. Contains field @type with type URL.
331 },
332 ],
333 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400334 "done": True or False, # If the value is `false`, it means the operation is still in progress.
335 # If true, the operation is completed, and either `error` or `response` is
336 # available.
337 "response": { # The normal response of the operation in case of success. If the original
338 # method returns no data on success, such as `Delete`, the response is
339 # `google.protobuf.Empty`. If the original method is standard
340 # `Get`/`Create`/`Update`, the response should be the resource. For other
341 # methods, the response should have the type `XxxResponse`, where `Xxx`
342 # is the original method name. For example, if the original method name
343 # is `TakeSnapshot()`, the inferred response type is
344 # `TakeSnapshotResponse`.
345 "a_key": "", # Properties of the object. Contains field @type with type URL.
346 },
347 "name": "A String", # The server-assigned name, which is only unique within the same service that
348 # originally returns it. If you use the default HTTP mapping, the
349 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700350 }</pre>
351</div>
352
353<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700354 <code class="details" id="disable">disable(serviceName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400355 <pre>Disables a service for a project, so it can no longer be
356be used for the project. It prevents accidental usage that may cause
357unexpected billing charges or security leaks.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700358
359Operation<response: DisableServiceResponse>
360
361Args:
362 serviceName: string, Name of the service to disable. Specifying an unknown service name
363will cause the request to fail. (required)
364 body: object, The request body. (required)
365 The object takes the form of:
366
367{ # Request message for DisableService method.
368 "consumerId": "A String", # The identity of consumer resource which service disablement will be
369 # applied to.
370 #
371 # The Google Service Management implementation accepts the following
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800372 # forms:
373 # - "project:<project_id>"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700374 #
375 # Note: this is made compatible with
376 # google.api.servicecontrol.v1.Operation.consumer_id.
377 }
378
379 x__xgafv: string, V1 error format.
380 Allowed values
381 1 - v1 error format
382 2 - v2 error format
383
384Returns:
385 An object of the form:
386
387 { # This resource represents a long-running operation that is the result of a
388 # network API call.
389 "metadata": { # Service-specific metadata associated with the operation. It typically
390 # contains progress information and common metadata such as create time.
391 # Some services might not provide such metadata. Any method that returns a
392 # long-running operation should document the metadata type, if any.
393 "a_key": "", # Properties of the object. Contains field @type with type URL.
394 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700395 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700396 # programming environments, including REST APIs and RPC APIs. It is used by
397 # [gRPC](https://github.com/grpc). The error model is designed to be:
398 #
399 # - Simple to use and understand for most users
400 # - Flexible enough to meet unexpected needs
401 #
402 # # Overview
403 #
404 # The `Status` message contains three pieces of data: error code, error message,
405 # and error details. The error code should be an enum value of
406 # google.rpc.Code, but it may accept additional error codes if needed. The
407 # error message should be a developer-facing English message that helps
408 # developers *understand* and *resolve* the error. If a localized user-facing
409 # error message is needed, put the localized message in the error details or
410 # localize it in the client. The optional error details may contain arbitrary
411 # information about the error. There is a predefined set of error detail types
412 # in the package `google.rpc` which can be used for common error conditions.
413 #
414 # # Language mapping
415 #
416 # The `Status` message is the logical representation of the error model, but it
417 # is not necessarily the actual wire format. When the `Status` message is
418 # exposed in different client libraries and different wire protocols, it can be
419 # mapped differently. For example, it will likely be mapped to some exceptions
420 # in Java, but more likely mapped to some error codes in C.
421 #
422 # # Other uses
423 #
424 # The error model and the `Status` message can be used in a variety of
425 # environments, either with or without APIs, to provide a
426 # consistent developer experience across different environments.
427 #
428 # Example uses of this error model include:
429 #
430 # - Partial errors. If a service needs to return partial errors to the client,
431 # it may embed the `Status` in the normal response to indicate the partial
432 # errors.
433 #
434 # - Workflow errors. A typical workflow has multiple steps. Each step may
435 # have a `Status` message for error reporting purpose.
436 #
437 # - Batch operations. If a client uses batch request and batch response, the
438 # `Status` message should be used directly inside batch response, one for
439 # each error sub-response.
440 #
441 # - Asynchronous operations. If an API call embeds asynchronous operation
442 # results in its response, the status of those operations should be
443 # represented directly using the `Status` message.
444 #
445 # - Logging. If some API errors are stored in logs, the message `Status` could
446 # be used directly after any stripping needed for security/privacy reasons.
447 "message": "A String", # A developer-facing error message, which should be in English. Any
448 # user-facing error message should be localized and sent in the
449 # google.rpc.Status.details field, or localized by the client.
450 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
451 "details": [ # A list of messages that carry the error details. There will be a
452 # common set of message types for APIs to use.
453 {
454 "a_key": "", # Properties of the object. Contains field @type with type URL.
455 },
456 ],
457 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400458 "done": True or False, # If the value is `false`, it means the operation is still in progress.
459 # If true, the operation is completed, and either `error` or `response` is
460 # available.
461 "response": { # The normal response of the operation in case of success. If the original
462 # method returns no data on success, such as `Delete`, the response is
463 # `google.protobuf.Empty`. If the original method is standard
464 # `Get`/`Create`/`Update`, the response should be the resource. For other
465 # methods, the response should have the type `XxxResponse`, where `Xxx`
466 # is the original method name. For example, if the original method name
467 # is `TakeSnapshot()`, the inferred response type is
468 # `TakeSnapshotResponse`.
469 "a_key": "", # Properties of the object. Contains field @type with type URL.
470 },
471 "name": "A String", # The server-assigned name, which is only unique within the same service that
472 # originally returns it. If you use the default HTTP mapping, the
473 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700474 }</pre>
475</div>
476
477<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700478 <code class="details" id="enable">enable(serviceName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400479 <pre>Enables a service for a project, so it can be used
480for the project. See
481[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
482more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700483
484Operation<response: EnableServiceResponse>
485
486Args:
487 serviceName: string, Name of the service to enable. Specifying an unknown service name will
488cause the request to fail. (required)
489 body: object, The request body. (required)
490 The object takes the form of:
491
492{ # Request message for EnableService method.
493 "consumerId": "A String", # The identity of consumer resource which service enablement will be
494 # applied to.
495 #
496 # The Google Service Management implementation accepts the following
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800497 # forms:
498 # - "project:<project_id>"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700499 #
500 # Note: this is made compatible with
501 # google.api.servicecontrol.v1.Operation.consumer_id.
502 }
503
504 x__xgafv: string, V1 error format.
505 Allowed values
506 1 - v1 error format
507 2 - v2 error format
508
509Returns:
510 An object of the form:
511
512 { # This resource represents a long-running operation that is the result of a
513 # network API call.
514 "metadata": { # Service-specific metadata associated with the operation. It typically
515 # contains progress information and common metadata such as create time.
516 # Some services might not provide such metadata. Any method that returns a
517 # long-running operation should document the metadata type, if any.
518 "a_key": "", # Properties of the object. Contains field @type with type URL.
519 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700520 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700521 # programming environments, including REST APIs and RPC APIs. It is used by
522 # [gRPC](https://github.com/grpc). The error model is designed to be:
523 #
524 # - Simple to use and understand for most users
525 # - Flexible enough to meet unexpected needs
526 #
527 # # Overview
528 #
529 # The `Status` message contains three pieces of data: error code, error message,
530 # and error details. The error code should be an enum value of
531 # google.rpc.Code, but it may accept additional error codes if needed. The
532 # error message should be a developer-facing English message that helps
533 # developers *understand* and *resolve* the error. If a localized user-facing
534 # error message is needed, put the localized message in the error details or
535 # localize it in the client. The optional error details may contain arbitrary
536 # information about the error. There is a predefined set of error detail types
537 # in the package `google.rpc` which can be used for common error conditions.
538 #
539 # # Language mapping
540 #
541 # The `Status` message is the logical representation of the error model, but it
542 # is not necessarily the actual wire format. When the `Status` message is
543 # exposed in different client libraries and different wire protocols, it can be
544 # mapped differently. For example, it will likely be mapped to some exceptions
545 # in Java, but more likely mapped to some error codes in C.
546 #
547 # # Other uses
548 #
549 # The error model and the `Status` message can be used in a variety of
550 # environments, either with or without APIs, to provide a
551 # consistent developer experience across different environments.
552 #
553 # Example uses of this error model include:
554 #
555 # - Partial errors. If a service needs to return partial errors to the client,
556 # it may embed the `Status` in the normal response to indicate the partial
557 # errors.
558 #
559 # - Workflow errors. A typical workflow has multiple steps. Each step may
560 # have a `Status` message for error reporting purpose.
561 #
562 # - Batch operations. If a client uses batch request and batch response, the
563 # `Status` message should be used directly inside batch response, one for
564 # each error sub-response.
565 #
566 # - Asynchronous operations. If an API call embeds asynchronous operation
567 # results in its response, the status of those operations should be
568 # represented directly using the `Status` message.
569 #
570 # - Logging. If some API errors are stored in logs, the message `Status` could
571 # be used directly after any stripping needed for security/privacy reasons.
572 "message": "A String", # A developer-facing error message, which should be in English. Any
573 # user-facing error message should be localized and sent in the
574 # google.rpc.Status.details field, or localized by the client.
575 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
576 "details": [ # A list of messages that carry the error details. There will be a
577 # common set of message types for APIs to use.
578 {
579 "a_key": "", # Properties of the object. Contains field @type with type URL.
580 },
581 ],
582 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400583 "done": True or False, # If the value is `false`, it means the operation is still in progress.
584 # If true, the operation is completed, and either `error` or `response` is
585 # available.
586 "response": { # The normal response of the operation in case of success. If the original
587 # method returns no data on success, such as `Delete`, the response is
588 # `google.protobuf.Empty`. If the original method is standard
589 # `Get`/`Create`/`Update`, the response should be the resource. For other
590 # methods, the response should have the type `XxxResponse`, where `Xxx`
591 # is the original method name. For example, if the original method name
592 # is `TakeSnapshot()`, the inferred response type is
593 # `TakeSnapshotResponse`.
594 "a_key": "", # Properties of the object. Contains field @type with type URL.
595 },
596 "name": "A String", # The server-assigned name, which is only unique within the same service that
597 # originally returns it. If you use the default HTTP mapping, the
598 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700599 }</pre>
600</div>
601
602<div class="method">
603 <code class="details" id="generateConfigReport">generateConfigReport(body, x__xgafv=None)</code>
604 <pre>Generates and returns a report (errors, warnings and changes from
605existing configurations) associated with
606GenerateConfigReportRequest.new_value
607
608If GenerateConfigReportRequest.old_value is specified,
609GenerateConfigReportRequest will contain a single ChangeReport based on the
610comparison between GenerateConfigReportRequest.new_value and
611GenerateConfigReportRequest.old_value.
612If GenerateConfigReportRequest.old_value is not specified, this method
613will compare GenerateConfigReportRequest.new_value with the last pushed
614service configuration.
615
616Args:
617 body: object, The request body. (required)
618 The object takes the form of:
619
620{ # Request message for GenerateConfigReport method.
621 "newConfig": { # Service configuration for which we want to generate the report.
622 # For this version of API, the supported types are
623 # google.api.servicemanagement.v1.ConfigRef,
624 # google.api.servicemanagement.v1.ConfigSource,
625 # and google.api.Service
626 "a_key": "", # Properties of the object. Contains field @type with type URL.
627 },
628 "oldConfig": { # Service configuration against which the comparison will be done.
629 # For this version of API, the supported types are
630 # google.api.servicemanagement.v1.ConfigRef,
631 # google.api.servicemanagement.v1.ConfigSource,
632 # and google.api.Service
633 "a_key": "", # Properties of the object. Contains field @type with type URL.
634 },
635 }
636
637 x__xgafv: string, V1 error format.
638 Allowed values
639 1 - v1 error format
640 2 - v2 error format
641
642Returns:
643 An object of the form:
644
645 { # Response message for GenerateConfigReport method.
646 "serviceName": "A String", # Name of the service this report belongs to.
647 "changeReports": [ # list of ChangeReport, each corresponding to comparison between two
648 # service configurations.
649 { # Change report associated with a particular service configuration.
650 #
651 # It contains a list of ConfigChanges based on the comparison between
652 # two service configurations.
653 "configChanges": [ # List of changes between two service configurations.
654 # The changes will be alphabetically sorted based on the identifier
655 # of each change.
656 # A ConfigChange identifier is a dot separated path to the configuration.
657 # Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
658 { # Output generated from semantically comparing two versions of a service
659 # configuration.
660 #
661 # Includes detailed information about a field that have changed with
662 # applicable advice about potential consequences for the change, such as
663 # backwards-incompatibility.
664 "advices": [ # Collection of advice provided for this change, useful for determining the
665 # possible impact of this change.
666 { # Generated advice about this change, used for providing more
667 # information about how a change will affect the existing service.
668 "description": "A String", # Useful description for why this advice was applied and what actions should
669 # be taken to mitigate any implied risks.
670 },
671 ],
672 "changeType": "A String", # The type for this change, either ADDED, REMOVED, or MODIFIED.
673 "newValue": "A String", # Value of the changed object in the new Service configuration,
674 # in JSON format. This field will not be populated if ChangeType == REMOVED.
675 "oldValue": "A String", # Value of the changed object in the old Service configuration,
676 # in JSON format. This field will not be populated if ChangeType == ADDED.
677 "element": "A String", # Object hierarchy path to the change, with levels separated by a '.'
678 # character. For repeated fields, an applicable unique identifier field is
679 # used for the index (usually selector, name, or id). For maps, the term
680 # 'key' is used. If the field has no unique identifier, the numeric index
681 # is used.
682 # Examples:
683 # - visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
684 # - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
685 # - logging.producer_destinations[0]
686 },
687 ],
688 },
689 ],
690 "id": "A String", # ID of the service configuration this report belongs to.
691 "diagnostics": [ # Errors / Linter warnings associated with the service definition this
692 # report
693 # belongs to.
694 { # Represents a diagnostic message (error or warning)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700695 "kind": "A String", # The kind of diagnostic information provided.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700696 "message": "A String", # Message describing the error or warning.
697 "location": "A String", # File name and line number of the error or warning.
698 },
699 ],
700 }</pre>
701</div>
702
703<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700704 <code class="details" id="get">get(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800705 <pre>Gets a managed service. Authentication is required unless the service is
706public.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700707
708Args:
709 serviceName: string, The name of the service. See the `ServiceManager` overview for naming
710requirements. For example: `example.googleapis.com`. (required)
711 x__xgafv: string, V1 error format.
712 Allowed values
713 1 - v1 error format
714 2 - v2 error format
715
716Returns:
717 An object of the form:
718
719 { # The full representation of a Service that is managed by
720 # Google Service Management.
721 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
722 # for naming requirements.
723 "producerProjectId": "A String", # ID of the project that produces and owns this service.
724 }</pre>
725</div>
726
727<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700728 <code class="details" id="getConfig">getConfig(serviceName, configId=None, x__xgafv=None, view=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700729 <pre>Gets a service configuration (version) for a managed service.
730
731Args:
732 serviceName: string, The name of the service. See the [overview](/service-management/overview)
733for naming requirements. For example: `example.googleapis.com`. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800734 configId: string, The id of the service configuration resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700735 x__xgafv: string, V1 error format.
736 Allowed values
737 1 - v1 error format
738 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400739 view: string, Specifies which parts of the Service Config should be returned in the
740response.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700741
742Returns:
743 An object of the form:
744
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700745 { # `Service` is the root object of Google service configuration schema. It
746 # describes basic information about a service, such as the name and the
747 # title, and delegates other aspects to sub-sections. Each sub-section is
748 # either a proto message or a repeated proto message that configures a
749 # specific aspect, such as auth. See each proto message definition for details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700750 #
751 # Example:
752 #
753 # type: google.api.Service
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700754 # config_version: 3
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700755 # name: calendar.googleapis.com
756 # title: Google Calendar API
757 # apis:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700758 # - name: google.calendar.v3.Calendar
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800759 # authentication:
760 # providers:
761 # - id: google_calendar_auth
762 # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
763 # issuer: https://securetoken.google.com
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700764 # rules:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800765 # - selector: "*"
766 # requirements:
767 # provider_id: google_calendar_auth
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700768 "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
769 # service controller handles features like abuse, quota, billing, logging,
770 # monitoring, etc.
771 "environment": "A String", # The service control environment to use. If empty, no control plane
772 # feature (like quota and billing) will be enabled.
773 },
774 "monitoredResources": [ # Defines the monitored resources used by this service. This is required
775 # by the Service.monitoring and Service.logging configurations.
776 { # An object that describes the schema of a MonitoredResource object using a
777 # type name and a set of labels. For example, the monitored resource
778 # descriptor for Google Compute Engine VM instances has a type of
779 # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
780 # `"zone"` to identify particular VM instances.
781 #
782 # Different APIs can support different monitored resource types. APIs generally
783 # provide a `list` method that returns the monitored resource descriptors used
784 # by the API.
Thomas Coffee2f245372017-03-27 10:39:26 -0700785 "type": "A String", # Required. The monitored resource type. For example, the type
786 # `"cloudsql_database"` represents databases in Google Cloud SQL.
787 # The maximum length of this value is 256 characters.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700788 "labels": [ # Required. A set of labels used to describe instances of this monitored
789 # resource type. For example, an individual Google Cloud SQL database is
790 # identified by values for the labels `"database_id"` and `"zone"`.
791 { # A description of a label.
792 "valueType": "A String", # The type of data that can be assigned to the label.
793 "description": "A String", # A human-readable description for the label.
794 "key": "A String", # The label key.
795 },
796 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700797 "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
798 # displayed in user interfaces. It should be a Title Cased Noun Phrase,
799 # without any article or other determiners. For example,
800 # `"Google Cloud SQL Database"`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700801 "name": "A String", # Optional. The resource name of the monitored resource descriptor:
802 # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
803 # {type} is the value of the `type` field in this object and
804 # {project_id} is a project ID that provides API-specific context for
805 # accessing the type. APIs that do not use project information can use the
806 # resource name format `"monitoredResourceDescriptors/{type}"`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400807 "description": "A String", # Optional. A detailed description of the monitored resource type that might
808 # be used in documentation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700809 },
810 ],
811 "logs": [ # Defines the logs used by this service.
812 { # A description of a log type. Example in YAML format:
813 #
814 # - name: library.googleapis.com/activity_history
815 # description: The history of borrowing and returning library items.
816 # display_name: Activity
817 # labels:
818 # - key: /customer_id
819 # description: Identifier of a library customer
820 "labels": [ # The set of labels that are available to describe a specific log entry.
821 # Runtime requests that contain labels not specified here are
822 # considered invalid.
823 { # A description of a label.
824 "valueType": "A String", # The type of data that can be assigned to the label.
825 "description": "A String", # A human-readable description for the label.
826 "key": "A String", # The label key.
827 },
828 ],
829 "displayName": "A String", # The human-readable name for this log. This information appears on
830 # the user interface and should be concise.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700831 "name": "A String", # The name of the log. It must be less than 512 characters long and can
832 # include the following characters: upper- and lower-case alphanumeric
833 # characters [A-Za-z0-9], and punctuation characters including
834 # slash, underscore, hyphen, period [/_-.].
Thomas Coffee2f245372017-03-27 10:39:26 -0700835 "description": "A String", # A human-readable description of this log. This information appears in
836 # the documentation and can contain details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700837 },
838 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700839 "systemParameters": { # ### System parameter configuration # System parameter configuration.
840 #
841 # A system parameter is a special kind of parameter defined by the API
842 # system, not by an individual API. It is typically mapped to an HTTP header
843 # and/or a URL query parameter. This configuration specifies which methods
844 # change the names of the system parameters.
845 "rules": [ # Define system parameters.
846 #
847 # The parameters defined here will override the default parameters
848 # implemented by the system. If this field is missing from the service
849 # config, default system parameters will be used. Default system parameters
850 # and names is implementation-dependent.
851 #
852 # Example: define api key for all methods
853 #
854 # system_parameters
855 # rules:
856 # - selector: "*"
857 # parameters:
858 # - name: api_key
859 # url_query_parameter: api_key
860 #
861 #
862 # Example: define 2 api key names for a specific method.
863 #
864 # system_parameters
865 # rules:
866 # - selector: "/ListShelves"
867 # parameters:
868 # - name: api_key
869 # http_header: Api-Key1
870 # - name: api_key
871 # http_header: Api-Key2
872 #
873 # **NOTE:** All service configuration rules follow "last one wins" order.
874 { # Define a system parameter rule mapping system parameter definitions to
875 # methods.
876 "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
877 # For a given method call, only one of them should be used. If multiple
878 # names are used the behavior is implementation-dependent.
879 # If none of the specified names are present the behavior is
880 # parameter-dependent.
881 { # Define a parameter's name and location. The parameter may be passed as either
882 # an HTTP header or a URL query parameter, and if both are passed the behavior
883 # is implementation-dependent.
884 "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
885 # sensitive.
886 "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
887 # insensitive.
888 "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
889 },
890 ],
891 "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
892 # methods in all APIs.
893 #
894 # Refer to selector for syntax details.
895 },
896 ],
897 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700898 "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
899 "rules": [ # A list of API backend rules that apply to individual API methods.
900 #
901 # **NOTE:** All service configuration rules follow "last one wins" order.
902 { # A backend rule provides configuration for an individual API element.
903 "selector": "A String", # Selects the methods to which this rule applies.
904 #
905 # Refer to selector for syntax details.
906 "deadline": 3.14, # The number of seconds to wait for a response from a request. The
907 # default depends on the deployment context.
908 "address": "A String", # The address of the API backend.
909 },
910 ],
911 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700912 "monitoring": { # Monitoring configuration of the service. # Monitoring configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700913 #
914 # The example below shows how to configure monitored resources and metrics
915 # for monitoring. In the example, a monitored resource and two metrics are
916 # defined. The `library.googleapis.com/book/returned_count` metric is sent
917 # to both producer and consumer projects, whereas the
918 # `library.googleapis.com/book/overdue_count` metric is only sent to the
919 # consumer project.
920 #
921 # monitored_resources:
922 # - type: library.googleapis.com/branch
923 # labels:
924 # - key: /city
925 # description: The city where the library branch is located in.
926 # - key: /name
927 # description: The name of the branch.
928 # metrics:
929 # - name: library.googleapis.com/book/returned_count
930 # metric_kind: DELTA
931 # value_type: INT64
932 # labels:
933 # - key: /customer_id
934 # - name: library.googleapis.com/book/overdue_count
935 # metric_kind: GAUGE
936 # value_type: INT64
937 # labels:
938 # - key: /customer_id
939 # monitoring:
940 # producer_destinations:
941 # - monitored_resource: library.googleapis.com/branch
942 # metrics:
943 # - library.googleapis.com/book/returned_count
944 # consumer_destinations:
945 # - monitored_resource: library.googleapis.com/branch
946 # metrics:
947 # - library.googleapis.com/book/returned_count
948 # - library.googleapis.com/book/overdue_count
949 "producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.
950 # There can be multiple producer destinations, each one must have a
951 # different monitored resource type. A metric can be used in at most
952 # one producer destination.
953 { # Configuration of a specific monitoring destination (the producer project
954 # or the consumer project).
955 "monitoredResource": "A String", # The monitored resource type. The type must be defined in
956 # Service.monitored_resources section.
957 "metrics": [ # Names of the metrics to report to this monitoring destination.
958 # Each name must be defined in Service.metrics section.
959 "A String",
960 ],
961 },
962 ],
963 "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
964 # There can be multiple consumer destinations, each one must have a
965 # different monitored resource type. A metric can be used in at most
966 # one consumer destination.
967 { # Configuration of a specific monitoring destination (the producer project
968 # or the consumer project).
969 "monitoredResource": "A String", # The monitored resource type. The type must be defined in
970 # Service.monitored_resources section.
971 "metrics": [ # Names of the metrics to report to this monitoring destination.
972 # Each name must be defined in Service.metrics section.
973 "A String",
974 ],
975 },
976 ],
977 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700978 "title": "A String", # The product title associated with this service.
979 "id": "A String", # A unique ID for a specific instance of this message, typically assigned
980 # by the client for tracking purpose. If empty, the server may choose to
981 # generate one instead.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700982 "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
983 #
984 # Example for an API targeted for external use:
985 #
986 # name: calendar.googleapis.com
987 # authentication:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800988 # providers:
989 # - id: google_calendar_auth
990 # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
991 # issuer: https://securetoken.google.com
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700992 # rules:
993 # - selector: "*"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800994 # requirements:
995 # provider_id: google_calendar_auth
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700996 "rules": [ # A list of authentication rules that apply to individual API methods.
997 #
998 # **NOTE:** All service configuration rules follow "last one wins" order.
999 { # Authentication rules for the service.
1000 #
1001 # By default, if a method has any authentication requirements, every request
1002 # must include a valid credential matching one of the requirements.
1003 # It's an error to include more than one kind of credential in a single
1004 # request.
1005 #
1006 # If a method doesn't have any auth requirements, request credentials will be
1007 # ignored.
1008 "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
1009 # there are scopes defined for "Read-only access to Google Calendar" and
1010 # "Access to Cloud Platform". Users can consent to a scope for an application,
1011 # giving it permission to access that data on their behalf.
1012 #
1013 # OAuth scope specifications should be fairly coarse grained; a user will need
1014 # to see and understand the text description of what your scope means.
1015 #
1016 # In most cases: use one or at most two OAuth scopes for an entire family of
1017 # products. If your product has multiple APIs, you should probably be sharing
1018 # the OAuth scope across all of those APIs.
1019 #
1020 # When you need finer grained OAuth consent screens: talk with your product
1021 # management about how developers will use them in practice.
1022 #
1023 # Please note that even though each of the canonical scopes is enough for a
1024 # request to be accepted and passed to the backend, a request can still fail
1025 # due to the backend requiring additional scopes or permissions.
1026 "canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An
1027 # OAuth token containing any of these scopes will be accepted.
1028 #
1029 # Example:
1030 #
1031 # canonical_scopes: https://www.googleapis.com/auth/calendar,
1032 # https://www.googleapis.com/auth/calendar.read
1033 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001034 "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
1035 # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
1036 #
1037 # For requests without credentials, if the service control environment is
1038 # specified, each incoming request **must** be associated with a service
1039 # consumer. This can be done by passing an API key that belongs to a consumer
1040 # project.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001041 "requirements": [ # Requirements for additional authentication providers.
1042 { # User-defined authentication requirements, including support for
1043 # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
1044 "providerId": "A String", # id from authentication provider.
1045 #
1046 # Example:
1047 #
1048 # provider_id: bookstore_auth
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001049 "audiences": "A String", # NOTE: This will be deprecated soon, once AuthProvider.audiences is
1050 # implemented and accepted in all the runtime components.
1051 #
1052 # The list of JWT
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001053 # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
1054 # that are allowed to access. A JWT containing any of these audiences will
1055 # be accepted. When this setting is absent, only JWTs with audience
1056 # "https://Service_name/API_name"
1057 # will be accepted. For example, if no audiences are in the setting,
1058 # LibraryService API will only accept JWTs with the following audience
1059 # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
1060 #
1061 # Example:
1062 #
1063 # audiences: bookstore_android.apps.googleusercontent.com,
1064 # bookstore_web.apps.googleusercontent.com
1065 },
1066 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001067 "selector": "A String", # Selects the methods to which this rule applies.
1068 #
1069 # Refer to selector for syntax details.
1070 },
1071 ],
1072 "providers": [ # Defines a set of authentication providers that a service supports.
1073 { # Configuration for an anthentication provider, including support for
1074 # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001075 "audiences": "A String", # The list of JWT
1076 # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
1077 # that are allowed to access. A JWT containing any of these audiences will
1078 # be accepted. When this setting is absent, only JWTs with audience
1079 # "https://Service_name/API_name"
1080 # will be accepted. For example, if no audiences are in the setting,
1081 # LibraryService API will only accept JWTs with the following audience
1082 # "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
1083 #
1084 # Example:
1085 #
1086 # audiences: bookstore_android.apps.googleusercontent.com,
1087 # bookstore_web.apps.googleusercontent.com
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001088 "jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See
1089 # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
1090 # Optional if the key set document:
1091 # - can be retrieved from
1092 # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
1093 # of the issuer.
1094 # - can be inferred from the email domain of the issuer (e.g. a Google service account).
1095 #
1096 # Example: https://www.googleapis.com/oauth2/v1/certs
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001097 "id": "A String", # The unique identifier of the auth provider. It will be referred to by
1098 # `AuthRequirement.provider_id`.
1099 #
1100 # Example: "bookstore_auth".
1101 "issuer": "A String", # Identifies the principal that issued the JWT. See
1102 # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
1103 # Usually a URL or an email address.
1104 #
1105 # Example: https://securetoken.google.com
1106 # Example: 1234567-compute@developer.gserviceaccount.com
1107 },
1108 ],
1109 },
1110 "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
1111 "rules": [ # A list of usage rules that apply to individual API methods.
1112 #
1113 # **NOTE:** All service configuration rules follow "last one wins" order.
1114 { # Usage configuration rules for the service.
1115 #
1116 # NOTE: Under development.
1117 #
1118 #
1119 # Use this rule to configure unregistered calls for the service. Unregistered
1120 # calls are calls that do not contain consumer project identity.
1121 # (Example: calls that do not contain an API key).
1122 # By default, API methods do not allow unregistered calls, and each method call
1123 # must be identified by a consumer project identity. Use this rule to
1124 # allow/disallow unregistered calls.
1125 #
1126 # Example of an API that wants to allow unregistered calls for entire service.
1127 #
1128 # usage:
1129 # rules:
1130 # - selector: "*"
1131 # allow_unregistered_calls: true
1132 #
1133 # Example of a method that wants to allow unregistered calls.
1134 #
1135 # usage:
1136 # rules:
1137 # - selector: "google.example.library.v1.LibraryService.CreateBook"
1138 # allow_unregistered_calls: true
1139 "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
1140 # methods in all APIs.
1141 #
1142 # Refer to selector for syntax details.
Thomas Coffee2f245372017-03-27 10:39:26 -07001143 "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001144 },
1145 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001146 "producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
1147 # service producer.
1148 #
1149 # Google Service Management currently only supports
1150 # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
1151 # channel. To use Google Cloud Pub/Sub as the channel, this must be the name
1152 # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
1153 # documented in https://cloud.google.com/pubsub/docs/overview.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001154 "requirements": [ # Requirements that must be satisfied before a consumer project can use the
1155 # service. Each requirement is of the form <service.name>/<requirement-id>;
1156 # for example 'serviceusage.googleapis.com/billing-enabled'.
1157 "A String",
1158 ],
1159 },
1160 "configVersion": 42, # The version of the service configuration. The config version may
1161 # influence interpretation of the configuration, for example, to
1162 # determine defaults. This is documented together with applicable
1163 # options. The current default for the config version itself is `3`.
1164 "producerProjectId": "A String", # The id of the Google developer project that owns the service.
1165 # Members of this project can manage the service configuration,
1166 # manage consumption of the service, etc.
1167 "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
1168 # HttpRule, each specifying the mapping of an RPC method
1169 # to one or more HTTP REST API methods.
1170 "rules": [ # A list of HTTP configuration rules that apply to individual API methods.
1171 #
1172 # **NOTE:** All service configuration rules follow "last one wins" order.
1173 { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
1174 # REST APIs. The mapping determines what portions of the request
1175 # message are populated from the path, query parameters, or body of
1176 # the HTTP request. The mapping is typically specified as an
1177 # `google.api.http` annotation, see "google/api/annotations.proto"
1178 # for details.
1179 #
1180 # The mapping consists of a field specifying the path template and
1181 # method kind. The path template can refer to fields in the request
1182 # message, as in the example below which describes a REST GET
1183 # operation on a resource collection of messages:
1184 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001185 #
1186 # service Messaging {
1187 # rpc GetMessage(GetMessageRequest) returns (Message) {
1188 # option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
1189 # }
1190 # }
1191 # message GetMessageRequest {
1192 # message SubMessage {
1193 # string subfield = 1;
1194 # }
1195 # string message_id = 1; // mapped to the URL
1196 # SubMessage sub = 2; // `sub.subfield` is url-mapped
1197 # }
1198 # message Message {
1199 # string text = 1; // content of the resource
1200 # }
1201 #
1202 # The same http annotation can alternatively be expressed inside the
1203 # `GRPC API Configuration` YAML file.
1204 #
1205 # http:
1206 # rules:
1207 # - selector: <proto_package_name>.Messaging.GetMessage
1208 # get: /v1/messages/{message_id}/{sub.subfield}
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001209 #
1210 # This definition enables an automatic, bidrectional mapping of HTTP
1211 # JSON to RPC. Example:
1212 #
1213 # HTTP | RPC
1214 # -----|-----
1215 # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
1216 #
1217 # In general, not only fields but also field paths can be referenced
1218 # from a path pattern. Fields mapped to the path pattern cannot be
1219 # repeated and must have a primitive (non-message) type.
1220 #
1221 # Any fields in the request message which are not bound by the path
1222 # pattern automatically become (optional) HTTP query
1223 # parameters. Assume the following definition of the request message:
1224 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001225 #
1226 # message GetMessageRequest {
1227 # message SubMessage {
1228 # string subfield = 1;
1229 # }
1230 # string message_id = 1; // mapped to the URL
1231 # int64 revision = 2; // becomes a parameter
1232 # SubMessage sub = 3; // `sub.subfield` becomes a parameter
1233 # }
1234 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001235 #
1236 # This enables a HTTP JSON to RPC mapping as below:
1237 #
1238 # HTTP | RPC
1239 # -----|-----
1240 # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
1241 #
1242 # Note that fields which are mapped to HTTP parameters must have a
1243 # primitive type or a repeated primitive type. Message types are not
1244 # allowed. In the case of a repeated type, the parameter can be
1245 # repeated in the URL, as in `...?param=A&param=B`.
1246 #
1247 # For HTTP method kinds which allow a request body, the `body` field
1248 # specifies the mapping. Consider a REST update method on the
1249 # message resource collection:
1250 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001251 #
1252 # service Messaging {
1253 # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
1254 # option (google.api.http) = {
1255 # put: "/v1/messages/{message_id}"
1256 # body: "message"
1257 # };
1258 # }
1259 # }
1260 # message UpdateMessageRequest {
1261 # string message_id = 1; // mapped to the URL
1262 # Message message = 2; // mapped to the body
1263 # }
1264 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001265 #
1266 # The following HTTP JSON to RPC mapping is enabled, where the
1267 # representation of the JSON in the request body is determined by
1268 # protos JSON encoding:
1269 #
1270 # HTTP | RPC
1271 # -----|-----
1272 # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
1273 #
1274 # The special name `*` can be used in the body mapping to define that
1275 # every field not bound by the path template should be mapped to the
1276 # request body. This enables the following alternative definition of
1277 # the update method:
1278 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001279 # service Messaging {
1280 # rpc UpdateMessage(Message) returns (Message) {
1281 # option (google.api.http) = {
1282 # put: "/v1/messages/{message_id}"
1283 # body: "*"
1284 # };
1285 # }
1286 # }
1287 # message Message {
1288 # string message_id = 1;
1289 # string text = 2;
1290 # }
1291 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001292 #
1293 # The following HTTP JSON to RPC mapping is enabled:
1294 #
1295 # HTTP | RPC
1296 # -----|-----
1297 # `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
1298 #
1299 # Note that when using `*` in the body mapping, it is not possible to
1300 # have HTTP parameters, as all fields not bound by the path end in
1301 # the body. This makes this option more rarely used in practice of
1302 # defining REST APIs. The common usage of `*` is in custom methods
1303 # which don't use the URL at all for transferring data.
1304 #
1305 # It is possible to define multiple HTTP methods for one RPC by using
1306 # the `additional_bindings` option. Example:
1307 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001308 # service Messaging {
1309 # rpc GetMessage(GetMessageRequest) returns (Message) {
1310 # option (google.api.http) = {
1311 # get: "/v1/messages/{message_id}"
1312 # additional_bindings {
1313 # get: "/v1/users/{user_id}/messages/{message_id}"
1314 # }
1315 # };
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001316 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001317 # }
1318 # message GetMessageRequest {
1319 # string message_id = 1;
1320 # string user_id = 2;
1321 # }
1322 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001323 #
1324 # This enables the following two alternative HTTP JSON to RPC
1325 # mappings:
1326 #
1327 # HTTP | RPC
1328 # -----|-----
1329 # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
1330 # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
1331 #
1332 # # Rules for HTTP mapping
1333 #
1334 # The rules for mapping HTTP path, query parameters, and body fields
1335 # to the request message are as follows:
1336 #
1337 # 1. The `body` field specifies either `*` or a field path, or is
1338 # omitted. If omitted, it assumes there is no HTTP body.
1339 # 2. Leaf fields (recursive expansion of nested messages in the
1340 # request) can be classified into three types:
1341 # (a) Matched in the URL template.
1342 # (b) Covered by body (if body is `*`, everything except (a) fields;
1343 # else everything under the body field)
1344 # (c) All other fields.
1345 # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
1346 # 4. Any body sent with an HTTP request can contain only (b) fields.
1347 #
1348 # The syntax of the path template is as follows:
1349 #
1350 # Template = "/" Segments [ Verb ] ;
1351 # Segments = Segment { "/" Segment } ;
1352 # Segment = "*" | "**" | LITERAL | Variable ;
1353 # Variable = "{" FieldPath [ "=" Segments ] "}" ;
1354 # FieldPath = IDENT { "." IDENT } ;
1355 # Verb = ":" LITERAL ;
1356 #
1357 # The syntax `*` matches a single path segment. It follows the semantics of
1358 # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
1359 # Expansion.
1360 #
1361 # The syntax `**` matches zero or more path segments. It follows the semantics
1362 # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001363 # Expansion. NOTE: it must be the last segment in the path except the Verb.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001364 #
1365 # The syntax `LITERAL` matches literal text in the URL path.
1366 #
1367 # The syntax `Variable` matches the entire path as specified by its template;
1368 # this nested template must not contain further variables. If a variable
1369 # matches a single path segment, its template may be omitted, e.g. `{var}`
1370 # is equivalent to `{var=*}`.
1371 #
1372 # NOTE: the field paths in variables and in the `body` must not refer to
1373 # repeated fields or map fields.
1374 #
1375 # Use CustomHttpPattern to specify any HTTP method that is not included in the
1376 # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
1377 # a given URL path rule. The wild-card rule is useful for services that provide
1378 # content to Web (HTML) clients.
1379 "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
1380 # `*` for mapping all fields not captured by the path pattern to the HTTP
1381 # body. NOTE: the referred field must not be a repeated field and must be
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001382 # present at the top-level of request message type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001383 "get": "A String", # Used for listing and getting information about resources.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001384 "mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
1385 # For media support, add instead [][google.bytestream.RestByteStream] as an
1386 # API to your configuration.
1387 # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
1388 # your configuration for Bytestream methods.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001389 "enabled": True or False, # Whether download is enabled.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001390 "downloadService": "A String", # DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.
1391 #
1392 # Specify name of the download service if one is used for download.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001393 },
1394 "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must
1395 # not contain an `additional_bindings` field themselves (that is,
1396 # the nesting may only be one level deep).
1397 # Object with schema name: HttpRule
1398 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001399 "mediaUpload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for media support using
1400 # Bytestream, add instead
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001401 # [][google.bytestream.RestByteStream] as an API to your
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001402 # configuration for Bytestream methods.
1403 # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
1404 # your configuration for Bytestream methods.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001405 "enabled": True or False, # Whether upload is enabled.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001406 "uploadService": "A String", # DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.
1407 #
1408 # Specify name of the upload service if one is used for upload.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001409 },
Thomas Coffee2f245372017-03-27 10:39:26 -07001410 "selector": "A String", # Selects methods to which this rule applies.
1411 #
1412 # Refer to selector for syntax details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001413 "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
1414 # response. Other response fields are ignored. This field is optional. When
1415 # not set, the response message will be used as HTTP body of response.
1416 # NOTE: the referred field must be not a repeated field and must be present
1417 # at the top-level of response message type.
1418 "put": "A String", # Used for updating a resource.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001419 "patch": "A String", # Used for updating a resource.
Thomas Coffee2f245372017-03-27 10:39:26 -07001420 "post": "A String", # Used for creating a resource.
1421 "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
1422 "path": "A String", # The path matched by this custom verb.
1423 "kind": "A String", # The name of this custom HTTP verb.
1424 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001425 "delete": "A String", # Used for deleting a resource.
1426 },
1427 ],
1428 },
1429 "apis": [ # A list of API interfaces exported by this service. Only the `name` field
1430 # of the google.protobuf.Api needs to be provided by the configuration
1431 # author, as the remaining fields will be derived from the IDL during the
1432 # normalization process. It is an error to specify an API interface here
1433 # which cannot be resolved against the associated IDL files.
1434 { # Api is a light-weight descriptor for a protocol buffer service.
1435 "methods": [ # The methods of this api, in unspecified order.
1436 { # Method represents a method of an api.
1437 "name": "A String", # The simple name of this method.
1438 "requestStreaming": True or False, # If true, the request is streamed.
1439 "responseTypeUrl": "A String", # The URL of the output message type.
1440 "requestTypeUrl": "A String", # A URL of the input message type.
1441 "responseStreaming": True or False, # If true, the response is streamed.
1442 "syntax": "A String", # The source syntax of this method.
1443 "options": [ # Any metadata attached to the method.
1444 { # A protocol buffer option, which can be attached to a message, field,
1445 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001446 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1447 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1448 # For custom options, it should be the fully-qualified name. For example,
1449 # `"google.api.http"`.
1450 "value": { # The option's value packed in an Any message. If the value is a primitive,
1451 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1452 # should be used. If the value is an enum, it should be stored as an int32
1453 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001454 "a_key": "", # Properties of the object. Contains field @type with type URL.
1455 },
1456 },
1457 ],
1458 },
1459 ],
1460 "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
1461 # message.
1462 # protobuf element, like the file in which it is defined.
1463 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1464 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1465 },
1466 "mixins": [ # Included APIs. See Mixin.
1467 { # Declares an API to be included in this API. The including API must
1468 # redeclare all the methods from the included API, but documentation
1469 # and options are inherited as follows:
1470 #
1471 # - If after comment and whitespace stripping, the documentation
1472 # string of the redeclared method is empty, it will be inherited
1473 # from the original method.
1474 #
1475 # - Each annotation belonging to the service config (http,
1476 # visibility) which is not set in the redeclared method will be
1477 # inherited.
1478 #
1479 # - If an http annotation is inherited, the path pattern will be
1480 # modified as follows. Any version prefix will be replaced by the
1481 # version of the including API plus the root path if specified.
1482 #
1483 # Example of a simple mixin:
1484 #
1485 # package google.acl.v1;
1486 # service AccessControl {
1487 # // Get the underlying ACL object.
1488 # rpc GetAcl(GetAclRequest) returns (Acl) {
1489 # option (google.api.http).get = "/v1/{resource=**}:getAcl";
1490 # }
1491 # }
1492 #
1493 # package google.storage.v2;
1494 # service Storage {
1495 # // rpc GetAcl(GetAclRequest) returns (Acl);
1496 #
1497 # // Get a data record.
1498 # rpc GetData(GetDataRequest) returns (Data) {
1499 # option (google.api.http).get = "/v2/{resource=**}";
1500 # }
1501 # }
1502 #
1503 # Example of a mixin configuration:
1504 #
1505 # apis:
1506 # - name: google.storage.v2.Storage
1507 # mixins:
1508 # - name: google.acl.v1.AccessControl
1509 #
1510 # The mixin construct implies that all methods in `AccessControl` are
1511 # also declared with same name and request/response types in
1512 # `Storage`. A documentation generator or annotation processor will
1513 # see the effective `Storage.GetAcl` method after inherting
1514 # documentation and annotations as follows:
1515 #
1516 # service Storage {
1517 # // Get the underlying ACL object.
1518 # rpc GetAcl(GetAclRequest) returns (Acl) {
1519 # option (google.api.http).get = "/v2/{resource=**}:getAcl";
1520 # }
1521 # ...
1522 # }
1523 #
1524 # Note how the version in the path pattern changed from `v1` to `v2`.
1525 #
1526 # If the `root` field in the mixin is specified, it should be a
1527 # relative path under which inherited HTTP paths are placed. Example:
1528 #
1529 # apis:
1530 # - name: google.storage.v2.Storage
1531 # mixins:
1532 # - name: google.acl.v1.AccessControl
1533 # root: acls
1534 #
1535 # This implies the following inherited HTTP annotation:
1536 #
1537 # service Storage {
1538 # // Get the underlying ACL object.
1539 # rpc GetAcl(GetAclRequest) returns (Acl) {
1540 # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
1541 # }
1542 # ...
1543 # }
1544 "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
1545 # are rooted.
1546 "name": "A String", # The fully qualified name of the API which is included.
1547 },
1548 ],
1549 "syntax": "A String", # The source syntax of the service.
1550 "version": "A String", # A version string for this api. If specified, must have the form
1551 # `major-version.minor-version`, as in `1.10`. If the minor version
1552 # is omitted, it defaults to zero. If the entire version field is
1553 # empty, the major version is derived from the package name, as
1554 # outlined below. If the field is not empty, the version in the
1555 # package name will be verified to be consistent with what is
1556 # provided here.
1557 #
1558 # The versioning schema uses [semantic
1559 # versioning](http://semver.org) where the major version number
1560 # indicates a breaking change and the minor version an additive,
1561 # non-breaking change. Both version numbers are signals to users
1562 # what to expect from different versions, and should be carefully
1563 # chosen based on the product plan.
1564 #
1565 # The major version is also reflected in the package name of the
1566 # API, which must end in `v<major-version>`, as in
1567 # `google.feature.v1`. For major versions 0 and 1, the suffix can
1568 # be omitted. Zero major versions must only be used for
1569 # experimental, none-GA apis.
1570 "options": [ # Any metadata attached to the API.
1571 { # A protocol buffer option, which can be attached to a message, field,
1572 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001573 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1574 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1575 # For custom options, it should be the fully-qualified name. For example,
1576 # `"google.api.http"`.
1577 "value": { # The option's value packed in an Any message. If the value is a primitive,
1578 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1579 # should be used. If the value is an enum, it should be stored as an int32
1580 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001581 "a_key": "", # Properties of the object. Contains field @type with type URL.
1582 },
1583 },
1584 ],
1585 "name": "A String", # The fully qualified name of this api, including package name
1586 # followed by the api's simple name.
1587 },
1588 ],
1589 "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
1590 # specific protobuf types that can appear in error detail lists of
1591 # error responses.
1592 #
1593 # Example:
1594 #
1595 # custom_error:
1596 # types:
1597 # - google.foo.v1.CustomError
1598 # - google.foo.v1.AnotherError
1599 "rules": [ # The list of custom error rules that apply to individual API messages.
1600 #
1601 # **NOTE:** All service configuration rules follow "last one wins" order.
1602 { # A custom error rule.
1603 "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
1604 # objects of this type will be filtered when they appear in error payload.
1605 "selector": "A String", # Selects messages to which this rule applies.
1606 #
1607 # Refer to selector for syntax details.
1608 },
1609 ],
1610 "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
1611 "A String",
1612 ],
1613 },
1614 "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
1615 # elements. Restrictions are specified using visibility labels
1616 # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
1617 #
1618 # Users and projects can have access to more than one visibility label. The
1619 # effective visibility for multiple labels is the union of each label's
1620 # elements, plus any unrestricted elements.
1621 #
1622 # If an element and its parents have no restrictions, visibility is
1623 # unconditionally granted.
1624 #
1625 # Example:
1626 #
1627 # visibility:
1628 # rules:
1629 # - selector: google.calendar.Calendar.EnhancedSearch
1630 # restriction: TRUSTED_TESTER
1631 # - selector: google.calendar.Calendar.Delegate
1632 # restriction: GOOGLE_INTERNAL
1633 #
1634 # Here, all methods are publicly visible except for the restricted methods
1635 # EnhancedSearch and Delegate.
1636 "rules": [ # A list of visibility rules that apply to individual API elements.
1637 #
1638 # **NOTE:** All service configuration rules follow "last one wins" order.
1639 { # A visibility rule provides visibility configuration for an individual API
1640 # element.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001641 "restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.
1642 # Any of the listed labels can be used to grant the visibility.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001643 #
1644 # If a rule has multiple labels, removing one of the labels but not all of
1645 # them can break clients.
1646 #
1647 # Example:
1648 #
1649 # visibility:
1650 # rules:
1651 # - selector: google.calendar.Calendar.EnhancedSearch
1652 # restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
1653 #
1654 # Removing GOOGLE_INTERNAL from this restriction will break clients that
1655 # rely on this method and only had access to it through GOOGLE_INTERNAL.
1656 "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
1657 #
1658 # Refer to selector for syntax details.
1659 },
1660 ],
1661 },
1662 "metrics": [ # Defines the metrics used by this service.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001663 { # Defines a metric type and its schema. Once a metric descriptor is created,
1664 # deleting or altering it stops data collection and makes the metric type's
1665 # existing data unusable.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001666 "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
1667 # Use sentence case without an ending period, for example "Request count".
Thomas Coffee2f245372017-03-27 10:39:26 -07001668 "description": "A String", # A detailed description of the metric, which can be used in documentation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001669 "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001670 # Some combinations of `metric_kind` and `value_type` might not be supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001671 "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001672 # Some combinations of `metric_kind` and `value_type` might not be supported.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001673 "labels": [ # The set of labels that can be used to describe a specific
1674 # instance of this metric type. For example, the
1675 # `appengine.googleapis.com/http/server/response_latencies` metric
1676 # type has a label for the HTTP response code, `response_code`, so
1677 # you can look at latencies for successful responses or just
1678 # for responses that failed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001679 { # A description of a label.
1680 "valueType": "A String", # The type of data that can be assigned to the label.
1681 "description": "A String", # A human-readable description for the label.
1682 "key": "A String", # The label key.
1683 },
1684 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001685 "type": "A String", # The metric type, including its DNS name prefix. The type is not
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001686 # URL-encoded. All user-defined custom metric types have the DNS name
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001687 # `custom.googleapis.com`. Metric types should use a natural hierarchical
1688 # grouping. For example:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001689 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001690 # "custom.googleapis.com/invoice/paid/amount"
1691 # "appengine.googleapis.com/http/server/response_latencies"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001692 "unit": "A String", # The unit in which the metric value is reported. It is only applicable
1693 # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
1694 # supported units are a subset of [The Unified Code for Units of
1695 # Measure](http://unitsofmeasure.org/ucum.html) standard:
1696 #
1697 # **Basic units (UNIT)**
1698 #
1699 # * `bit` bit
1700 # * `By` byte
1701 # * `s` second
1702 # * `min` minute
1703 # * `h` hour
1704 # * `d` day
1705 #
1706 # **Prefixes (PREFIX)**
1707 #
1708 # * `k` kilo (10**3)
1709 # * `M` mega (10**6)
1710 # * `G` giga (10**9)
1711 # * `T` tera (10**12)
1712 # * `P` peta (10**15)
1713 # * `E` exa (10**18)
1714 # * `Z` zetta (10**21)
1715 # * `Y` yotta (10**24)
1716 # * `m` milli (10**-3)
1717 # * `u` micro (10**-6)
1718 # * `n` nano (10**-9)
1719 # * `p` pico (10**-12)
1720 # * `f` femto (10**-15)
1721 # * `a` atto (10**-18)
1722 # * `z` zepto (10**-21)
1723 # * `y` yocto (10**-24)
1724 # * `Ki` kibi (2**10)
1725 # * `Mi` mebi (2**20)
1726 # * `Gi` gibi (2**30)
1727 # * `Ti` tebi (2**40)
1728 #
1729 # **Grammar**
1730 #
1731 # The grammar includes the dimensionless unit `1`, such as `1/s`.
1732 #
1733 # The grammar also includes these connectors:
1734 #
1735 # * `/` division (as an infix operator, e.g. `1/s`).
1736 # * `.` multiplication (as an infix operator, e.g. `GBy.d`)
1737 #
1738 # The grammar for a unit is as follows:
1739 #
1740 # Expression = Component { "." Component } { "/" Component } ;
1741 #
1742 # Component = [ PREFIX ] UNIT [ Annotation ]
1743 # | Annotation
1744 # | "1"
1745 # ;
1746 #
1747 # Annotation = "{" NAME "}" ;
1748 #
1749 # Notes:
1750 #
1751 # * `Annotation` is just a comment if it follows a `UNIT` and is
1752 # equivalent to `1` if it is used alone. For examples,
1753 # `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
1754 # * `NAME` is a sequence of non-blank printable ASCII characters not
1755 # containing '{' or '}'.
Thomas Coffee2f245372017-03-27 10:39:26 -07001756 "name": "A String", # The resource name of the metric descriptor. Depending on the
1757 # implementation, the name typically includes: (1) the parent resource name
1758 # that defines the scope of the metric type or of its data; and (2) the
1759 # metric's URL-encoded type, which also appears in the `type` field of this
1760 # descriptor. For example, following is the resource name of a custom
1761 # metric within the GCP project `my-project-id`:
1762 #
1763 # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001764 },
1765 ],
1766 "enums": [ # A list of all enum types included in this API service. Enums
1767 # referenced directly or indirectly by the `apis` are automatically
1768 # included. Enums which are not referenced but shall be included
1769 # should be listed here by name. Example:
1770 #
1771 # enums:
1772 # - name: google.someapi.v1.SomeEnum
1773 { # Enum type definition.
Thomas Coffee2f245372017-03-27 10:39:26 -07001774 "syntax": "A String", # The source syntax.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001775 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
1776 # protobuf element, like the file in which it is defined.
1777 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1778 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1779 },
Thomas Coffee2f245372017-03-27 10:39:26 -07001780 "options": [ # Protocol buffer options.
1781 { # A protocol buffer option, which can be attached to a message, field,
1782 # enumeration, etc.
1783 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1784 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1785 # For custom options, it should be the fully-qualified name. For example,
1786 # `"google.api.http"`.
1787 "value": { # The option's value packed in an Any message. If the value is a primitive,
1788 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1789 # should be used. If the value is an enum, it should be stored as an int32
1790 # value using the google.protobuf.Int32Value type.
1791 "a_key": "", # Properties of the object. Contains field @type with type URL.
1792 },
1793 },
1794 ],
1795 "name": "A String", # Enum type name.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001796 "enumvalue": [ # Enum value definitions.
1797 { # Enum value definition.
1798 "number": 42, # Enum value number.
1799 "name": "A String", # Enum value name.
1800 "options": [ # Protocol buffer options.
1801 { # A protocol buffer option, which can be attached to a message, field,
1802 # enumeration, etc.
1803 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1804 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1805 # For custom options, it should be the fully-qualified name. For example,
1806 # `"google.api.http"`.
1807 "value": { # The option's value packed in an Any message. If the value is a primitive,
1808 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1809 # should be used. If the value is an enum, it should be stored as an int32
1810 # value using the google.protobuf.Int32Value type.
1811 "a_key": "", # Properties of the object. Contains field @type with type URL.
1812 },
1813 },
1814 ],
1815 },
1816 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001817 },
1818 ],
1819 "types": [ # A list of all proto message types included in this API service.
1820 # Types referenced directly or indirectly by the `apis` are
1821 # automatically included. Messages which are not referenced but
1822 # shall be included, such as types used by the `google.protobuf.Any` type,
1823 # should be listed here by name. Example:
1824 #
1825 # types:
1826 # - name: google.protobuf.Int32
1827 { # A protocol buffer message type.
1828 "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
1829 "A String",
1830 ],
1831 "name": "A String", # The fully qualified message name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001832 "fields": [ # The list of fields.
1833 { # A single field of a message type.
1834 "kind": "A String", # The field type.
1835 "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
1836 # types. The first type has index 1; zero means the type is not in the list.
1837 "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
1838 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
1839 "name": "A String", # The field name.
1840 "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
1841 "jsonName": "A String", # The field JSON name.
1842 "number": 42, # The field number.
1843 "cardinality": "A String", # The field cardinality.
1844 "options": [ # The protocol buffer options.
1845 { # A protocol buffer option, which can be attached to a message, field,
1846 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001847 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1848 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1849 # For custom options, it should be the fully-qualified name. For example,
1850 # `"google.api.http"`.
1851 "value": { # The option's value packed in an Any message. If the value is a primitive,
1852 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1853 # should be used. If the value is an enum, it should be stored as an int32
1854 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001855 "a_key": "", # Properties of the object. Contains field @type with type URL.
1856 },
1857 },
1858 ],
1859 "packed": True or False, # Whether to use alternative packed wire representation.
1860 },
1861 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001862 "syntax": "A String", # The source syntax.
1863 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
1864 # protobuf element, like the file in which it is defined.
1865 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
1866 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
1867 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001868 "options": [ # The protocol buffer options.
1869 { # A protocol buffer option, which can be attached to a message, field,
1870 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001871 "name": "A String", # The option's name. For protobuf built-in options (options defined in
1872 # descriptor.proto), this is the short name. For example, `"map_entry"`.
1873 # For custom options, it should be the fully-qualified name. For example,
1874 # `"google.api.http"`.
1875 "value": { # The option's value packed in an Any message. If the value is a primitive,
1876 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
1877 # should be used. If the value is an enum, it should be stored as an int32
1878 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001879 "a_key": "", # Properties of the object. Contains field @type with type URL.
1880 },
1881 },
1882 ],
1883 },
1884 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001885 "logging": { # Logging configuration of the service. # Logging configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001886 #
1887 # The following example shows how to configure logs to be sent to the
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001888 # producer and consumer projects. In the example, the `activity_history`
1889 # log is sent to both the producer and consumer projects, whereas the
1890 # `purchase_history` log is only sent to the producer project.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001891 #
1892 # monitored_resources:
1893 # - type: library.googleapis.com/branch
1894 # labels:
1895 # - key: /city
1896 # description: The city where the library branch is located in.
1897 # - key: /name
1898 # description: The name of the branch.
1899 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001900 # - name: activity_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001901 # labels:
1902 # - key: /customer_id
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001903 # - name: purchase_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001904 # logging:
1905 # producer_destinations:
1906 # - monitored_resource: library.googleapis.com/branch
1907 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001908 # - activity_history
1909 # - purchase_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001910 # consumer_destinations:
1911 # - monitored_resource: library.googleapis.com/branch
1912 # logs:
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001913 # - activity_history
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001914 "producerDestinations": [ # Logging configurations for sending logs to the producer project.
1915 # There can be multiple producer destinations, each one must have a
1916 # different monitored resource type. A log can be used in at most
1917 # one producer destination.
1918 { # Configuration of a specific logging destination (the producer project
1919 # or the consumer project).
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001920 "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001921 # Service.monitored_resources section.
1922 "logs": [ # Names of the logs to be sent to this destination. Each name must
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001923 # be defined in the Service.logs section. If the log name is
1924 # not a domain scoped name, it will be automatically prefixed with
1925 # the service name followed by "/".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001926 "A String",
1927 ],
1928 },
1929 ],
1930 "consumerDestinations": [ # Logging configurations for sending logs to the consumer project.
1931 # There can be multiple consumer destinations, each one must have a
1932 # different monitored resource type. A log can be used in at most
1933 # one consumer destination.
1934 { # Configuration of a specific logging destination (the producer project
1935 # or the consumer project).
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001936 "monitoredResource": "A String", # The monitored resource type. The type must be defined in the
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001937 # Service.monitored_resources section.
1938 "logs": [ # Names of the logs to be sent to this destination. Each name must
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001939 # be defined in the Service.logs section. If the log name is
1940 # not a domain scoped name, it will be automatically prefixed with
1941 # the service name followed by "/".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001942 "A String",
1943 ],
1944 },
1945 ],
1946 },
1947 "name": "A String", # The DNS address at which this service is available,
1948 # e.g. `calendar.googleapis.com`.
1949 "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
1950 #
1951 # Example:
1952 # <pre><code>documentation:
1953 # summary: >
1954 # The Google Calendar API gives access
1955 # to most calendar features.
1956 # pages:
1957 # - name: Overview
1958 # content: &#40;== include google/foo/overview.md ==&#41;
1959 # - name: Tutorial
1960 # content: &#40;== include google/foo/tutorial.md ==&#41;
1961 # subpages;
1962 # - name: Java
1963 # content: &#40;== include google/foo/tutorial_java.md ==&#41;
1964 # rules:
1965 # - selector: google.calendar.Calendar.Get
1966 # description: >
1967 # ...
1968 # - selector: google.calendar.Calendar.Put
1969 # description: >
1970 # ...
1971 # </code></pre>
1972 # Documentation is provided in markdown syntax. In addition to
1973 # standard markdown features, definition lists, tables and fenced
1974 # code blocks are supported. Section headers can be provided and are
1975 # interpreted relative to the section nesting of the context where
1976 # a documentation fragment is embedded.
1977 #
1978 # Documentation from the IDL is merged with documentation defined
1979 # via the config at normalization time, where documentation provided
1980 # by config rules overrides IDL provided.
1981 #
1982 # A number of constructs specific to the API platform are supported
1983 # in documentation text.
1984 #
1985 # In order to reference a proto element, the following
1986 # notation can be used:
1987 # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
1988 # To override the display text used for the link, this can be used:
1989 # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
1990 # Text can be excluded from doc using the following notation:
1991 # <pre><code>&#40;-- internal comment --&#41;</code></pre>
1992 # Comments can be made conditional using a visibility label. The below
1993 # text will be only rendered if the `BETA` label is available:
1994 # <pre><code>&#40;--BETA: comment for BETA users --&#41;</code></pre>
1995 # A few directives are available in documentation. Note that
1996 # directives must appear on a single line to be properly
1997 # identified. The `include` directive includes a markdown file from
1998 # an external source:
1999 # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
2000 # The `resource_for` directive marks a message to be the resource of
2001 # a collection in REST view. If it is not specified, tools attempt
2002 # to infer the resource from the operations in a collection:
2003 # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
2004 # The directive `suppress_warning` does not directly affect documentation
2005 # and is documented together with service config validation.
2006 "rules": [ # A list of documentation rules that apply to individual API elements.
2007 #
2008 # **NOTE:** All service configuration rules follow "last one wins" order.
2009 { # A documentation rule provides information about individual API elements.
2010 "description": "A String", # Description of the selected API(s).
2011 "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
2012 # element is marked as `deprecated`.
2013 "selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a
2014 # qualified name of the element which may end in "*", indicating a wildcard.
2015 # Wildcards are only allowed at the end and for a whole component of the
2016 # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
2017 # specify a default for all applicable elements, the whole pattern "*"
2018 # is used.
2019 },
2020 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002021 "documentationRootUrl": "A String", # The URL to the root of documentation.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002022 "overview": "A String", # Declares a single overview page. For example:
2023 # <pre><code>documentation:
2024 # summary: ...
2025 # overview: &#40;== include overview.md ==&#41;
2026 # </code></pre>
2027 # This is a shortcut for the following declaration (using pages style):
2028 # <pre><code>documentation:
2029 # summary: ...
2030 # pages:
2031 # - name: Overview
2032 # content: &#40;== include overview.md ==&#41;
2033 # </code></pre>
2034 # Note: you cannot specify both `overview` field and `pages` field.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002035 "pages": [ # The top level pages for the documentation set.
2036 { # Represents a documentation page. A page can contain subpages to represent
2037 # nested documentation set structure.
2038 "content": "A String", # The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
2039 # to include content from a Markdown file.
2040 "subpages": [ # Subpages of this page. The order of subpages specified here will be
2041 # honored in the generated docset.
2042 # Object with schema name: Page
2043 ],
2044 "name": "A String", # The name of the page. It will be used as an identity of the page to
2045 # generate URI of the page, text of the link to this page in navigation,
2046 # etc. The full page name (start from the root page name to this page
2047 # concatenated with `.`) can be used as reference to the page in your
2048 # documentation. For example:
2049 # <pre><code>pages:
2050 # - name: Tutorial
2051 # content: &#40;== include tutorial.md ==&#41;
2052 # subpages:
2053 # - name: Java
2054 # content: &#40;== include tutorial_java.md ==&#41;
2055 # </code></pre>
2056 # You can reference `Java` page using Markdown reference link syntax:
2057 # `Java`.
2058 },
2059 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002060 "summary": "A String", # A short summary of what the service does. Can only be provided by
2061 # plain text.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002062 },
2063 "sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
2064 "sourceFiles": [ # All files used during config generation.
2065 {
2066 "a_key": "", # Properties of the object. Contains field @type with type URL.
2067 },
2068 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002069 },
2070 "systemTypes": [ # A list of all proto message types included in this API service.
2071 # It serves similar purpose as [google.api.Service.types], except that
2072 # these types are not needed by user-defined APIs. Therefore, they will not
2073 # show up in the generated discovery doc. This field should only be used
2074 # to define system APIs in ESF.
2075 { # A protocol buffer message type.
2076 "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
2077 "A String",
2078 ],
2079 "name": "A String", # The fully qualified message name.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002080 "fields": [ # The list of fields.
2081 { # A single field of a message type.
2082 "kind": "A String", # The field type.
2083 "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
2084 # types. The first type has index 1; zero means the type is not in the list.
2085 "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
2086 # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
2087 "name": "A String", # The field name.
2088 "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
2089 "jsonName": "A String", # The field JSON name.
2090 "number": 42, # The field number.
2091 "cardinality": "A String", # The field cardinality.
2092 "options": [ # The protocol buffer options.
2093 { # A protocol buffer option, which can be attached to a message, field,
2094 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002095 "name": "A String", # The option's name. For protobuf built-in options (options defined in
2096 # descriptor.proto), this is the short name. For example, `"map_entry"`.
2097 # For custom options, it should be the fully-qualified name. For example,
2098 # `"google.api.http"`.
2099 "value": { # The option's value packed in an Any message. If the value is a primitive,
2100 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
2101 # should be used. If the value is an enum, it should be stored as an int32
2102 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002103 "a_key": "", # Properties of the object. Contains field @type with type URL.
2104 },
2105 },
2106 ],
2107 "packed": True or False, # Whether to use alternative packed wire representation.
2108 },
2109 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002110 "syntax": "A String", # The source syntax.
2111 "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
2112 # protobuf element, like the file in which it is defined.
2113 "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
2114 # protobuf element. For example: `"google/protobuf/source_context.proto"`.
2115 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002116 "options": [ # The protocol buffer options.
2117 { # A protocol buffer option, which can be attached to a message, field,
2118 # enumeration, etc.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002119 "name": "A String", # The option's name. For protobuf built-in options (options defined in
2120 # descriptor.proto), this is the short name. For example, `"map_entry"`.
2121 # For custom options, it should be the fully-qualified name. For example,
2122 # `"google.api.http"`.
2123 "value": { # The option's value packed in an Any message. If the value is a primitive,
2124 # the corresponding wrapper type defined in google/protobuf/wrappers.proto
2125 # should be used. If the value is an enum, it should be stored as an int32
2126 # value using the google.protobuf.Int32Value type.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002127 "a_key": "", # Properties of the object. Contains field @type with type URL.
2128 },
2129 },
2130 ],
2131 },
2132 ],
2133 "context": { # `Context` defines which contexts an API requests. # Context configuration.
2134 #
2135 # Example:
2136 #
2137 # context:
2138 # rules:
2139 # - selector: "*"
2140 # requested:
2141 # - google.rpc.context.ProjectContext
2142 # - google.rpc.context.OriginContext
2143 #
2144 # The above specifies that all methods in the API request
2145 # `google.rpc.context.ProjectContext` and
2146 # `google.rpc.context.OriginContext`.
2147 #
2148 # Available context types are defined in package
2149 # `google.rpc.context`.
2150 "rules": [ # A list of RPC context rules that apply to individual API methods.
2151 #
2152 # **NOTE:** All service configuration rules follow "last one wins" order.
2153 { # A context rule provides information about the context for an individual API
2154 # element.
2155 "provided": [ # A list of full type names of provided contexts.
2156 "A String",
2157 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002158 "requested": [ # A list of full type names of requested contexts.
2159 "A String",
2160 ],
Thomas Coffee2f245372017-03-27 10:39:26 -07002161 "selector": "A String", # Selects the methods to which this rule applies.
2162 #
2163 # Refer to selector for syntax details.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002164 },
2165 ],
2166 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07002167 "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint
2168 # with the same name as the service is automatically generated to service all
2169 # defined APIs.
2170 { # `Endpoint` describes a network endpoint that serves a set of APIs.
2171 # A service may expose any number of endpoints, and all endpoints share the
2172 # same service configuration, such as quota configuration and monitoring
2173 # configuration.
2174 #
2175 # Example service configuration:
2176 #
2177 # name: library-example.googleapis.com
2178 # endpoints:
2179 # # Below entry makes 'google.example.library.v1.Library'
2180 # # API be served from endpoint address library-example.googleapis.com.
2181 # # It also allows HTTP OPTIONS calls to be passed to the backend, for
2182 # # it to decide whether the subsequent cross-origin request is
2183 # # allowed to proceed.
2184 # - name: library-example.googleapis.com
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07002185 # allow_cors: true
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07002186 "allowCors": True or False, # Allowing
2187 # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
2188 # cross-domain traffic, would allow the backends served from this endpoint to
2189 # receive and respond to HTTP OPTIONS requests. The response will be used by
2190 # the browser to determine whether the subsequent cross-origin request is
2191 # allowed to proceed.
Thomas Coffee2f245372017-03-27 10:39:26 -07002192 "apis": [ # The list of APIs served by this endpoint.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07002193 "A String",
2194 ],
2195 "features": [ # The list of features enabled on this endpoint.
2196 "A String",
2197 ],
2198 "name": "A String", # The canonical name of this endpoint.
Thomas Coffee2f245372017-03-27 10:39:26 -07002199 "aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,
2200 # please specify multiple google.api.Endpoint for each of the intented
2201 # alias.
2202 #
2203 # Additional names that this endpoint will be hosted on.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07002204 "A String",
2205 ],
2206 },
2207 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002208 "experimental": { # Experimental service configuration. These configuration options can # Experimental configuration.
2209 # only be used by whitelisted users.
2210 "authorization": { # Configuration of authorization. # Authorization configuration.
2211 #
2212 # This section determines the authorization provider, if unspecified, then no
2213 # authorization check will be done.
2214 #
2215 # Example:
2216 #
2217 # experimental:
2218 # authorization:
2219 # provider: firebaserules.googleapis.com
2220 "provider": "A String", # The name of the authorization provider, such as
2221 # firebaserules.googleapis.com.
2222 },
2223 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002224 }</pre>
2225</div>
2226
2227<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07002228 <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002229 <pre>Gets the access control policy for a resource.
2230Returns an empty policy if the resource exists and does not have a policy
2231set.
2232
2233Args:
2234 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002235See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002236 body: object, The request body. (required)
2237 The object takes the form of:
2238
2239{ # Request message for `GetIamPolicy` method.
2240 }
2241
2242 x__xgafv: string, V1 error format.
2243 Allowed values
2244 1 - v1 error format
2245 2 - v2 error format
2246
2247Returns:
2248 An object of the form:
2249
2250 { # Defines an Identity and Access Management (IAM) policy. It is used to
2251 # specify access control policies for Cloud Platform resources.
2252 #
2253 #
2254 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
2255 # `members` to a `role`, where the members can be user accounts, Google groups,
2256 # Google domains, and service accounts. A `role` is a named list of permissions
2257 # defined by IAM.
2258 #
2259 # **Example**
2260 #
2261 # {
2262 # "bindings": [
2263 # {
2264 # "role": "roles/owner",
2265 # "members": [
2266 # "user:mike@example.com",
2267 # "group:admins@example.com",
2268 # "domain:google.com",
2269 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
2270 # ]
2271 # },
2272 # {
2273 # "role": "roles/viewer",
2274 # "members": ["user:sean@example.com"]
2275 # }
2276 # ]
2277 # }
2278 #
2279 # For a description of IAM and its features, see the
2280 # [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002281 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2282 { # Specifies the audit configuration for a service.
2283 # The configuration determines which permission types are logged, and what
2284 # identities, if any, are exempted from logging.
2285 # An AuditConifg must have one or more AuditLogConfigs.
2286 #
2287 # If there are AuditConfigs for both `allServices` and a specific service,
2288 # the union of the two AuditConfigs is used for that service: the log_types
2289 # specified in each AuditConfig are enabled, and the exempted_members in each
2290 # AuditConfig are exempted.
2291 # Example Policy with multiple AuditConfigs:
2292 # {
2293 # "audit_configs": [
2294 # {
2295 # "service": "allServices"
2296 # "audit_log_configs": [
2297 # {
2298 # "log_type": "DATA_READ",
2299 # "exempted_members": [
2300 # "user:foo@gmail.com"
2301 # ]
2302 # },
2303 # {
2304 # "log_type": "DATA_WRITE",
2305 # },
2306 # {
2307 # "log_type": "ADMIN_READ",
2308 # }
2309 # ]
2310 # },
2311 # {
2312 # "service": "fooservice@googleapis.com"
2313 # "audit_log_configs": [
2314 # {
2315 # "log_type": "DATA_READ",
2316 # },
2317 # {
2318 # "log_type": "DATA_WRITE",
2319 # "exempted_members": [
2320 # "user:bar@gmail.com"
2321 # ]
2322 # }
2323 # ]
2324 # }
2325 # ]
2326 # }
2327 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2328 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2329 # bar@gmail.com from DATA_WRITE logging.
2330 "exemptedMembers": [
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002331 "A String",
2332 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002333 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002334 # Next ID: 4
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002335 { # Provides the configuration for logging a type of permissions.
2336 # Example:
2337 #
2338 # {
2339 # "audit_log_configs": [
2340 # {
2341 # "log_type": "DATA_READ",
2342 # "exempted_members": [
2343 # "user:foo@gmail.com"
2344 # ]
2345 # },
2346 # {
2347 # "log_type": "DATA_WRITE",
2348 # }
2349 # ]
2350 # }
2351 #
2352 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2353 # foo@gmail.com from DATA_READ logging.
2354 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2355 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002356 # Follows the same format of Binding.members.
2357 "A String",
2358 ],
2359 "logType": "A String", # The log type that this config enables.
2360 },
2361 ],
2362 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002363 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002364 # `allServices` is a special value that covers all services.
2365 },
2366 ],
2367 "rules": [ # If more than one rule is specified, the rules are applied in the following
2368 # manner:
2369 # - All matching LOG rules are always applied.
2370 # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
2371 # Logging will be applied if one or more matching rule requires logging.
2372 # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
2373 # granted.
2374 # Logging will be applied if one or more matching rule requires logging.
2375 # - Otherwise, if no rule applies, permission is denied.
2376 { # A rule to be applied in a Policy.
2377 "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
2378 # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
2379 # The format for in and not_in entries is the same as for members in a
2380 # Binding (see google/iam/v1/policy.proto).
2381 "A String",
2382 ],
2383 "description": "A String", # Human-readable description of the rule.
2384 "in": [ # If one or more 'in' clauses are specified, the rule matches if
2385 # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
2386 "A String",
2387 ],
2388 "action": "A String", # Required
2389 "conditions": [ # Additional restrictions that must be met
2390 { # A condition to be met.
2391 "iam": "A String", # Trusted attributes supplied by the IAM system.
2392 "svc": "A String", # Trusted attributes discharged by the service.
2393 "value": "A String", # DEPRECATED. Use 'values' instead.
2394 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
2395 # the IAM system for access control.
2396 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
2397 "A String",
2398 ],
2399 "op": "A String", # An operator to apply the subject with.
2400 },
2401 ],
2402 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
2403 # that match the LOG action.
2404 { # Specifies what kind of log the caller must write
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002405 "counter": { # Options for counters # Counter options.
2406 "field": "A String", # The field value to attribute.
2407 "metric": "A String", # The metric to update.
2408 },
2409 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
2410 },
2411 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
2412 },
2413 },
2414 ],
2415 "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
2416 # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
2417 # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
2418 "A String",
2419 ],
2420 },
2421 ],
2422 "version": 42, # Version of the `Policy`. The default version is 0.
2423 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2424 # prevent simultaneous updates of a policy from overwriting each other.
2425 # It is strongly suggested that systems make use of the `etag` in the
2426 # read-modify-write cycle to perform policy updates in order to avoid race
2427 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2428 # systems are expected to put that etag in the request to `setIamPolicy` to
2429 # ensure that their change will be applied to the same version of the policy.
2430 #
2431 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2432 # policy is overwritten blindly.
2433 "bindings": [ # Associates a list of `members` to a `role`.
2434 # Multiple `bindings` must not be specified for the same `role`.
2435 # `bindings` with no members will result in an error.
2436 { # Associates `members` with a `role`.
2437 "role": "A String", # Role that is assigned to `members`.
2438 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2439 # Required
2440 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2441 # `members` can have the following values:
2442 #
2443 # * `allUsers`: A special identifier that represents anyone who is
2444 # on the internet; with or without a Google account.
2445 #
2446 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2447 # who is authenticated with a Google account or a service account.
2448 #
2449 # * `user:{emailid}`: An email address that represents a specific Google
2450 # account. For example, `alice@gmail.com` or `joe@example.com`.
2451 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -07002452 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002453 # * `serviceAccount:{emailid}`: An email address that represents a service
2454 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2455 #
2456 # * `group:{emailid}`: An email address that represents a Google group.
2457 # For example, `admins@example.com`.
2458 #
2459 # * `domain:{domain}`: A Google Apps domain name that represents all the
2460 # users of that domain. For example, `google.com` or `example.com`.
2461 #
2462 "A String",
2463 ],
2464 },
2465 ],
2466 "iamOwned": True or False,
2467 }</pre>
2468</div>
2469
2470<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002471 <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 -08002472 <pre>Lists managed services.
2473
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002474Returns all public services. For authenticated users, also returns all
2475services the calling user has "servicemanagement.services.get" permission
2476for.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002477
2478**BETA:** If the caller specifies the `consumer_id`, it returns only the
2479services enabled on the consumer. The `consumer_id` must have the format
2480of "project:{PROJECT-ID}".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002481
2482Args:
2483 producerProjectId: string, Include services produced by the specified project.
2484 pageSize: integer, Requested size of the next page of data.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002485 pageToken: string, Token identifying which result to start with; returned by a previous list
2486call.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002487 consumerId: string, Include services consumed by the specified consumer.
2488
2489The Google Service Management implementation accepts the following
2490forms:
2491- project:<project_id>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002492 x__xgafv: string, V1 error format.
2493 Allowed values
2494 1 - v1 error format
2495 2 - v2 error format
2496
2497Returns:
2498 An object of the form:
2499
2500 { # Response message for `ListServices` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002501 "services": [ # The returned services will only have the name field set.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002502 { # The full representation of a Service that is managed by
2503 # Google Service Management.
2504 "serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)
2505 # for naming requirements.
2506 "producerProjectId": "A String", # ID of the project that produces and owns this service.
2507 },
2508 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002509 "nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002510 }</pre>
2511</div>
2512
2513<div class="method">
2514 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2515 <pre>Retrieves the next page of results.
2516
2517Args:
2518 previous_request: The request for the previous page. (required)
2519 previous_response: The response from the request for the previous page. (required)
2520
2521Returns:
2522 A request object that you can call 'execute()' on to request the next
2523 page. Returns None if there are no more items in the collection.
2524 </pre>
2525</div>
2526
2527<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07002528 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002529 <pre>Sets the access control policy on the specified resource. Replaces any
2530existing policy.
2531
2532Args:
2533 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002534See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002535 body: object, The request body. (required)
2536 The object takes the form of:
2537
2538{ # Request message for `SetIamPolicy` method.
2539 "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
2540 # the policy is limited to a few 10s of KB. An empty policy is a
2541 # valid policy but certain Cloud Platform services (such as Projects)
2542 # might reject them.
2543 # specify access control policies for Cloud Platform resources.
2544 #
2545 #
2546 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
2547 # `members` to a `role`, where the members can be user accounts, Google groups,
2548 # Google domains, and service accounts. A `role` is a named list of permissions
2549 # defined by IAM.
2550 #
2551 # **Example**
2552 #
2553 # {
2554 # "bindings": [
2555 # {
2556 # "role": "roles/owner",
2557 # "members": [
2558 # "user:mike@example.com",
2559 # "group:admins@example.com",
2560 # "domain:google.com",
2561 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
2562 # ]
2563 # },
2564 # {
2565 # "role": "roles/viewer",
2566 # "members": ["user:sean@example.com"]
2567 # }
2568 # ]
2569 # }
2570 #
2571 # For a description of IAM and its features, see the
2572 # [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002573 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2574 { # Specifies the audit configuration for a service.
2575 # The configuration determines which permission types are logged, and what
2576 # identities, if any, are exempted from logging.
2577 # An AuditConifg must have one or more AuditLogConfigs.
2578 #
2579 # If there are AuditConfigs for both `allServices` and a specific service,
2580 # the union of the two AuditConfigs is used for that service: the log_types
2581 # specified in each AuditConfig are enabled, and the exempted_members in each
2582 # AuditConfig are exempted.
2583 # Example Policy with multiple AuditConfigs:
2584 # {
2585 # "audit_configs": [
2586 # {
2587 # "service": "allServices"
2588 # "audit_log_configs": [
2589 # {
2590 # "log_type": "DATA_READ",
2591 # "exempted_members": [
2592 # "user:foo@gmail.com"
2593 # ]
2594 # },
2595 # {
2596 # "log_type": "DATA_WRITE",
2597 # },
2598 # {
2599 # "log_type": "ADMIN_READ",
2600 # }
2601 # ]
2602 # },
2603 # {
2604 # "service": "fooservice@googleapis.com"
2605 # "audit_log_configs": [
2606 # {
2607 # "log_type": "DATA_READ",
2608 # },
2609 # {
2610 # "log_type": "DATA_WRITE",
2611 # "exempted_members": [
2612 # "user:bar@gmail.com"
2613 # ]
2614 # }
2615 # ]
2616 # }
2617 # ]
2618 # }
2619 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2620 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2621 # bar@gmail.com from DATA_WRITE logging.
2622 "exemptedMembers": [
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002623 "A String",
2624 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002625 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002626 # Next ID: 4
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002627 { # Provides the configuration for logging a type of permissions.
2628 # Example:
2629 #
2630 # {
2631 # "audit_log_configs": [
2632 # {
2633 # "log_type": "DATA_READ",
2634 # "exempted_members": [
2635 # "user:foo@gmail.com"
2636 # ]
2637 # },
2638 # {
2639 # "log_type": "DATA_WRITE",
2640 # }
2641 # ]
2642 # }
2643 #
2644 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2645 # foo@gmail.com from DATA_READ logging.
2646 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2647 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002648 # Follows the same format of Binding.members.
2649 "A String",
2650 ],
2651 "logType": "A String", # The log type that this config enables.
2652 },
2653 ],
2654 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002655 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002656 # `allServices` is a special value that covers all services.
2657 },
2658 ],
2659 "rules": [ # If more than one rule is specified, the rules are applied in the following
2660 # manner:
2661 # - All matching LOG rules are always applied.
2662 # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
2663 # Logging will be applied if one or more matching rule requires logging.
2664 # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
2665 # granted.
2666 # Logging will be applied if one or more matching rule requires logging.
2667 # - Otherwise, if no rule applies, permission is denied.
2668 { # A rule to be applied in a Policy.
2669 "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
2670 # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
2671 # The format for in and not_in entries is the same as for members in a
2672 # Binding (see google/iam/v1/policy.proto).
2673 "A String",
2674 ],
2675 "description": "A String", # Human-readable description of the rule.
2676 "in": [ # If one or more 'in' clauses are specified, the rule matches if
2677 # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
2678 "A String",
2679 ],
2680 "action": "A String", # Required
2681 "conditions": [ # Additional restrictions that must be met
2682 { # A condition to be met.
2683 "iam": "A String", # Trusted attributes supplied by the IAM system.
2684 "svc": "A String", # Trusted attributes discharged by the service.
2685 "value": "A String", # DEPRECATED. Use 'values' instead.
2686 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
2687 # the IAM system for access control.
2688 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
2689 "A String",
2690 ],
2691 "op": "A String", # An operator to apply the subject with.
2692 },
2693 ],
2694 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
2695 # that match the LOG action.
2696 { # Specifies what kind of log the caller must write
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002697 "counter": { # Options for counters # Counter options.
2698 "field": "A String", # The field value to attribute.
2699 "metric": "A String", # The metric to update.
2700 },
2701 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
2702 },
2703 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
2704 },
2705 },
2706 ],
2707 "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
2708 # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
2709 # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
2710 "A String",
2711 ],
2712 },
2713 ],
2714 "version": 42, # Version of the `Policy`. The default version is 0.
2715 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2716 # prevent simultaneous updates of a policy from overwriting each other.
2717 # It is strongly suggested that systems make use of the `etag` in the
2718 # read-modify-write cycle to perform policy updates in order to avoid race
2719 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2720 # systems are expected to put that etag in the request to `setIamPolicy` to
2721 # ensure that their change will be applied to the same version of the policy.
2722 #
2723 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2724 # policy is overwritten blindly.
2725 "bindings": [ # Associates a list of `members` to a `role`.
2726 # Multiple `bindings` must not be specified for the same `role`.
2727 # `bindings` with no members will result in an error.
2728 { # Associates `members` with a `role`.
2729 "role": "A String", # Role that is assigned to `members`.
2730 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2731 # Required
2732 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2733 # `members` can have the following values:
2734 #
2735 # * `allUsers`: A special identifier that represents anyone who is
2736 # on the internet; with or without a Google account.
2737 #
2738 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2739 # who is authenticated with a Google account or a service account.
2740 #
2741 # * `user:{emailid}`: An email address that represents a specific Google
2742 # account. For example, `alice@gmail.com` or `joe@example.com`.
2743 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -07002744 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002745 # * `serviceAccount:{emailid}`: An email address that represents a service
2746 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2747 #
2748 # * `group:{emailid}`: An email address that represents a Google group.
2749 # For example, `admins@example.com`.
2750 #
2751 # * `domain:{domain}`: A Google Apps domain name that represents all the
2752 # users of that domain. For example, `google.com` or `example.com`.
2753 #
2754 "A String",
2755 ],
2756 },
2757 ],
2758 "iamOwned": True or False,
2759 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002760 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002761 # the fields in the mask will be modified. If no mask is provided, the
2762 # following default mask is used:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002763 # paths: "bindings, etag"
2764 # This field is only used by Cloud IAM.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002765 }
2766
2767 x__xgafv: string, V1 error format.
2768 Allowed values
2769 1 - v1 error format
2770 2 - v2 error format
2771
2772Returns:
2773 An object of the form:
2774
2775 { # Defines an Identity and Access Management (IAM) policy. It is used to
2776 # specify access control policies for Cloud Platform resources.
2777 #
2778 #
2779 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
2780 # `members` to a `role`, where the members can be user accounts, Google groups,
2781 # Google domains, and service accounts. A `role` is a named list of permissions
2782 # defined by IAM.
2783 #
2784 # **Example**
2785 #
2786 # {
2787 # "bindings": [
2788 # {
2789 # "role": "roles/owner",
2790 # "members": [
2791 # "user:mike@example.com",
2792 # "group:admins@example.com",
2793 # "domain:google.com",
2794 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
2795 # ]
2796 # },
2797 # {
2798 # "role": "roles/viewer",
2799 # "members": ["user:sean@example.com"]
2800 # }
2801 # ]
2802 # }
2803 #
2804 # For a description of IAM and its features, see the
2805 # [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002806 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
2807 { # Specifies the audit configuration for a service.
2808 # The configuration determines which permission types are logged, and what
2809 # identities, if any, are exempted from logging.
2810 # An AuditConifg must have one or more AuditLogConfigs.
2811 #
2812 # If there are AuditConfigs for both `allServices` and a specific service,
2813 # the union of the two AuditConfigs is used for that service: the log_types
2814 # specified in each AuditConfig are enabled, and the exempted_members in each
2815 # AuditConfig are exempted.
2816 # Example Policy with multiple AuditConfigs:
2817 # {
2818 # "audit_configs": [
2819 # {
2820 # "service": "allServices"
2821 # "audit_log_configs": [
2822 # {
2823 # "log_type": "DATA_READ",
2824 # "exempted_members": [
2825 # "user:foo@gmail.com"
2826 # ]
2827 # },
2828 # {
2829 # "log_type": "DATA_WRITE",
2830 # },
2831 # {
2832 # "log_type": "ADMIN_READ",
2833 # }
2834 # ]
2835 # },
2836 # {
2837 # "service": "fooservice@googleapis.com"
2838 # "audit_log_configs": [
2839 # {
2840 # "log_type": "DATA_READ",
2841 # },
2842 # {
2843 # "log_type": "DATA_WRITE",
2844 # "exempted_members": [
2845 # "user:bar@gmail.com"
2846 # ]
2847 # }
2848 # ]
2849 # }
2850 # ]
2851 # }
2852 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2853 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
2854 # bar@gmail.com from DATA_WRITE logging.
2855 "exemptedMembers": [
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002856 "A String",
2857 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002858 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002859 # Next ID: 4
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04002860 { # Provides the configuration for logging a type of permissions.
2861 # Example:
2862 #
2863 # {
2864 # "audit_log_configs": [
2865 # {
2866 # "log_type": "DATA_READ",
2867 # "exempted_members": [
2868 # "user:foo@gmail.com"
2869 # ]
2870 # },
2871 # {
2872 # "log_type": "DATA_WRITE",
2873 # }
2874 # ]
2875 # }
2876 #
2877 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
2878 # foo@gmail.com from DATA_READ logging.
2879 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
2880 # permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002881 # Follows the same format of Binding.members.
2882 "A String",
2883 ],
2884 "logType": "A String", # The log type that this config enables.
2885 },
2886 ],
2887 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07002888 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002889 # `allServices` is a special value that covers all services.
2890 },
2891 ],
2892 "rules": [ # If more than one rule is specified, the rules are applied in the following
2893 # manner:
2894 # - All matching LOG rules are always applied.
2895 # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
2896 # Logging will be applied if one or more matching rule requires logging.
2897 # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
2898 # granted.
2899 # Logging will be applied if one or more matching rule requires logging.
2900 # - Otherwise, if no rule applies, permission is denied.
2901 { # A rule to be applied in a Policy.
2902 "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
2903 # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
2904 # The format for in and not_in entries is the same as for members in a
2905 # Binding (see google/iam/v1/policy.proto).
2906 "A String",
2907 ],
2908 "description": "A String", # Human-readable description of the rule.
2909 "in": [ # If one or more 'in' clauses are specified, the rule matches if
2910 # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
2911 "A String",
2912 ],
2913 "action": "A String", # Required
2914 "conditions": [ # Additional restrictions that must be met
2915 { # A condition to be met.
2916 "iam": "A String", # Trusted attributes supplied by the IAM system.
2917 "svc": "A String", # Trusted attributes discharged by the service.
2918 "value": "A String", # DEPRECATED. Use 'values' instead.
2919 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
2920 # the IAM system for access control.
2921 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
2922 "A String",
2923 ],
2924 "op": "A String", # An operator to apply the subject with.
2925 },
2926 ],
2927 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
2928 # that match the LOG action.
2929 { # Specifies what kind of log the caller must write
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002930 "counter": { # Options for counters # Counter options.
2931 "field": "A String", # The field value to attribute.
2932 "metric": "A String", # The metric to update.
2933 },
2934 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
2935 },
2936 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
2937 },
2938 },
2939 ],
2940 "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
2941 # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
2942 # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
2943 "A String",
2944 ],
2945 },
2946 ],
2947 "version": 42, # Version of the `Policy`. The default version is 0.
2948 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
2949 # prevent simultaneous updates of a policy from overwriting each other.
2950 # It is strongly suggested that systems make use of the `etag` in the
2951 # read-modify-write cycle to perform policy updates in order to avoid race
2952 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2953 # systems are expected to put that etag in the request to `setIamPolicy` to
2954 # ensure that their change will be applied to the same version of the policy.
2955 #
2956 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
2957 # policy is overwritten blindly.
2958 "bindings": [ # Associates a list of `members` to a `role`.
2959 # Multiple `bindings` must not be specified for the same `role`.
2960 # `bindings` with no members will result in an error.
2961 { # Associates `members` with a `role`.
2962 "role": "A String", # Role that is assigned to `members`.
2963 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2964 # Required
2965 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
2966 # `members` can have the following values:
2967 #
2968 # * `allUsers`: A special identifier that represents anyone who is
2969 # on the internet; with or without a Google account.
2970 #
2971 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2972 # who is authenticated with a Google account or a service account.
2973 #
2974 # * `user:{emailid}`: An email address that represents a specific Google
2975 # account. For example, `alice@gmail.com` or `joe@example.com`.
2976 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -07002977 #
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002978 # * `serviceAccount:{emailid}`: An email address that represents a service
2979 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
2980 #
2981 # * `group:{emailid}`: An email address that represents a Google group.
2982 # For example, `admins@example.com`.
2983 #
2984 # * `domain:{domain}`: A Google Apps domain name that represents all the
2985 # users of that domain. For example, `google.com` or `example.com`.
2986 #
2987 "A String",
2988 ],
2989 },
2990 ],
2991 "iamOwned": True or False,
2992 }</pre>
2993</div>
2994
2995<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07002996 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07002997 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08002998If the resource does not exist, this will return an empty set of
2999permissions, not a NOT_FOUND error.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003000
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04003001Note: This operation is designed to be used for building permission-aware
3002UIs and command-line tools, not for authorization checking. This operation
3003may "fail open" without warning.
3004
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003005Args:
3006 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04003007See the operation documentation for the appropriate value for this field. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003008 body: object, The request body. (required)
3009 The object takes the form of:
3010
3011{ # Request message for `TestIamPermissions` method.
3012 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
3013 # wildcards (such as '*' or 'storage.*') are not allowed. For more
3014 # information see
3015 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
3016 "A String",
3017 ],
3018 }
3019
3020 x__xgafv: string, V1 error format.
3021 Allowed values
3022 1 - v1 error format
3023 2 - v2 error format
3024
3025Returns:
3026 An object of the form:
3027
3028 { # Response message for `TestIamPermissions` method.
3029 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3030 # allowed.
3031 "A String",
3032 ],
3033 }</pre>
3034</div>
3035
3036<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07003037 <code class="details" id="undelete">undelete(serviceName, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003038 <pre>Revives a previously deleted managed service. The method restores the
3039service using the configuration at the time the service was deleted.
3040The target service must exist and must have been deleted within the
3041last 30 days.
3042
3043Operation<response: UndeleteServiceResponse>
3044
3045Args:
3046 serviceName: string, The name of the service. See the [overview](/service-management/overview)
3047for naming requirements. For example: `example.googleapis.com`. (required)
3048 x__xgafv: string, V1 error format.
3049 Allowed values
3050 1 - v1 error format
3051 2 - v2 error format
3052
3053Returns:
3054 An object of the form:
3055
3056 { # This resource represents a long-running operation that is the result of a
3057 # network API call.
3058 "metadata": { # Service-specific metadata associated with the operation. It typically
3059 # contains progress information and common metadata such as create time.
3060 # Some services might not provide such metadata. Any method that returns a
3061 # long-running operation should document the metadata type, if any.
3062 "a_key": "", # Properties of the object. Contains field @type with type URL.
3063 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -07003064 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003065 # programming environments, including REST APIs and RPC APIs. It is used by
3066 # [gRPC](https://github.com/grpc). The error model is designed to be:
3067 #
3068 # - Simple to use and understand for most users
3069 # - Flexible enough to meet unexpected needs
3070 #
3071 # # Overview
3072 #
3073 # The `Status` message contains three pieces of data: error code, error message,
3074 # and error details. The error code should be an enum value of
3075 # google.rpc.Code, but it may accept additional error codes if needed. The
3076 # error message should be a developer-facing English message that helps
3077 # developers *understand* and *resolve* the error. If a localized user-facing
3078 # error message is needed, put the localized message in the error details or
3079 # localize it in the client. The optional error details may contain arbitrary
3080 # information about the error. There is a predefined set of error detail types
3081 # in the package `google.rpc` which can be used for common error conditions.
3082 #
3083 # # Language mapping
3084 #
3085 # The `Status` message is the logical representation of the error model, but it
3086 # is not necessarily the actual wire format. When the `Status` message is
3087 # exposed in different client libraries and different wire protocols, it can be
3088 # mapped differently. For example, it will likely be mapped to some exceptions
3089 # in Java, but more likely mapped to some error codes in C.
3090 #
3091 # # Other uses
3092 #
3093 # The error model and the `Status` message can be used in a variety of
3094 # environments, either with or without APIs, to provide a
3095 # consistent developer experience across different environments.
3096 #
3097 # Example uses of this error model include:
3098 #
3099 # - Partial errors. If a service needs to return partial errors to the client,
3100 # it may embed the `Status` in the normal response to indicate the partial
3101 # errors.
3102 #
3103 # - Workflow errors. A typical workflow has multiple steps. Each step may
3104 # have a `Status` message for error reporting purpose.
3105 #
3106 # - Batch operations. If a client uses batch request and batch response, the
3107 # `Status` message should be used directly inside batch response, one for
3108 # each error sub-response.
3109 #
3110 # - Asynchronous operations. If an API call embeds asynchronous operation
3111 # results in its response, the status of those operations should be
3112 # represented directly using the `Status` message.
3113 #
3114 # - Logging. If some API errors are stored in logs, the message `Status` could
3115 # be used directly after any stripping needed for security/privacy reasons.
3116 "message": "A String", # A developer-facing error message, which should be in English. Any
3117 # user-facing error message should be localized and sent in the
3118 # google.rpc.Status.details field, or localized by the client.
3119 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
3120 "details": [ # A list of messages that carry the error details. There will be a
3121 # common set of message types for APIs to use.
3122 {
3123 "a_key": "", # Properties of the object. Contains field @type with type URL.
3124 },
3125 ],
3126 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04003127 "done": True or False, # If the value is `false`, it means the operation is still in progress.
3128 # If true, the operation is completed, and either `error` or `response` is
3129 # available.
3130 "response": { # The normal response of the operation in case of success. If the original
3131 # method returns no data on success, such as `Delete`, the response is
3132 # `google.protobuf.Empty`. If the original method is standard
3133 # `Get`/`Create`/`Update`, the response should be the resource. For other
3134 # methods, the response should have the type `XxxResponse`, where `Xxx`
3135 # is the original method name. For example, if the original method name
3136 # is `TakeSnapshot()`, the inferred response type is
3137 # `TakeSnapshotResponse`.
3138 "a_key": "", # Properties of the object. Contains field @type with type URL.
3139 },
3140 "name": "A String", # The server-assigned name, which is only unique within the same service that
3141 # originally returns it. If you use the default HTTP mapping, the
3142 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07003143 }</pre>
3144</div>
3145
3146</body></html>