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