Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(622)

Side by Side Diff: discovery/googleapis/serviceuser__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/servicemanagement__v1.json ('k') | discovery/googleapis/sheets__v4.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform.read-only": {
6 "description": "View your data across Google Cloud Platform services"
7 },
8 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
10 }, 7 },
11 "https://www.googleapis.com/auth/service.management": { 8 "https://www.googleapis.com/auth/service.management": {
12 "description": "Manage your Google API service configuration " 9 "description": "Manage your Google API service configuration "
10 },
11 "https://www.googleapis.com/auth/cloud-platform.read-only": {
12 "description": "View your data across Google Cloud Platform services"
13 } 13 }
14 } 14 }
15 } 15 }
16 }, 16 },
17 "basePath": "", 17 "basePath": "",
18 "baseUrl": "https://serviceuser.googleapis.com/", 18 "baseUrl": "https://serviceuser.googleapis.com/",
19 "batchPath": "batch", 19 "batchPath": "batch",
20 "canonicalName": "Service User", 20 "canonicalName": "Service User",
21 "description": "Enables services that service consumers want to use on Googl e Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", 21 "description": "Enables services that service consumers want to use on Googl e Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
22 "discoveryVersion": "v1", 22 "discoveryVersion": "v1",
23 "documentationLink": "https://cloud.google.com/service-management/", 23 "documentationLink": "https://cloud.google.com/service-management/",
24 "icons": { 24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", 25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" 26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 }, 27 },
28 "id": "serviceuser:v1", 28 "id": "serviceuser:v1",
29 "kind": "discovery#restDescription", 29 "kind": "discovery#restDescription",
30 "name": "serviceuser", 30 "name": "serviceuser",
31 "ownerDomain": "google.com", 31 "ownerDomain": "google.com",
32 "ownerName": "Google", 32 "ownerName": "Google",
33 "parameters": { 33 "parameters": {
34 "oauth_token": {
35 "description": "OAuth 2.0 token for the current user.",
36 "location": "query",
37 "type": "string"
38 },
39 "bearer_token": {
40 "description": "OAuth bearer token.",
41 "location": "query",
42 "type": "string"
43 },
44 "upload_protocol": { 34 "upload_protocol": {
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
46 "location": "query", 36 "location": "query",
47 "type": "string" 37 "type": "string"
48 }, 38 },
49 "prettyPrint": { 39 "prettyPrint": {
50 "default": "true", 40 "default": "true",
51 "description": "Returns response with indentations and line breaks." , 41 "description": "Returns response with indentations and line breaks." ,
52 "location": "query", 42 "location": "query",
53 "type": "boolean" 43 "type": "boolean"
54 }, 44 },
45 "fields": {
46 "description": "Selector specifying which fields to include in a par tial response.",
47 "location": "query",
48 "type": "string"
49 },
55 "uploadType": { 50 "uploadType": {
56 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 51 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
57 "location": "query", 52 "location": "query",
58 "type": "string" 53 "type": "string"
59 }, 54 },
60 "fields": {
61 "description": "Selector specifying which fields to include in a par tial response.",
62 "location": "query",
63 "type": "string"
64 },
65 "callback": { 55 "callback": {
66 "description": "JSONP", 56 "description": "JSONP",
67 "location": "query", 57 "location": "query",
68 "type": "string" 58 "type": "string"
69 }, 59 },
70 "$.xgafv": { 60 "$.xgafv": {
71 "description": "V1 error format.", 61 "description": "V1 error format.",
72 "enum": [ 62 "enum": [
73 "1", 63 "1",
74 "2" 64 "2"
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
109 "quotaUser": { 99 "quotaUser": {
110 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 100 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
111 "location": "query", 101 "location": "query",
112 "type": "string" 102 "type": "string"
113 }, 103 },
114 "pp": { 104 "pp": {
115 "default": "true", 105 "default": "true",
116 "description": "Pretty-print response.", 106 "description": "Pretty-print response.",
117 "location": "query", 107 "location": "query",
118 "type": "boolean" 108 "type": "boolean"
109 },
110 "oauth_token": {
111 "description": "OAuth 2.0 token for the current user.",
112 "location": "query",
113 "type": "string"
114 },
115 "bearer_token": {
116 "description": "OAuth bearer token.",
117 "location": "query",
118 "type": "string"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "services": {
124 "methods": {
125 "search": {
126 "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also r eturns all services the calling user has\n\"servicemanagement.services.bind\" pe rmission for.",
127 "httpMethod": "GET",
128 "id": "serviceuser.services.search",
129 "parameterOrder": [],
130 "parameters": {
131 "pageToken": {
132 "description": "Token identifying which result to st art with; returned by a previous list\ncall.",
133 "location": "query",
134 "type": "string"
135 },
136 "pageSize": {
137 "description": "Requested size of the next page of d ata.",
138 "format": "int32",
139 "location": "query",
140 "type": "integer"
141 }
142 },
143 "path": "v1/services:search",
144 "response": {
145 "$ref": "SearchServicesResponse"
146 },
147 "scopes": [
148 "https://www.googleapis.com/auth/cloud-platform",
149 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
150 ]
151 }
152 }
153 },
123 "projects": { 154 "projects": {
124 "resources": { 155 "resources": {
125 "services": { 156 "services": {
126 "methods": { 157 "methods": {
158 "disable": {
159 "description": "Disable a service so it can no longe r be used with a\nproject. This prevents unintended usage that may cause unexpec ted billing\ncharges or security leaks.\n\nOperation<response: google.protobuf.E mpty>",
160 "httpMethod": "POST",
161 "id": "serviceuser.projects.services.disable",
162 "parameterOrder": [
163 "name"
164 ],
165 "parameters": {
166 "name": {
167 "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accept s the following forms for consumer:\n- \"project:<project_id>\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:d isable",
168 "location": "path",
169 "pattern": "^projects/[^/]+/services/[^/]+$" ,
170 "required": true,
171 "type": "string"
172 }
173 },
174 "path": "v1/{+name}:disable",
175 "request": {
176 "$ref": "DisableServiceRequest"
177 },
178 "response": {
179 "$ref": "Operation"
180 },
181 "scopes": [
182 "https://www.googleapis.com/auth/cloud-platform" ,
183 "https://www.googleapis.com/auth/service.managem ent"
184 ]
185 },
127 "enable": { 186 "enable": {
128 "description": "Enable a service so it can be used w ith a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authenticat ion) for\nmore information.\n\nOperation<response: google.protobuf.Empty>", 187 "description": "Enable a service so it can be used w ith a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authenticat ion) for\nmore information.\n\nOperation<response: google.protobuf.Empty>",
129 "httpMethod": "POST", 188 "httpMethod": "POST",
130 "id": "serviceuser.projects.services.enable", 189 "id": "serviceuser.projects.services.enable",
131 "parameterOrder": [ 190 "parameterOrder": [
132 "name" 191 "name"
133 ], 192 ],
134 "parameters": { 193 "parameters": {
135 "name": { 194 "name": {
136 "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/ my-project/services/servicemanagement.googleapis.com:enable", 195 "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/ my-project/services/servicemanagement.googleapis.com:enable",
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
180 } 239 }
181 }, 240 },
182 "path": "v1/{+parent}/services", 241 "path": "v1/{+parent}/services",
183 "response": { 242 "response": {
184 "$ref": "ListEnabledServicesResponse" 243 "$ref": "ListEnabledServicesResponse"
185 }, 244 },
186 "scopes": [ 245 "scopes": [
187 "https://www.googleapis.com/auth/cloud-platform" , 246 "https://www.googleapis.com/auth/cloud-platform" ,
188 "https://www.googleapis.com/auth/cloud-platform. read-only" 247 "https://www.googleapis.com/auth/cloud-platform. read-only"
189 ] 248 ]
190 },
191 "disable": {
192 "description": "Disable a service so it can no longe r be used with a\nproject. This prevents unintended usage that may cause unexpec ted billing\ncharges or security leaks.\n\nOperation<response: google.protobuf.E mpty>",
193 "httpMethod": "POST",
194 "id": "serviceuser.projects.services.disable",
195 "parameterOrder": [
196 "name"
197 ],
198 "parameters": {
199 "name": {
200 "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accept s the following forms for consumer:\n- \"project:<project_id>\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:d isable",
201 "location": "path",
202 "pattern": "^projects/[^/]+/services/[^/]+$" ,
203 "required": true,
204 "type": "string"
205 }
206 },
207 "path": "v1/{+name}:disable",
208 "request": {
209 "$ref": "DisableServiceRequest"
210 },
211 "response": {
212 "$ref": "Operation"
213 },
214 "scopes": [
215 "https://www.googleapis.com/auth/cloud-platform" ,
216 "https://www.googleapis.com/auth/service.managem ent"
217 ]
218 } 249 }
219 } 250 }
220 } 251 }
221 } 252 }
222 },
223 "services": {
224 "methods": {
225 "search": {
226 "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also r eturns all services the calling user has\n\"servicemanagement.services.bind\" pe rmission for.",
227 "httpMethod": "GET",
228 "id": "serviceuser.services.search",
229 "parameterOrder": [],
230 "parameters": {
231 "pageToken": {
232 "description": "Token identifying which result to st art with; returned by a previous list\ncall.",
233 "location": "query",
234 "type": "string"
235 },
236 "pageSize": {
237 "description": "Requested size of the next page of d ata.",
238 "format": "int32",
239 "location": "query",
240 "type": "integer"
241 }
242 },
243 "path": "v1/services:search",
244 "response": {
245 "$ref": "SearchServicesResponse"
246 },
247 "scopes": [
248 "https://www.googleapis.com/auth/cloud-platform",
249 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
250 ]
251 }
252 }
253 } 253 }
254 }, 254 },
255 "revision": "20170626", 255 "revision": "20170717",
256 "rootUrl": "https://serviceuser.googleapis.com/", 256 "rootUrl": "https://serviceuser.googleapis.com/",
257 "schemas": { 257 "schemas": {
258 "SystemParameters": { 258 "ListEnabledServicesResponse": {
259 "description": "### System parameter configuration\n\nA system param eter is a special kind of parameter defined by the API\nsystem, not by an indivi dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter . This configuration specifies which methods\nchange the names of the system par ameters.", 259 "description": "Response message for `ListEnabledServices` method.",
260 "id": "SystemParameters", 260 "id": "ListEnabledServicesResponse",
261 "properties": { 261 "properties": {
262 "nextPageToken": {
263 "description": "Token that can be passed to `ListEnabledServ ices` to resume a paginated\nquery.",
264 "type": "string"
265 },
266 "services": {
267 "description": "Services enabled for the specified parent.",
268 "items": {
269 "$ref": "PublishedService"
270 },
271 "type": "array"
272 }
273 },
274 "type": "object"
275 },
276 "Endpoint": {
277 "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitorin g\nconfiguration.\n\nExample service configuration:\n\n name: library-example .googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra ry.v1.Library'\n # API be served from endpoint address library-example.goog leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe nd, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n all ow_cors: true",
278 "id": "Endpoint",
279 "properties": {
280 "aliases": {
281 "description": "DEPRECATED: This field is no longer supporte d. Instead of using aliases,\nplease specify multiple google.api.Endpoint for ea ch of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
282 "items": {
283 "type": "string"
284 },
285 "type": "array"
286 },
287 "allowCors": {
288 "description": "Allowing\n[CORS](https://en.wikipedia.org/wi ki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the ba ckends served from this endpoint to\nreceive and respond to HTTP OPTIONS request s. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
289 "type": "boolean"
290 },
291 "name": {
292 "description": "The canonical name of this endpoint.",
293 "type": "string"
294 },
295 "target": {
296 "description": "The specification of an Internet routable ad dress of API frontend that will\nhandle requests to this [API Endpoint](https:// cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 addres s or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.app spot.com\".",
297 "type": "string"
298 },
299 "features": {
300 "description": "The list of features enabled on this endpoin t.",
301 "items": {
302 "type": "string"
303 },
304 "type": "array"
305 },
306 "apis": {
307 "description": "The list of APIs served by this endpoint.\n\ nIf no APIs are specified this translates to \"all APIs\" exported by the\nservi ce, as defined in the top-level service configuration.",
308 "items": {
309 "type": "string"
310 },
311 "type": "array"
312 }
313 },
314 "type": "object"
315 },
316 "OAuthRequirements": {
317 "description": "OAuth scopes are a way to define data and permission s on data. For example,\nthere are scopes defined for \"Read-only access to Goog le Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope fo r an application,\ngiving it permission to access that data on their behalf.\n\n OAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most ca ses: use one or at most two OAuth scopes for an entire family of\nproducts. If y our product has multiple APIs, you should probably be sharing\nthe OAuth scope a cross all of those APIs.\n\nWhen you need finer grained OAuth consent screens: t alk with your product\nmanagement about how developers will use them in practice .\n\nPlease note that even though each of the canonical scopes is enough for a\n request to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
318 "id": "OAuthRequirements",
319 "properties": {
320 "canonicalScopes": {
321 "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth /calendar,\n https://www.googleapis.com/auth/calendar.read ",
322 "type": "string"
323 }
324 },
325 "type": "object"
326 },
327 "Usage": {
328 "description": "Configuration controlling usage of a service.",
329 "id": "Usage",
330 "properties": {
331 "producerNotificationChannel": {
332 "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management cu rrently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) a s a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name fo rmat\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
333 "type": "string"
334 },
262 "rules": { 335 "rules": {
263 "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nEx ample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_heade r: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\ " order.", 336 "description": "A list of usage rules that apply to individu al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w ins\" order.",
264 "items": { 337 "items": {
265 "$ref": "SystemParameterRule" 338 "$ref": "UsageRule"
266 }, 339 },
267 "type": "array" 340 "type": "array"
268 } 341 },
269 }, 342 "requirements": {
270 "type": "object" 343 "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service .name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabl ed'.",
271 }, 344 "items": {
272 "Quota": { 345 "type": "string"
273 "description": "Quota configuration helps to achieve fairness and bu dgeting in service\nusage.\n\nThe quota configuration works this way:\n- The ser vice configuration defines a set of metrics.\n- For API calls, the quota.metric_ rules maps methods to metrics with\n corresponding costs.\n- The quota.limits d efines limits on the metrics, which will be used for\n quota checks at runtime. \n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the re ad_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook m ethod\n # consuming at twice rate as the DeleteBook method.\n metric_rul es:\n - selector: \"*\"\n metric_costs:\n library.googleapis.c om/read_calls: 1\n - selector: google.example.library.v1.LibraryService.Upda teBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metri c_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metri c definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type : INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", 346 },
274 "id": "Quota", 347 "type": "array"
275 "properties": { 348 }
276 "limits": { 349 },
277 "description": "List of `QuotaLimit` definitions for the ser vice.", 350 "type": "object"
278 "items": { 351 },
279 "$ref": "QuotaLimit" 352 "Context": {
280 }, 353 "description": "`Context` defines which contexts an API requests.\n\ nExample:\n\n context:\n rules:\n - selector: \"*\"\n reques ted:\n - google.rpc.context.ProjectContext\n - google.rpc.context. OriginContext\n\nThe above specifies that all methods in the API request\n`googl e.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvaila ble context types are defined in package\n`google.rpc.context`.",
281 "type": "array" 354 "id": "Context",
282 }, 355 "properties": {
283 "metricRules": { 356 "rules": {
284 "description": "List of `MetricRule` definitions, each one m apping a selected method to one\nor more metrics.", 357 "description": "A list of RPC context rules that apply to in dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
285 "items": { 358 "items": {
286 "$ref": "MetricRule" 359 "$ref": "ContextRule"
287 }, 360 },
288 "type": "array" 361 "type": "array"
289 } 362 }
290 }, 363 },
291 "type": "object" 364 "type": "object"
292 }, 365 },
293 "Step": { 366 "LogDescriptor": {
294 "description": "Represents the status of one operation step.", 367 "description": "A description of a log type. Example in YAML format: \n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\ n labels:\n - key: /customer_id\n description: Identifier of a library customer",
295 "id": "Step", 368 "id": "LogDescriptor",
296 "properties": { 369 "properties": {
297 "status": { 370 "labels": {
298 "description": "The status code.", 371 "description": "The set of labels that are available to desc ribe a specific log entry.\nRuntime requests that contain labels not specified h ere are\nconsidered invalid.",
299 "enum": [ 372 "items": {
300 "STATUS_UNSPECIFIED", 373 "$ref": "LabelDescriptor"
301 "DONE", 374 },
302 "NOT_STARTED", 375 "type": "array"
303 "IN_PROGRESS", 376 },
304 "FAILED", 377 "name": {
305 "CANCELLED" 378 "description": "The name of the log. It must be less than 51 2 characters long and can\ninclude the following characters: upper- and lower-ca se alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\ns lash, underscore, hyphen, period [/_-.].",
306 ], 379 "type": "string"
307 "enumDescriptions": [ 380 },
308 "Unspecifed code.", 381 "displayName": {
309 "The operation or step has completed without errors.", 382 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.",
310 "The operation or step has not started yet.",
311 "The operation or step is in progress.",
312 "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
313 "The operation or step has completed with cancellation."
314 ],
315 "type": "string" 383 "type": "string"
316 }, 384 },
317 "description": { 385 "description": {
318 "description": "The short description of the step.", 386 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
319 "type": "string" 387 "type": "string"
320 } 388 }
321 }, 389 },
322 "type": "object" 390 "type": "object"
323 }, 391 },
324 "LoggingDestination": { 392 "CustomErrorRule": {
325 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", 393 "description": "A custom error rule.",
326 "id": "LoggingDestination", 394 "id": "CustomErrorRule",
327 "properties": { 395 "properties": {
328 "logs": { 396 "isErrorType": {
329 "description": "Names of the logs to be sent to this destina tion. Each name must\nbe defined in the Service.logs section. If the log name is \nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", 397 "description": "Mark this message as possible payload in err or response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
398 "type": "boolean"
399 },
400 "selector": {
401 "description": "Selects messages to which this rule applies. \n\nRefer to selector for syntax details.",
402 "type": "string"
403 }
404 },
405 "type": "object"
406 },
407 "MonitoredResourceDescriptor": {
408 "description": "An object that describes the schema of a MonitoredRe source object using a\ntype name and a set of labels. For example, the monitore d resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\" gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zo ne\"` to identify particular VM instances.\n\nDifferent APIs can support differe nt monitored resource types. APIs generally\nprovide a `list` method that return s the monitored resource descriptors used\nby the API.",
409 "id": "MonitoredResourceDescriptor",
410 "properties": {
411 "name": {
412 "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{ty pe}\"` where\n{type} is the value of the `type` field in this object and\n{proje ct_id} is a project ID that provides API-specific context for\naccessing the typ e. APIs that do not use project information can use the\nresource name format ` \"monitoredResourceDescriptors/{type}\"`.",
413 "type": "string"
414 },
415 "description": {
416 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.",
417 "type": "string"
418 },
419 "displayName": {
420 "description": "Optional. A concise name for the monitored r esource type that might be\ndisplayed in user interfaces. It should be a Title C ased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Go ogle Cloud SQL Database\"`.",
421 "type": "string"
422 },
423 "type": {
424 "description": "Required. The monitored resource type. For e xample, the type\n`\"cloudsql_database\"` represents databases in Google Cloud S QL.\nThe maximum length of this value is 256 characters.",
425 "type": "string"
426 },
427 "labels": {
428 "description": "Required. A set of labels used to describe i nstances of this monitored\nresource type. For example, an individual Google Clo ud SQL database is\nidentified by values for the labels `\"database_id\"` and `\ "zone\"`.",
429 "items": {
430 "$ref": "LabelDescriptor"
431 },
432 "type": "array"
433 }
434 },
435 "type": "object"
436 },
437 "MediaDownload": {
438 "description": "Defines the Media configuration for a service in cas e of a download.\nUse this only for Scotty Requests. Do not use this for media s upport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
439 "id": "MediaDownload",
440 "properties": {
441 "useDirectDownload": {
442 "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
443 "type": "boolean"
444 },
445 "enabled": {
446 "description": "Whether download is enabled.",
447 "type": "boolean"
448 },
449 "downloadService": {
450 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
451 "type": "string"
452 },
453 "completeNotification": {
454 "description": "A boolean that determines whether a notifica tion for the completion of a\ndownload should be sent to the backend.",
455 "type": "boolean"
456 },
457 "maxDirectDownloadSize": {
458 "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
459 "format": "int64",
460 "type": "string"
461 },
462 "dropzone": {
463 "description": "Name of the Scotty dropzone to use for the c urrent API.",
464 "type": "string"
465 }
466 },
467 "type": "object"
468 },
469 "CustomAuthRequirements": {
470 "description": "Configuration for a custom authentication provider." ,
471 "id": "CustomAuthRequirements",
472 "properties": {
473 "provider": {
474 "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartSer vice string\n(go/smartservice).",
475 "type": "string"
476 }
477 },
478 "type": "object"
479 },
480 "DisableServiceRequest": {
481 "description": "Request message for DisableService method.",
482 "id": "DisableServiceRequest",
483 "properties": {},
484 "type": "object"
485 },
486 "SearchServicesResponse": {
487 "description": "Response message for SearchServices method.",
488 "id": "SearchServicesResponse",
489 "properties": {
490 "nextPageToken": {
491 "description": "Token that can be passed to `ListAvailableSe rvices` to resume a paginated\nquery.",
492 "type": "string"
493 },
494 "services": {
495 "description": "Services available publicly or available to the authenticated caller.",
496 "items": {
497 "$ref": "PublishedService"
498 },
499 "type": "array"
500 }
501 },
502 "type": "object"
503 },
504 "MediaUpload": {
505 "description": "Defines the Media configuration for a service in cas e of an upload.\nUse this only for Scotty Requests. Do not use this for media su pport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
506 "id": "MediaUpload",
507 "properties": {
508 "enabled": {
509 "description": "Whether upload is enabled.",
510 "type": "boolean"
511 },
512 "progressNotification": {
513 "description": "Whether to receive a notification for progre ss changes of media upload.",
514 "type": "boolean"
515 },
516 "completeNotification": {
517 "description": "A boolean that determines whether a notifica tion for the completion of an\nupload should be sent to the backend. These notif ications will not be seen\nby the client and will not consume quota.",
518 "type": "boolean"
519 },
520 "dropzone": {
521 "description": "Name of the Scotty dropzone to use for the c urrent API.",
522 "type": "string"
523 },
524 "startNotification": {
525 "description": "Whether to receive a notification on the sta rt of media upload.",
526 "type": "boolean"
527 },
528 "uploadService": {
529 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for up load.",
530 "type": "string"
531 },
532 "mimeTypes": {
533 "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
330 "items": { 534 "items": {
331 "type": "string" 535 "type": "string"
332 }, 536 },
333 "type": "array" 537 "type": "array"
334 }, 538 },
335 "monitoredResource": { 539 "maxSize": {
336 "description": "The monitored resource type. The type must b e defined in the\nService.monitored_resources section.", 540 "description": "Optional maximum acceptable size for an uplo ad.\nThe size is specified in bytes.",
337 "type": "string" 541 "format": "int64",
338 } 542 "type": "string"
339 }, 543 }
340 "type": "object" 544 },
341 }, 545 "type": "object"
342 "Option": { 546 },
343 "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", 547 "UsageRule": {
344 "id": "Option", 548 "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the se rvice. Unregistered\ncalls are calls that do not contain consumer project identi ty.\n(Example: calls that do not contain an API key).\nBy default, API methods d o not allow unregistered calls, and each method call\nmust be identified by a co nsumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\ nExample of an API that wants to allow unregistered calls for entire service.\n\ n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_c alls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryServ ice.CreateBook\"\n allow_unregistered_calls: true",
345 "properties": { 549 "id": "UsageRule",
346 "value": { 550 "properties": {
347 "additionalProperties": { 551 "allowUnregisteredCalls": {
348 "description": "Properties of the object. Contains field @type with type URL.", 552 "description": "True, if the method allows unregistered call s; false otherwise.",
349 "type": "any" 553 "type": "boolean"
350 }, 554 },
351 "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/ protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be s tored as an int32\nvalue using the google.protobuf.Int32Value type.", 555 "selector": {
352 "type": "object" 556 "description": "Selects the methods to which this rule appli es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta x details.",
557 "type": "string"
558 },
559 "skipServiceControl": {
560 "description": "True, if the method should skip service cont rol. If so, no control plane\nfeature (like quota and billing) will be enabled." ,
561 "type": "boolean"
562 }
563 },
564 "type": "object"
565 },
566 "AuthRequirement": {
567 "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth -json-web-token-32).",
568 "id": "AuthRequirement",
569 "properties": {
570 "providerId": {
571 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
572 "type": "string"
573 },
574 "audiences": {
575 "description": "NOTE: This will be deprecated soon, once Aut hProvider.audiences is\nimplemented and accepted in all the runtime components.\ n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-jso n-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs wi th audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, i f no audiences are in the setting,\nLibraryService API will only accept JWTs wit h the following audience\n\"https://library-example.googleapis.com/google.exampl e.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.a pps.googleusercontent.com,\n bookstore_web.apps.googleusercontent. com",
576 "type": "string"
577 }
578 },
579 "type": "object"
580 },
581 "Documentation": {
582 "description": "`Documentation` provides the information for describ ing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Goo gle Calendar API gives access\n to most calendar features.\n pages:\n - nam e: Overview\n content: &#40;== include google/foo/overview.md ==&#41;\n - na me: Tutorial\n content: &#40;== include google/foo/tutorial.md ==&#41;\n s ubpages;\n - name: Java\n content: &#40;== include google/foo/tutorial_j ava.md ==&#41;\n rules:\n - selector: google.calendar.Calendar.Get\n descri ption: >\n ...\n - selector: google.calendar.Calendar.Put\n description : >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\nco de blocks are supported. Section headers can be provided and are\ninterpreted re lative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvi a the config at normalization time, where documentation provided\nby config rule s overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>&#91;fully.qualified.proto.nam e]&#91;]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></ pre>\nText can be excluded from doc using the following notation:\n<pre><code>&# 40;-- internal comment --&#41;</code></pre>\nComments can be made conditional us ing a visibility label. The below\ntext will be only rendered if the `BETA` labe l is available:\n<pre><code>&#40;--BETA: comment for BETA users --&#41;</code></ pre>\nA few directives are available in documentation. Note that\ndirectives mus t appear on a single line to be properly\nidentified. The `include` directive in cludes a markdown file from\nan external source:\n<pre><code>&#40;== include pat h/to/file ==&#41;</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools att empt\nto infer the resource from the operations in a collection:\n<pre><code>&#4 0;== resource_for v1.shelves.books ==&#41;</code></pre>\nThe directive `suppress _warning` does not directly affect documentation\nand is documented together wit h service config validation.",
583 "id": "Documentation",
584 "properties": {
585 "overview": {
586 "description": "Declares a single overview page. For example :\n<pre><code>documentation:\n summary: ...\n overview: &#40;== include overvi ew.md ==&#41;\n</code></pre>\nThis is a shortcut for the following declaration ( using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - na me: Overview\n content: &#40;== include overview.md ==&#41;\n</code></pre>\nN ote: you cannot specify both `overview` field and `pages` field.",
587 "type": "string"
588 },
589 "rules": {
590 "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"l ast one wins\" order.",
591 "items": {
592 "$ref": "DocumentationRule"
593 },
594 "type": "array"
595 },
596 "pages": {
597 "description": "The top level pages for the documentation se t.",
598 "items": {
599 "$ref": "Page"
600 },
601 "type": "array"
602 },
603 "summary": {
604 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
605 "type": "string"
606 },
607 "documentationRootUrl": {
608 "description": "The URL to the root of documentation.",
609 "type": "string"
610 }
611 },
612 "type": "object"
613 },
614 "BackendRule": {
615 "description": "A backend rule provides configuration for an individ ual API element.",
616 "id": "BackendRule",
617 "properties": {
618 "selector": {
619 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
620 "type": "string"
621 },
622 "deadline": {
623 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
624 "format": "double",
625 "type": "number"
626 },
627 "minDeadline": {
628 "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
629 "format": "double",
630 "type": "number"
631 },
632 "address": {
633 "description": "The address of the API backend.",
634 "type": "string"
635 }
636 },
637 "type": "object"
638 },
639 "AuthenticationRule": {
640 "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include mor e than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
641 "id": "AuthenticationRule",
642 "properties": {
643 "requirements": {
644 "description": "Requirements for additional authentication p roviders.",
645 "items": {
646 "$ref": "AuthRequirement"
647 },
648 "type": "array"
649 },
650 "allowWithoutCredential": {
651 "description": "Whether to allow requests without a credenti al. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control enviro nment is\nspecified, each incoming request **must** be associated with a service \nconsumer. This can be done by passing an API key that belongs to a consumer\np roject.",
652 "type": "boolean"
653 },
654 "selector": {
655 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
656 "type": "string"
657 },
658 "customAuth": {
659 "$ref": "CustomAuthRequirements",
660 "description": "Configuration for custom authentication."
661 },
662 "oauth": {
663 "$ref": "OAuthRequirements",
664 "description": "The requirements for OAuth credentials."
665 }
666 },
667 "type": "object"
668 },
669 "Api": {
670 "description": "Api is a light-weight descriptor for a protocol buff er service.",
671 "id": "Api",
672 "properties": {
673 "methods": {
674 "description": "The methods of this api, in unspecified orde r.",
675 "items": {
676 "$ref": "Method"
677 },
678 "type": "array"
353 }, 679 },
354 "name": { 680 "name": {
355 "description": "The option's name. For protobuf built-in opt ions (options defined in\ndescriptor.proto), this is the short name. For example , `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. F or example,\n`\"google.api.http\"`.", 681 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.",
356 "type": "string" 682 "type": "string"
357 }
358 },
359 "type": "object"
360 },
361 "Logging": {
362 "description": "Logging configuration of the service.\n\nThe followi ng example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the produc er and consumer projects, whereas the\n`purchase_history` log is only sent to th e producer project.\n\n monitored_resources:\n - type: library.googleapis. com/branch\n labels:\n - key: /city\n description: The city whe re the library branch is located in.\n - key: /name\n description: T he name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n pro ducer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n con sumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
363 "id": "Logging",
364 "properties": {
365 "consumerDestinations": {
366 "description": "Logging configurations for sending logs to t he consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none co nsumer destination.",
367 "items": {
368 "$ref": "LoggingDestination"
369 },
370 "type": "array"
371 },
372 "producerDestinations": {
373 "description": "Logging configurations for sending logs to t he producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none pr oducer destination.",
374 "items": {
375 "$ref": "LoggingDestination"
376 },
377 "type": "array"
378 }
379 },
380 "type": "object"
381 },
382 "Method": {
383 "description": "Method represents a method of an api.",
384 "id": "Method",
385 "properties": {
386 "options": {
387 "description": "Any metadata attached to the method.",
388 "items": {
389 "$ref": "Option"
390 },
391 "type": "array"
392 },
393 "responseStreaming": {
394 "description": "If true, the response is streamed.",
395 "type": "boolean"
396 },
397 "name": {
398 "description": "The simple name of this method.",
399 "type": "string"
400 },
401 "requestTypeUrl": {
402 "description": "A URL of the input message type.",
403 "type": "string"
404 },
405 "requestStreaming": {
406 "description": "If true, the request is streamed.",
407 "type": "boolean"
408 }, 683 },
409 "syntax": { 684 "syntax": {
410 "description": "The source syntax of this method.", 685 "description": "The source syntax of the service.",
411 "enum": [ 686 "enum": [
412 "SYNTAX_PROTO2", 687 "SYNTAX_PROTO2",
413 "SYNTAX_PROTO3" 688 "SYNTAX_PROTO3"
414 ],
415 "enumDescriptions": [
416 "Syntax `proto2`.",
417 "Syntax `proto3`."
418 ],
419 "type": "string"
420 },
421 "responseTypeUrl": {
422 "description": "The URL of the output message type.",
423 "type": "string"
424 }
425 },
426 "type": "object"
427 },
428 "QuotaLimit": {
429 "description": "`QuotaLimit` defines a specific limit that applies o ver a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
430 "id": "QuotaLimit",
431 "properties": {
432 "duration": {
433 "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multip le of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additiona l support will be added in\nthe future. \"0\" indicates indefinite duration.\n\n Used by group-based quotas only.",
434 "type": "string"
435 },
436 "freeTier": {
437 "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subt racted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
438 "format": "int64",
439 "type": "string"
440 },
441 "defaultLimit": {
442 "description": "Default number of tokens that can be consume d during the specified\nduration. This is the number of tokens assigned when a c lient\napplication developer activates the service for his/her project.\n\nSpeci fying a value of 0 will block all requests. This can be used if you\nare provisi oning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUse d by group-based quotas only.",
443 "format": "int64",
444 "type": "string"
445 },
446 "metric": {
447 "description": "The name of the metric this quota limit appl ies to. The quota limits with\nthe same metric will be checked together during r untime. The metric must be\ndefined within the service config.\n\nUsed by metric -based quotas only.",
448 "type": "string"
449 },
450 "description": {
451 "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to under stand this limit\nthan provided by the limit's display name (see: `display_name` ).",
452 "type": "string"
453 },
454 "displayName": {
455 "description": "User-visible display name for this limit.\nO ptional. If not set, the UI will provide a default display name based on\nthe qu ota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
456 "type": "string"
457 },
458 "values": {
459 "additionalProperties": {
460 "format": "int64",
461 "type": "string"
462 },
463 "description": "Tiered limit values, currently only STANDARD is supported.",
464 "type": "object"
465 },
466 "unit": {
467 "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com /service-control)\nsupports the following unit components:\n* One of the time in tevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 h ours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{proj ect}\" for quota per minute per project.\n\nNote: the order of unit components i s insignificant.\nThe \"1\" at the beginning is required to follow the metric un it syntax.\n\nUsed by metric-based quotas only.",
468 "type": "string"
469 },
470 "maxLimit": {
471 "description": "Maximum number of tokens that can be consume d during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default l imit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1 ,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
472 "format": "int64",
473 "type": "string"
474 },
475 "name": {
476 "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\ nFor metric-based quota limits, the name must be provided, and it must be\nuniqu e within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name o f a limit is used as a unique identifier for this limit.\nTherefore, once a limi t has been put into use, its name should be\nimmutable. You can use the display_ name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
477 "type": "string"
478 }
479 },
480 "type": "object"
481 },
482 "Mixin": {
483 "description": "Declares an API to be included in this API. The incl uding API must\nredeclare all the methods from the included API, but documentati on\nand options are inherited as follows:\n\n- If after comment and whitespace s tripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n ve rsion of the including API plus the root path if specified.\n\nExample of a simp le mixin:\n\n package google.acl.v1;\n service AccessControl {\n // G et the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rp c GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\ n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in ` AccessControl` are\nalso declared with same name and request/response types in\n `Storage`. A documentation generator or annotation processor will\nsee the effec tive `Storage.GetAcl` method after inherting\ndocumentation and annotations as f ollows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the vers ion in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP pa ths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nTh is implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns ( Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\" ;\n }\n ...\n }",
484 "id": "Mixin",
485 "properties": {
486 "name": {
487 "description": "The fully qualified name of the API which is included.",
488 "type": "string"
489 },
490 "root": {
491 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
492 "type": "string"
493 }
494 },
495 "type": "object"
496 },
497 "CustomError": {
498 "description": "Customize service error responses. For example, lis t any service\nspecific protobuf types that can appear in error detail lists of\ nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google .foo.v1.CustomError\n - google.foo.v1.AnotherError",
499 "id": "CustomError",
500 "properties": {
501 "types": {
502 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
503 "items": {
504 "type": "string"
505 },
506 "type": "array"
507 },
508 "rules": {
509 "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \" last one wins\" order.",
510 "items": {
511 "$ref": "CustomErrorRule"
512 },
513 "type": "array"
514 }
515 },
516 "type": "object"
517 },
518 "Http": {
519 "description": "Defines the HTTP configuration for an API service. I t contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
520 "id": "Http",
521 "properties": {
522 "fullyDecodeReservedExpansion": {
523 "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expans ion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not deco de RFC 6570 reserved characters in multi\nsegment matches.",
524 "type": "boolean"
525 },
526 "rules": {
527 "description": "A list of HTTP configuration rules that appl y to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
528 "items": {
529 "$ref": "HttpRule"
530 },
531 "type": "array"
532 }
533 },
534 "type": "object"
535 },
536 "SourceInfo": {
537 "description": "Source information used to create a Service Config",
538 "id": "SourceInfo",
539 "properties": {
540 "sourceFiles": {
541 "description": "All files used during config generation.",
542 "items": {
543 "additionalProperties": {
544 "description": "Properties of the object. Contains f ield @type with type URL.",
545 "type": "any"
546 },
547 "type": "object"
548 },
549 "type": "array"
550 }
551 },
552 "type": "object"
553 },
554 "Control": {
555 "description": "Selects and configures the service controller used b y the service. The\nservice controller handles features like abuse, quota, bill ing, logging,\nmonitoring, etc.",
556 "id": "Control",
557 "properties": {
558 "environment": {
559 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.",
560 "type": "string"
561 }
562 },
563 "type": "object"
564 },
565 "SystemParameter": {
566 "description": "Define a parameter's name and location. The paramete r may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
567 "id": "SystemParameter",
568 "properties": {
569 "name": {
570 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.",
571 "type": "string"
572 },
573 "urlQueryParameter": {
574 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.",
575 "type": "string"
576 },
577 "httpHeader": {
578 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.",
579 "type": "string"
580 }
581 },
582 "type": "object"
583 },
584 "Field": {
585 "description": "A single field of a message type.",
586 "id": "Field",
587 "properties": {
588 "kind": {
589 "description": "The field type.",
590 "enum": [
591 "TYPE_UNKNOWN",
592 "TYPE_DOUBLE",
593 "TYPE_FLOAT",
594 "TYPE_INT64",
595 "TYPE_UINT64",
596 "TYPE_INT32",
597 "TYPE_FIXED64",
598 "TYPE_FIXED32",
599 "TYPE_BOOL",
600 "TYPE_STRING",
601 "TYPE_GROUP",
602 "TYPE_MESSAGE",
603 "TYPE_BYTES",
604 "TYPE_UINT32",
605 "TYPE_ENUM",
606 "TYPE_SFIXED32",
607 "TYPE_SFIXED64",
608 "TYPE_SINT32",
609 "TYPE_SINT64"
610 ],
611 "enumDescriptions": [
612 "Field type unknown.",
613 "Field type double.",
614 "Field type float.",
615 "Field type int64.",
616 "Field type uint64.",
617 "Field type int32.",
618 "Field type fixed64.",
619 "Field type fixed32.",
620 "Field type bool.",
621 "Field type string.",
622 "Field type group. Proto2 syntax only, and deprecated.",
623 "Field type message.",
624 "Field type bytes.",
625 "Field type uint32.",
626 "Field type enum.",
627 "Field type sfixed32.",
628 "Field type sfixed64.",
629 "Field type sint32.",
630 "Field type sint64."
631 ],
632 "type": "string"
633 },
634 "jsonName": {
635 "description": "The field JSON name.",
636 "type": "string"
637 },
638 "options": {
639 "description": "The protocol buffer options.",
640 "items": {
641 "$ref": "Option"
642 },
643 "type": "array"
644 },
645 "oneofIndex": {
646 "description": "The index of the field type in `Type.oneofs` , for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
647 "format": "int32",
648 "type": "integer"
649 },
650 "cardinality": {
651 "description": "The field cardinality.",
652 "enum": [
653 "CARDINALITY_UNKNOWN",
654 "CARDINALITY_OPTIONAL",
655 "CARDINALITY_REQUIRED",
656 "CARDINALITY_REPEATED"
657 ],
658 "enumDescriptions": [
659 "For fields with unknown cardinality.",
660 "For optional fields.",
661 "For required fields. Proto2 syntax only.",
662 "For repeated fields."
663 ],
664 "type": "string"
665 },
666 "packed": {
667 "description": "Whether to use alternative packed wire repre sentation.",
668 "type": "boolean"
669 },
670 "defaultValue": {
671 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
672 "type": "string"
673 },
674 "name": {
675 "description": "The field name.",
676 "type": "string"
677 },
678 "typeUrl": {
679 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
680 "type": "string"
681 },
682 "number": {
683 "description": "The field number.",
684 "format": "int32",
685 "type": "integer"
686 }
687 },
688 "type": "object"
689 },
690 "Monitoring": {
691 "description": "Monitoring configuration of the service.\n\nThe exam ple below shows how to configure monitored resources and metrics\nfor monitoring . In the example, a monitored resource and two metrics are\ndefined. The `librar y.googleapis.com/book/returned_count` metric is sent\nto both producer and consu mer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: li brary.googleapis.com/branch\n labels:\n - key: /city\n descript ion: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googl eapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64 \n labels:\n - key: /customer_id\n - name: library.googleapis.com/b ook/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labe ls:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis. com/book/overdue_count",
692 "id": "Monitoring",
693 "properties": {
694 "consumerDestinations": {
695 "description": "Monitoring configurations for sending metric s to the consumer project.\nThere can be multiple consumer destinations, each on e must have a\ndifferent monitored resource type. A metric can be used in at mos t\none consumer destination.",
696 "items": {
697 "$ref": "MonitoringDestination"
698 },
699 "type": "array"
700 },
701 "producerDestinations": {
702 "description": "Monitoring configurations for sending metric s to the producer project.\nThere can be multiple producer destinations, each on e must have a\ndifferent monitored resource type. A metric can be used in at mos t\none producer destination.",
703 "items": {
704 "$ref": "MonitoringDestination"
705 },
706 "type": "array"
707 }
708 },
709 "type": "object"
710 },
711 "Enum": {
712 "description": "Enum type definition.",
713 "id": "Enum",
714 "properties": {
715 "options": {
716 "description": "Protocol buffer options.",
717 "items": {
718 "$ref": "Option"
719 },
720 "type": "array"
721 },
722 "syntax": {
723 "description": "The source syntax.",
724 "enum": [
725 "SYNTAX_PROTO2",
726 "SYNTAX_PROTO3"
727 ], 689 ],
728 "enumDescriptions": [ 690 "enumDescriptions": [
729 "Syntax `proto2`.", 691 "Syntax `proto2`.",
730 "Syntax `proto3`." 692 "Syntax `proto3`."
731 ], 693 ],
732 "type": "string" 694 "type": "string"
733 }, 695 },
734 "sourceContext": { 696 "sourceContext": {
735 "$ref": "SourceContext", 697 "$ref": "SourceContext",
736 "description": "The source context." 698 "description": "Source context for the protocol buffer servi ce represented by this\nmessage."
737 }, 699 },
738 "enumvalue": { 700 "version": {
739 "description": "Enum value definitions.", 701 "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor v ersion\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the f ield is not empty, the version in the\npackage name will be verified to be consi stent with what is\nprovided here.\n\nThe versioning schema uses [semantic\nvers ioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version num bers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also refle cted in the package name of the\nAPI, which must end in `v<major-version>`, as i n\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, none-GA apis.\n",
740 "items": { 702 "type": "string"
741 "$ref": "EnumValue" 703 },
742 }, 704 "mixins": {
743 "type": "array" 705 "description": "Included APIs. See Mixin.",
706 "items": {
707 "$ref": "Mixin"
708 },
709 "type": "array"
710 },
711 "options": {
712 "description": "Any metadata attached to the API.",
713 "items": {
714 "$ref": "Option"
715 },
716 "type": "array"
717 }
718 },
719 "type": "object"
720 },
721 "MetricRule": {
722 "description": "Bind API methods to metrics. Binding a method to a m etric causes that\nmetric's configured quota behaviors to apply to the method ca ll.",
723 "id": "MetricRule",
724 "properties": {
725 "metricCosts": {
726 "additionalProperties": {
727 "format": "int64",
728 "type": "string"
729 },
730 "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the m ap is the metric name, and the values are the amount\nincreased for the metric a gainst which the quota limits are defined.\nThe value must not be negative.",
731 "type": "object"
732 },
733 "selector": {
734 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
735 "type": "string"
736 }
737 },
738 "type": "object"
739 },
740 "Authentication": {
741 "description": "`Authentication` defines the authentication configur ation for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: goog le_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
742 "id": "Authentication",
743 "properties": {
744 "rules": {
745 "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"l ast one wins\" order.",
746 "items": {
747 "$ref": "AuthenticationRule"
748 },
749 "type": "array"
750 },
751 "providers": {
752 "description": "Defines a set of authentication providers th at a service supports.",
753 "items": {
754 "$ref": "AuthProvider"
755 },
756 "type": "array"
757 }
758 },
759 "type": "object"
760 },
761 "Operation": {
762 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
763 "id": "Operation",
764 "properties": {
765 "done": {
766 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
767 "type": "boolean"
768 },
769 "response": {
770 "additionalProperties": {
771 "description": "Properties of the object. Contains field @type with type URL.",
772 "type": "any"
773 },
774 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
775 "type": "object"
744 }, 776 },
745 "name": { 777 "name": {
746 "description": "Enum type name.", 778 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
747 "type": "string" 779 "type": "string"
748 } 780 },
749 }, 781 "error": {
750 "type": "object" 782 "$ref": "Status",
751 }, 783 "description": "The error result of the operation in case of failure or cancellation."
752 "LabelDescriptor": { 784 },
753 "description": "A description of a label.", 785 "metadata": {
754 "id": "LabelDescriptor", 786 "additionalProperties": {
755 "properties": { 787 "description": "Properties of the object. Contains field @type with type URL.",
756 "description": { 788 "type": "any"
757 "description": "A human-readable description for the label." , 789 },
758 "type": "string" 790 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
759 }, 791 "type": "object"
760 "valueType": { 792 }
761 "description": "The type of data that can be assigned to the label.", 793 },
794 "type": "object"
795 },
796 "Page": {
797 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
798 "id": "Page",
799 "properties": {
800 "content": {
801 "description": "The Markdown content of the page. You can us e <code>&#40;== include {path} ==&#41;</code>\nto include content from a Markdow n file.",
802 "type": "string"
803 },
804 "subpages": {
805 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
806 "items": {
807 "$ref": "Page"
808 },
809 "type": "array"
810 },
811 "name": {
812 "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocum entation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== i nclude tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page us ing Markdown reference link syntax:\n`Java`.",
813 "type": "string"
814 }
815 },
816 "type": "object"
817 },
818 "Status": {
819 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
820 "id": "Status",
821 "properties": {
822 "details": {
823 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
824 "items": {
825 "additionalProperties": {
826 "description": "Properties of the object. Contains f ield @type with type URL.",
827 "type": "any"
828 },
829 "type": "object"
830 },
831 "type": "array"
832 },
833 "code": {
834 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
835 "format": "int32",
836 "type": "integer"
837 },
838 "message": {
839 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
840 "type": "string"
841 }
842 },
843 "type": "object"
844 },
845 "AuthProvider": {
846 "description": "Configuration for an anthentication provider, includ ing support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-o auth-json-web-token-32).",
847 "id": "AuthProvider",
848 "properties": {
849 "jwksUri": {
850 "description": "URL of the provider's public key set to vali date signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/open id-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set docume nt:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/op enid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https:// www.googleapis.com/oauth2/v1/certs",
851 "type": "string"
852 },
853 "audiences": {
854 "description": "The list of JWT\n[audiences](https://tools.i etf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowe d to access. A JWT containing any of these audiences will\nbe accepted. When thi s setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\ nwill be accepted. For example, if no audiences are in the setting,\nLibraryServ ice API will only accept JWTs with the following audience\n\"https://library-exa mple.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n book store_web.apps.googleusercontent.com",
855 "type": "string"
856 },
857 "issuer": {
858 "description": "Identifies the principal that issued the JWT . See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4. 1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.c om\nExample: 1234567-compute@developer.gserviceaccount.com",
859 "type": "string"
860 },
861 "id": {
862 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".",
863 "type": "string"
864 }
865 },
866 "type": "object"
867 },
868 "Service": {
869 "description": "`Service` is the root object of Google service confi guration schema. It\ndescribes basic information about a service, such as the na me and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspeci fic aspect, such as auth. See each proto message definition for details.\n\nExam ple:\n\n type: google.api.Service\n config_version: 3\n name: calendar. googleapis.com\n title: Google Calendar API\n apis:\n - name: google.ca lendar.v3.Calendar\n authentication:\n providers:\n - id: google_ca lendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\" \n requirements:\n provider_id: google_calendar_auth",
870 "id": "Service",
871 "properties": {
872 "endpoints": {
873 "description": "Configuration for network endpoints. If thi s is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
874 "items": {
875 "$ref": "Endpoint"
876 },
877 "type": "array"
878 },
879 "logs": {
880 "description": "Defines the logs used by this service.",
881 "items": {
882 "$ref": "LogDescriptor"
883 },
884 "type": "array"
885 },
886 "apis": {
887 "description": "A list of API interfaces exported by this se rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface h ere\nwhich cannot be resolved against the associated IDL files.",
888 "items": {
889 "$ref": "Api"
890 },
891 "type": "array"
892 },
893 "types": {
894 "description": "A list of all proto message types included i n this API service.\nTypes referenced directly or indirectly by the `apis` are\n automatically included. Messages which are not referenced but\nshall be include d, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
895 "items": {
896 "$ref": "Type"
897 },
898 "type": "array"
899 },
900 "sourceInfo": {
901 "$ref": "SourceInfo",
902 "description": "Output only. The source information for this configuration if available."
903 },
904 "http": {
905 "$ref": "Http",
906 "description": "HTTP configuration."
907 },
908 "backend": {
909 "$ref": "Backend",
910 "description": "API backend configuration."
911 },
912 "systemParameters": {
913 "$ref": "SystemParameters",
914 "description": "System parameter configuration."
915 },
916 "documentation": {
917 "$ref": "Documentation",
918 "description": "Additional API documentation."
919 },
920 "logging": {
921 "$ref": "Logging",
922 "description": "Logging configuration."
923 },
924 "monitoredResources": {
925 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.",
926 "items": {
927 "$ref": "MonitoredResourceDescriptor"
928 },
929 "type": "array"
930 },
931 "enums": {
932 "description": "A list of all enum types included in this AP I service. Enums\nreferenced directly or indirectly by the `apis` are automatic ally\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.Some Enum",
933 "items": {
934 "$ref": "Enum"
935 },
936 "type": "array"
937 },
938 "context": {
939 "$ref": "Context",
940 "description": "Context configuration."
941 },
942 "id": {
943 "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the s erver may choose to\ngenerate one instead.",
944 "type": "string"
945 },
946 "usage": {
947 "$ref": "Usage",
948 "description": "Configuration controlling usage of this serv ice."
949 },
950 "metrics": {
951 "description": "Defines the metrics used by this service.",
952 "items": {
953 "$ref": "MetricDescriptor"
954 },
955 "type": "array"
956 },
957 "authentication": {
958 "$ref": "Authentication",
959 "description": "Auth configuration."
960 },
961 "experimental": {
962 "$ref": "Experimental",
963 "description": "Experimental configuration."
964 },
965 "control": {
966 "$ref": "Control",
967 "description": "Configuration for the service control plane. "
968 },
969 "configVersion": {
970 "description": "The version of the service configuration. Th e config version may\ninfluence interpretation of the configuration, for example , to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
971 "format": "uint32",
972 "type": "integer"
973 },
974 "monitoring": {
975 "$ref": "Monitoring",
976 "description": "Monitoring configuration."
977 },
978 "producerProjectId": {
979 "description": "The Google project that owns this service.",
980 "type": "string"
981 },
982 "systemTypes": {
983 "description": "A list of all proto message types included i n this API service.\nIt serves similar purpose as [google.api.Service.types], ex cept that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
984 "items": {
985 "$ref": "Type"
986 },
987 "type": "array"
988 },
989 "visibility": {
990 "$ref": "Visibility",
991 "description": "API visibility configuration."
992 },
993 "quota": {
994 "$ref": "Quota",
995 "description": "Quota configuration."
996 },
997 "name": {
998 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
999 "type": "string"
1000 },
1001 "customError": {
1002 "$ref": "CustomError",
1003 "description": "Custom error configuration."
1004 },
1005 "title": {
1006 "description": "The product title for this service.",
1007 "type": "string"
1008 }
1009 },
1010 "type": "object"
1011 },
1012 "EnumValue": {
1013 "description": "Enum value definition.",
1014 "id": "EnumValue",
1015 "properties": {
1016 "options": {
1017 "description": "Protocol buffer options.",
1018 "items": {
1019 "$ref": "Option"
1020 },
1021 "type": "array"
1022 },
1023 "number": {
1024 "description": "Enum value number.",
1025 "format": "int32",
1026 "type": "integer"
1027 },
1028 "name": {
1029 "description": "Enum value name.",
1030 "type": "string"
1031 }
1032 },
1033 "type": "object"
1034 },
1035 "OperationMetadata": {
1036 "description": "The metadata associated with a long running operatio n resource.",
1037 "id": "OperationMetadata",
1038 "properties": {
1039 "startTime": {
1040 "description": "The start time of the operation.",
1041 "format": "google-datetime",
1042 "type": "string"
1043 },
1044 "steps": {
1045 "description": "Detailed status information for each step. T he order is undetermined.",
1046 "items": {
1047 "$ref": "Step"
1048 },
1049 "type": "array"
1050 },
1051 "resourceNames": {
1052 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
1053 "items": {
1054 "type": "string"
1055 },
1056 "type": "array"
1057 },
1058 "progressPercentage": {
1059 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
1060 "format": "int32",
1061 "type": "integer"
1062 }
1063 },
1064 "type": "object"
1065 },
1066 "CustomHttpPattern": {
1067 "description": "A custom pattern is used for defining custom HTTP ve rb.",
1068 "id": "CustomHttpPattern",
1069 "properties": {
1070 "kind": {
1071 "description": "The name of this custom HTTP verb.",
1072 "type": "string"
1073 },
1074 "path": {
1075 "description": "The path matched by this custom verb.",
1076 "type": "string"
1077 }
1078 },
1079 "type": "object"
1080 },
1081 "SystemParameterRule": {
1082 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
1083 "id": "SystemParameterRule",
1084 "properties": {
1085 "selector": {
1086 "description": "Selects the methods to which this rule appli es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta x details.",
1087 "type": "string"
1088 },
1089 "parameters": {
1090 "description": "Define parameters. Multiple names may be def ined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
1091 "items": {
1092 "$ref": "SystemParameter"
1093 },
1094 "type": "array"
1095 }
1096 },
1097 "type": "object"
1098 },
1099 "PublishedService": {
1100 "description": "The published version of a Service that is managed b y\nGoogle Service Management.",
1101 "id": "PublishedService",
1102 "properties": {
1103 "service": {
1104 "$ref": "Service",
1105 "description": "The service's published configuration."
1106 },
1107 "name": {
1108 "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
1109 "type": "string"
1110 }
1111 },
1112 "type": "object"
1113 },
1114 "HttpRule": {
1115 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nH TTP request body. The mapping is typically specified as an\n`google.api.http` an notation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n \nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the examp le below which describes a REST GET\noperation on a resource collection of messa ges:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) retur ns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_i d}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n mes sage SubMessage {\n string subfield = 1;\n }\n string message_i d = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is u rl-mapped\n }\n message Message {\n string text = 1; // content of th e resource\n }\n\nThe same http annotation can alternatively be expressed ins ide the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messa ges/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrect ional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v 1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(sub field: \"foo\"))`\n\nIn general, not only fields but also field paths can be ref erenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepea ted and must have a primitive (non-message) type.\n\nAny fields in the request m essage which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\ n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (M essage) {\n option (google.api.http).get = \"/v1/messages/{message_id}\"; \n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage s ub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123 456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to H TTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nr epeated in the URL, as in `...?param=A&param=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST u pdate method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n optio n (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2 ; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \ "Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define tha t\nevery field not bound by the path template should be mapped to the\nrequest b ody. This enables the following alternative definition of\nthe update method:\n \n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\ n option (google.api.http) = {\n put: \"/v1/messages/{message_id }\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HT TP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages /123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"H i!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nh ave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The commo n usage of `*` is in custom methods\nwhich don't use the URL at all for transfer ring data.\n\nIt is possible to define multiple HTTP methods for one RPC by usin g\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.ap i.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_ bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n stri ng message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the follo wing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GE T /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me /messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Ru les for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and b ody fields\nto the request message are as follows:\n\n1. The `body` field specif ies either `*` or a field path, or is\n omitted. If omitted, it indicates ther e is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messag es in the\n request) can be classified into three types:\n (a) Matched in t he URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other field s.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\ n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe synta x of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | L ITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe s yntax `*` matches a single path segment. The syntax `**` matches zero\nor more p ath segments, which must be the last part of the path except the\n`Verb`. The sy ntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matche s part of the URL path as specified by its\ntemplate. A variable template must n ot contain other variables. If a variable\nmatches a single path segment, its te mplate may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variabl e contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a- zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=f oo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, a ll\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nsh ow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment v ariable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570 ) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not* * match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ ndoes not expand special characters like `?` and `#`, which would lead\nto inval id URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
1116 "id": "HttpRule",
1117 "properties": {
1118 "custom": {
1119 "$ref": "CustomHttpPattern",
1120 "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\ " to leave the\nHTTP method unspecified for this rule. The wild-card rule is use ful\nfor services that provide content to Web (HTML) clients."
1121 },
1122 "patch": {
1123 "description": "Used for updating a resource.",
1124 "type": "string"
1125 },
1126 "get": {
1127 "description": "Used for listing and getting information abo ut resources.",
1128 "type": "string"
1129 },
1130 "put": {
1131 "description": "Used for updating a resource.",
1132 "type": "string"
1133 },
1134 "delete": {
1135 "description": "Used for deleting a resource.",
1136 "type": "string"
1137 },
1138 "body": {
1139 "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the pat h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie ld and must be\npresent at the top-level of request message type.",
1140 "type": "string"
1141 },
1142 "mediaDownload": {
1143 "$ref": "MediaDownload",
1144 "description": "Use this only for Scotty Requests. Do not us e this for bytestream methods.\nFor media support, add instead [][google.bytestr eam.RestByteStream] as an\nAPI to your configuration."
1145 },
1146 "post": {
1147 "description": "Used for creating a resource.",
1148 "type": "string"
1149 },
1150 "restMethodName": {
1151 "description": "Optional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default m ethod name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest m ethod name \"create\", but\n for backwards compatability with apiary, it is spec ified as insert.",
1152 "type": "string"
1153 },
1154 "additionalBindings": {
1155 "description": "Additional HTTP bindings for the selector. N ested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
1156 "items": {
1157 "$ref": "HttpRule"
1158 },
1159 "type": "array"
1160 },
1161 "restCollection": {
1162 "description": "Optional. The REST collection name is by def ault derived from the URL\npattern. If specified, this field overrides the defau lt collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggreg atedListRequest)\n returns (AddressesAggregatedListResponse) {\n opt ion (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/a ddresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\n This method has the automatically derived collection name\n\"projects.aggregated \". Because, semantically, this rpc is actually an\noperation on the \"projects. addresses\" collection, the `rest_collection`\nfield is configured to override t he derived collection name.",
1163 "type": "string"
1164 },
1165 "responseBody": {
1166 "description": "The name of the response field whose value i s mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
1167 "type": "string"
1168 },
1169 "mediaUpload": {
1170 "$ref": "MediaUpload",
1171 "description": "Use this only for Scotty Requests. Do not us e this for media support using\nBytestream, add instead\n[][google.bytestream.Re stByteStream] as an API to your\nconfiguration for Bytestream methods."
1172 },
1173 "selector": {
1174 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.",
1175 "type": "string"
1176 }
1177 },
1178 "type": "object"
1179 },
1180 "VisibilityRule": {
1181 "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
1182 "id": "VisibilityRule",
1183 "properties": {
1184 "restriction": {
1185 "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but no t all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restrictio n will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
1186 "type": "string"
1187 },
1188 "selector": {
1189 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
1190 "type": "string"
1191 }
1192 },
1193 "type": "object"
1194 },
1195 "MonitoringDestination": {
1196 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
1197 "id": "MonitoringDestination",
1198 "properties": {
1199 "monitoredResource": {
1200 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
1201 "type": "string"
1202 },
1203 "metrics": {
1204 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.",
1205 "items": {
1206 "type": "string"
1207 },
1208 "type": "array"
1209 }
1210 },
1211 "type": "object"
1212 },
1213 "Visibility": {
1214 "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g ., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visi bility for multiple labels is the union of each label's\nelements, plus any unre stricted elements.\n\nIf an element and its parents have no restrictions, visibi lity is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n res triction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for t he restricted methods\nEnhancedSearch and Delegate.",
1215 "id": "Visibility",
1216 "properties": {
1217 "rules": {
1218 "description": "A list of visibility rules that apply to ind ividual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
1219 "items": {
1220 "$ref": "VisibilityRule"
1221 },
1222 "type": "array"
1223 }
1224 },
1225 "type": "object"
1226 },
1227 "SystemParameters": {
1228 "description": "### System parameter configuration\n\nA system param eter is a special kind of parameter defined by the API\nsystem, not by an indivi dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter . This configuration specifies which methods\nchange the names of the system par ameters.",
1229 "id": "SystemParameters",
1230 "properties": {
1231 "rules": {
1232 "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nEx ample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_heade r: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\ " order.",
1233 "items": {
1234 "$ref": "SystemParameterRule"
1235 },
1236 "type": "array"
1237 }
1238 },
1239 "type": "object"
1240 },
1241 "Quota": {
1242 "description": "Quota configuration helps to achieve fairness and bu dgeting in service\nusage.\n\nThe quota configuration works this way:\n- The ser vice configuration defines a set of metrics.\n- For API calls, the quota.metric_ rules maps methods to metrics with\n corresponding costs.\n- The quota.limits d efines limits on the metrics, which will be used for\n quota checks at runtime. \n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the re ad_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook m ethod\n # consuming at twice rate as the DeleteBook method.\n metric_rul es:\n - selector: \"*\"\n metric_costs:\n library.googleapis.c om/read_calls: 1\n - selector: google.example.library.v1.LibraryService.Upda teBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metri c_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metri c definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type : INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
1243 "id": "Quota",
1244 "properties": {
1245 "limits": {
1246 "description": "List of `QuotaLimit` definitions for the ser vice.",
1247 "items": {
1248 "$ref": "QuotaLimit"
1249 },
1250 "type": "array"
1251 },
1252 "metricRules": {
1253 "description": "List of `MetricRule` definitions, each one m apping a selected method to one\nor more metrics.",
1254 "items": {
1255 "$ref": "MetricRule"
1256 },
1257 "type": "array"
1258 }
1259 },
1260 "type": "object"
1261 },
1262 "Step": {
1263 "description": "Represents the status of one operation step.",
1264 "id": "Step",
1265 "properties": {
1266 "status": {
1267 "description": "The status code.",
762 "enum": [ 1268 "enum": [
763 "STRING", 1269 "STATUS_UNSPECIFIED",
764 "BOOL", 1270 "DONE",
765 "INT64" 1271 "NOT_STARTED",
1272 "IN_PROGRESS",
1273 "FAILED",
1274 "CANCELLED"
766 ], 1275 ],
767 "enumDescriptions": [ 1276 "enumDescriptions": [
768 "A variable-length string. This is the default.", 1277 "Unspecifed code.",
769 "Boolean; true or false.", 1278 "The operation or step has completed without errors.",
770 "A 64-bit signed integer." 1279 "The operation or step has not started yet.",
1280 "The operation or step is in progress.",
1281 "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
1282 "The operation or step has completed with cancellation."
771 ], 1283 ],
772 "type": "string" 1284 "type": "string"
773 }, 1285 },
774 "key": { 1286 "description": {
775 "description": "The label key.", 1287 "description": "The short description of the step.",
776 "type": "string" 1288 "type": "string"
777 } 1289 }
778 }, 1290 },
779 "type": "object" 1291 "type": "object"
780 }, 1292 },
781 "EnableServiceRequest": { 1293 "LoggingDestination": {
782 "description": "Request message for EnableService method.", 1294 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
783 "id": "EnableServiceRequest", 1295 "id": "LoggingDestination",
784 "properties": {}, 1296 "properties": {
785 "type": "object" 1297 "logs": {
786 }, 1298 "description": "Names of the logs to be sent to this destina tion. Each name must\nbe defined in the Service.logs section. If the log name is \nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
787 "Type": { 1299 "items": {
788 "description": "A protocol buffer message type.", 1300 "type": "string"
789 "id": "Type", 1301 },
790 "properties": { 1302 "type": "array"
1303 },
1304 "monitoredResource": {
1305 "description": "The monitored resource type. The type must b e defined in the\nService.monitored_resources section.",
1306 "type": "string"
1307 }
1308 },
1309 "type": "object"
1310 },
1311 "Option": {
1312 "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
1313 "id": "Option",
1314 "properties": {
1315 "name": {
1316 "description": "The option's name. For protobuf built-in opt ions (options defined in\ndescriptor.proto), this is the short name. For example , `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. F or example,\n`\"google.api.http\"`.",
1317 "type": "string"
1318 },
1319 "value": {
1320 "additionalProperties": {
1321 "description": "Properties of the object. Contains field @type with type URL.",
1322 "type": "any"
1323 },
1324 "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/ protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be s tored as an int32\nvalue using the google.protobuf.Int32Value type.",
1325 "type": "object"
1326 }
1327 },
1328 "type": "object"
1329 },
1330 "Logging": {
1331 "description": "Logging configuration of the service.\n\nThe followi ng example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the produc er and consumer projects, whereas the\n`purchase_history` log is only sent to th e producer project.\n\n monitored_resources:\n - type: library.googleapis. com/branch\n labels:\n - key: /city\n description: The city whe re the library branch is located in.\n - key: /name\n description: T he name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n pro ducer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n con sumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
1332 "id": "Logging",
1333 "properties": {
1334 "consumerDestinations": {
1335 "description": "Logging configurations for sending logs to t he consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none co nsumer destination.",
1336 "items": {
1337 "$ref": "LoggingDestination"
1338 },
1339 "type": "array"
1340 },
1341 "producerDestinations": {
1342 "description": "Logging configurations for sending logs to t he producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none pr oducer destination.",
1343 "items": {
1344 "$ref": "LoggingDestination"
1345 },
1346 "type": "array"
1347 }
1348 },
1349 "type": "object"
1350 },
1351 "Method": {
1352 "description": "Method represents a method of an api.",
1353 "id": "Method",
1354 "properties": {
1355 "responseTypeUrl": {
1356 "description": "The URL of the output message type.",
1357 "type": "string"
1358 },
791 "options": { 1359 "options": {
792 "description": "The protocol buffer options.", 1360 "description": "Any metadata attached to the method.",
793 "items": { 1361 "items": {
794 "$ref": "Option" 1362 "$ref": "Option"
795 }, 1363 },
796 "type": "array" 1364 "type": "array"
797 }, 1365 },
798 "fields": { 1366 "responseStreaming": {
799 "description": "The list of fields.", 1367 "description": "If true, the response is streamed.",
800 "items": { 1368 "type": "boolean"
801 "$ref": "Field"
802 },
803 "type": "array"
804 }, 1369 },
805 "name": { 1370 "name": {
806 "description": "The fully qualified message name.", 1371 "description": "The simple name of this method.",
807 "type": "string" 1372 "type": "string"
808 }, 1373 },
809 "oneofs": { 1374 "requestTypeUrl": {
810 "description": "The list of types appearing in `oneof` defin itions in this type.", 1375 "description": "A URL of the input message type.",
811 "items": { 1376 "type": "string"
812 "type": "string" 1377 },
813 }, 1378 "requestStreaming": {
814 "type": "array" 1379 "description": "If true, the request is streamed.",
1380 "type": "boolean"
815 }, 1381 },
816 "syntax": { 1382 "syntax": {
817 "description": "The source syntax.", 1383 "description": "The source syntax of this method.",
818 "enum": [ 1384 "enum": [
819 "SYNTAX_PROTO2", 1385 "SYNTAX_PROTO2",
820 "SYNTAX_PROTO3" 1386 "SYNTAX_PROTO3"
821 ], 1387 ],
822 "enumDescriptions": [ 1388 "enumDescriptions": [
823 "Syntax `proto2`.", 1389 "Syntax `proto2`.",
824 "Syntax `proto3`." 1390 "Syntax `proto3`."
825 ], 1391 ],
826 "type": "string" 1392 "type": "string"
827 }, 1393 }
828 "sourceContext": { 1394 },
829 "$ref": "SourceContext", 1395 "type": "object"
830 "description": "The source context." 1396 },
831 } 1397 "QuotaLimit": {
832 }, 1398 "description": "`QuotaLimit` defines a specific limit that applies o ver a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
833 "type": "object" 1399 "id": "QuotaLimit",
834 }, 1400 "properties": {
835 "Experimental": { 1401 "duration": {
836 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.", 1402 "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multip le of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additiona l support will be added in\nthe future. \"0\" indicates indefinite duration.\n\n Used by group-based quotas only.",
837 "id": "Experimental", 1403 "type": "string"
838 "properties": { 1404 },
839 "authorization": { 1405 "freeTier": {
840 "$ref": "AuthorizationConfig", 1406 "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subt racted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
841 "description": "Authorization configuration." 1407 "format": "int64",
842 } 1408 "type": "string"
843 }, 1409 },
844 "type": "object" 1410 "defaultLimit": {
845 }, 1411 "description": "Default number of tokens that can be consume d during the specified\nduration. This is the number of tokens assigned when a c lient\napplication developer activates the service for his/her project.\n\nSpeci fying a value of 0 will block all requests. This can be used if you\nare provisi oning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUse d by group-based quotas only.",
846 "Backend": { 1412 "format": "int64",
847 "description": "`Backend` defines the backend configuration for a se rvice.", 1413 "type": "string"
848 "id": "Backend", 1414 },
849 "properties": { 1415 "displayName": {
850 "rules": { 1416 "description": "User-visible display name for this limit.\nO ptional. If not set, the UI will provide a default display name based on\nthe qu ota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
851 "description": "A list of API backend rules that apply to in dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", 1417 "type": "string"
852 "items": { 1418 },
853 "$ref": "BackendRule"
854 },
855 "type": "array"
856 }
857 },
858 "type": "object"
859 },
860 "AuthorizationConfig": {
861 "description": "Configuration of authorization.\n\nThis section dete rmines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n pr ovider: firebaserules.googleapis.com",
862 "id": "AuthorizationConfig",
863 "properties": {
864 "provider": {
865 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
866 "type": "string"
867 }
868 },
869 "type": "object"
870 },
871 "DocumentationRule": {
872 "description": "A documentation rule provides information about indi vidual API elements.",
873 "id": "DocumentationRule",
874 "properties": {
875 "description": { 1419 "description": {
876 "description": "Description of the selected API(s).", 1420 "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to under stand this limit\nthan provided by the limit's display name (see: `display_name` ).",
877 "type": "string" 1421 "type": "string"
878 }, 1422 },
879 "deprecationDescription": { 1423 "metric": {
880 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.", 1424 "description": "The name of the metric this quota limit appl ies to. The quota limits with\nthe same metric will be checked together during r untime. The metric must be\ndefined within the service config.\n\nUsed by metric -based quotas only.",
881 "type": "string" 1425 "type": "string"
882 }, 1426 },
883 "selector": { 1427 "values": {
884 "description": "The selector is a comma-separated list of pa tterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole c omponent of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"f oo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
885 "type": "string"
886 }
887 },
888 "type": "object"
889 },
890 "ContextRule": {
891 "description": "A context rule provides information about the contex t for an individual API\nelement.",
892 "id": "ContextRule",
893 "properties": {
894 "requested": {
895 "description": "A list of full type names of requested conte xts.",
896 "items": {
897 "type": "string"
898 },
899 "type": "array"
900 },
901 "selector": {
902 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
903 "type": "string"
904 },
905 "provided": {
906 "description": "A list of full type names of provided contex ts.",
907 "items": {
908 "type": "string"
909 },
910 "type": "array"
911 }
912 },
913 "type": "object"
914 },
915 "MetricDescriptor": {
916 "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
917 "id": "MetricDescriptor",
918 "properties": {
919 "name": {
920 "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent re source name\nthat defines the scope of the metric type or of its data; and (2) t he\nmetric's URL-encoded type, which also appears in the `type` field of this\nd escriptor. For example, following is the resource name of a custom\nmetric withi n the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescrip tors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
921 "type": "string"
922 },
923 "type": {
924 "description": "The metric type, including its DNS name pref ix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchi cal\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\" \n \"appengine.googleapis.com/http/server/response_latencies\"",
925 "type": "string"
926 },
927 "valueType": {
928 "description": "Whether the measurement is an integer, a flo ating-point number, etc.\nSome combinations of `metric_kind` and `value_type` mi ght not be supported.",
929 "enum": [
930 "VALUE_TYPE_UNSPECIFIED",
931 "BOOL",
932 "INT64",
933 "DOUBLE",
934 "STRING",
935 "DISTRIBUTION",
936 "MONEY"
937 ],
938 "enumDescriptions": [
939 "Do not use this default value.",
940 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.",
941 "The value is a signed 64-bit integer.",
942 "The value is a double precision floating point number." ,
943 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.",
944 "The value is a `Distribution`.",
945 "The value is money."
946 ],
947 "type": "string"
948 },
949 "metricKind": {
950 "description": "Whether the metric records instantaneous val ues, changes to a value, etc.\nSome combinations of `metric_kind` and `value_typ e` might not be supported.",
951 "enum": [
952 "METRIC_KIND_UNSPECIFIED",
953 "GAUGE",
954 "DELTA",
955 "CUMULATIVE"
956 ],
957 "enumDescriptions": [
958 "Do not use this default value.",
959 "An instantaneous measurement of a value.",
960 "The change in a value during a time interval.",
961 "A value accumulated over a time interval. Cumulative\n measurements in a time series should have the same start time\nand increasing en d times, until an event resets the cumulative\nvalue to zero and sets a new star t time for the following\npoints."
962 ],
963 "type": "string"
964 },
965 "description": {
966 "description": "A detailed description of the metric, which can be used in documentation.",
967 "type": "string"
968 },
969 "displayName": {
970 "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for e xample \"Request count\".",
971 "type": "string"
972 },
973 "unit": {
974 "description": "The unit in which the metric value is report ed. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIB UTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMea sure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n \n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` h our\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P ` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n * `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**- 6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto ( 10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yo cto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includ es the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotati on\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s` , `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable AS CII characters not\n containing '{' or '}'.",
975 "type": "string"
976 },
977 "labels": {
978 "description": "The set of labels that can be used to descri be a specific\ninstance of this metric type. For example, the\n`appengine.google apis.com/http/server/response_latencies` metric\ntype has a label for the HTTP r esponse code, `response_code`, so\nyou can look at latencies for successful resp onses or just\nfor responses that failed.",
979 "items": {
980 "$ref": "LabelDescriptor"
981 },
982 "type": "array"
983 }
984 },
985 "type": "object"
986 },
987 "SourceContext": {
988 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
989 "id": "SourceContext",
990 "properties": {
991 "fileName": {
992 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.",
993 "type": "string"
994 }
995 },
996 "type": "object"
997 },
998 "Endpoint": {
999 "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitorin g\nconfiguration.\n\nExample service configuration:\n\n name: library-example .googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra ry.v1.Library'\n # API be served from endpoint address library-example.goog leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe nd, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n all ow_cors: true",
1000 "id": "Endpoint",
1001 "properties": {
1002 "apis": {
1003 "description": "The list of APIs served by this endpoint.\n\ nIf no APIs are specified this translates to \"all APIs\" exported by the\nservi ce, as defined in the top-level service configuration.",
1004 "items": {
1005 "type": "string"
1006 },
1007 "type": "array"
1008 },
1009 "aliases": {
1010 "description": "DEPRECATED: This field is no longer supporte d. Instead of using aliases,\nplease specify multiple google.api.Endpoint for ea ch of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
1011 "items": {
1012 "type": "string"
1013 },
1014 "type": "array"
1015 },
1016 "allowCors": {
1017 "description": "Allowing\n[CORS](https://en.wikipedia.org/wi ki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the ba ckends served from this endpoint to\nreceive and respond to HTTP OPTIONS request s. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
1018 "type": "boolean"
1019 },
1020 "target": {
1021 "description": "The specification of an Internet routable ad dress of API frontend that will\nhandle requests to this [API Endpoint](https:// cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 addres s or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.app spot.com\".",
1022 "type": "string"
1023 },
1024 "name": {
1025 "description": "The canonical name of this endpoint.",
1026 "type": "string"
1027 },
1028 "features": {
1029 "description": "The list of features enabled on this endpoin t.",
1030 "items": {
1031 "type": "string"
1032 },
1033 "type": "array"
1034 }
1035 },
1036 "type": "object"
1037 },
1038 "ListEnabledServicesResponse": {
1039 "description": "Response message for `ListEnabledServices` method.",
1040 "id": "ListEnabledServicesResponse",
1041 "properties": {
1042 "nextPageToken": {
1043 "description": "Token that can be passed to `ListEnabledServ ices` to resume a paginated\nquery.",
1044 "type": "string"
1045 },
1046 "services": {
1047 "description": "Services enabled for the specified parent.",
1048 "items": {
1049 "$ref": "PublishedService"
1050 },
1051 "type": "array"
1052 }
1053 },
1054 "type": "object"
1055 },
1056 "OAuthRequirements": {
1057 "description": "OAuth scopes are a way to define data and permission s on data. For example,\nthere are scopes defined for \"Read-only access to Goog le Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope fo r an application,\ngiving it permission to access that data on their behalf.\n\n OAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most ca ses: use one or at most two OAuth scopes for an entire family of\nproducts. If y our product has multiple APIs, you should probably be sharing\nthe OAuth scope a cross all of those APIs.\n\nWhen you need finer grained OAuth consent screens: t alk with your product\nmanagement about how developers will use them in practice .\n\nPlease note that even though each of the canonical scopes is enough for a\n request to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
1058 "id": "OAuthRequirements",
1059 "properties": {
1060 "canonicalScopes": {
1061 "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth /calendar,\n https://www.googleapis.com/auth/calendar.read ",
1062 "type": "string"
1063 }
1064 },
1065 "type": "object"
1066 },
1067 "Usage": {
1068 "description": "Configuration controlling usage of a service.",
1069 "id": "Usage",
1070 "properties": {
1071 "producerNotificationChannel": {
1072 "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management cu rrently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) a s a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name fo rmat\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
1073 "type": "string"
1074 },
1075 "rules": {
1076 "description": "A list of usage rules that apply to individu al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w ins\" order.",
1077 "items": {
1078 "$ref": "UsageRule"
1079 },
1080 "type": "array"
1081 },
1082 "requirements": {
1083 "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service .name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabl ed'.",
1084 "items": {
1085 "type": "string"
1086 },
1087 "type": "array"
1088 }
1089 },
1090 "type": "object"
1091 },
1092 "Context": {
1093 "description": "`Context` defines which contexts an API requests.\n\ nExample:\n\n context:\n rules:\n - selector: \"*\"\n reques ted:\n - google.rpc.context.ProjectContext\n - google.rpc.context. OriginContext\n\nThe above specifies that all methods in the API request\n`googl e.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvaila ble context types are defined in package\n`google.rpc.context`.",
1094 "id": "Context",
1095 "properties": {
1096 "rules": {
1097 "description": "A list of RPC context rules that apply to in dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
1098 "items": {
1099 "$ref": "ContextRule"
1100 },
1101 "type": "array"
1102 }
1103 },
1104 "type": "object"
1105 },
1106 "LogDescriptor": {
1107 "description": "A description of a log type. Example in YAML format: \n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\ n labels:\n - key: /customer_id\n description: Identifier of a library customer",
1108 "id": "LogDescriptor",
1109 "properties": {
1110 "name": {
1111 "description": "The name of the log. It must be less than 51 2 characters long and can\ninclude the following characters: upper- and lower-ca se alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\ns lash, underscore, hyphen, period [/_-.].",
1112 "type": "string"
1113 },
1114 "displayName": {
1115 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.",
1116 "type": "string"
1117 },
1118 "description": {
1119 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
1120 "type": "string"
1121 },
1122 "labels": {
1123 "description": "The set of labels that are available to desc ribe a specific log entry.\nRuntime requests that contain labels not specified h ere are\nconsidered invalid.",
1124 "items": {
1125 "$ref": "LabelDescriptor"
1126 },
1127 "type": "array"
1128 }
1129 },
1130 "type": "object"
1131 },
1132 "MonitoredResourceDescriptor": {
1133 "description": "An object that describes the schema of a MonitoredRe source object using a\ntype name and a set of labels. For example, the monitore d resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\" gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zo ne\"` to identify particular VM instances.\n\nDifferent APIs can support differe nt monitored resource types. APIs generally\nprovide a `list` method that return s the monitored resource descriptors used\nby the API.",
1134 "id": "MonitoredResourceDescriptor",
1135 "properties": {
1136 "description": {
1137 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.",
1138 "type": "string"
1139 },
1140 "displayName": {
1141 "description": "Optional. A concise name for the monitored r esource type that might be\ndisplayed in user interfaces. It should be a Title C ased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Go ogle Cloud SQL Database\"`.",
1142 "type": "string"
1143 },
1144 "type": {
1145 "description": "Required. The monitored resource type. For e xample, the type\n`\"cloudsql_database\"` represents databases in Google Cloud S QL.\nThe maximum length of this value is 256 characters.",
1146 "type": "string"
1147 },
1148 "labels": {
1149 "description": "Required. A set of labels used to describe i nstances of this monitored\nresource type. For example, an individual Google Clo ud SQL database is\nidentified by values for the labels `\"database_id\"` and `\ "zone\"`.",
1150 "items": {
1151 "$ref": "LabelDescriptor"
1152 },
1153 "type": "array"
1154 },
1155 "name": {
1156 "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{ty pe}\"` where\n{type} is the value of the `type` field in this object and\n{proje ct_id} is a project ID that provides API-specific context for\naccessing the typ e. APIs that do not use project information can use the\nresource name format ` \"monitoredResourceDescriptors/{type}\"`.",
1157 "type": "string"
1158 }
1159 },
1160 "type": "object"
1161 },
1162 "CustomErrorRule": {
1163 "description": "A custom error rule.",
1164 "id": "CustomErrorRule",
1165 "properties": {
1166 "isErrorType": {
1167 "description": "Mark this message as possible payload in err or response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
1168 "type": "boolean"
1169 },
1170 "selector": {
1171 "description": "Selects messages to which this rule applies. \n\nRefer to selector for syntax details.",
1172 "type": "string"
1173 }
1174 },
1175 "type": "object"
1176 },
1177 "CustomAuthRequirements": {
1178 "description": "Configuration for a custom authentication provider." ,
1179 "id": "CustomAuthRequirements",
1180 "properties": {
1181 "provider": {
1182 "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartSer vice string\n(go/smartservice).",
1183 "type": "string"
1184 }
1185 },
1186 "type": "object"
1187 },
1188 "MediaDownload": {
1189 "description": "Defines the Media configuration for a service in cas e of a download.\nUse this only for Scotty Requests. Do not use this for media s upport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
1190 "id": "MediaDownload",
1191 "properties": {
1192 "useDirectDownload": {
1193 "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
1194 "type": "boolean"
1195 },
1196 "enabled": {
1197 "description": "Whether download is enabled.",
1198 "type": "boolean"
1199 },
1200 "downloadService": {
1201 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
1202 "type": "string"
1203 },
1204 "completeNotification": {
1205 "description": "A boolean that determines whether a notifica tion for the completion of a\ndownload should be sent to the backend.",
1206 "type": "boolean"
1207 },
1208 "dropzone": {
1209 "description": "Name of the Scotty dropzone to use for the c urrent API.",
1210 "type": "string"
1211 },
1212 "maxDirectDownloadSize": {
1213 "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
1214 "format": "int64",
1215 "type": "string"
1216 }
1217 },
1218 "type": "object"
1219 },
1220 "DisableServiceRequest": {
1221 "description": "Request message for DisableService method.",
1222 "id": "DisableServiceRequest",
1223 "properties": {},
1224 "type": "object"
1225 },
1226 "SearchServicesResponse": {
1227 "description": "Response message for SearchServices method.",
1228 "id": "SearchServicesResponse",
1229 "properties": {
1230 "nextPageToken": {
1231 "description": "Token that can be passed to `ListAvailableSe rvices` to resume a paginated\nquery.",
1232 "type": "string"
1233 },
1234 "services": {
1235 "description": "Services available publicly or available to the authenticated caller.",
1236 "items": {
1237 "$ref": "PublishedService"
1238 },
1239 "type": "array"
1240 }
1241 },
1242 "type": "object"
1243 },
1244 "MediaUpload": {
1245 "description": "Defines the Media configuration for a service in cas e of an upload.\nUse this only for Scotty Requests. Do not use this for media su pport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
1246 "id": "MediaUpload",
1247 "properties": {
1248 "enabled": {
1249 "description": "Whether upload is enabled.",
1250 "type": "boolean"
1251 },
1252 "progressNotification": {
1253 "description": "Whether to receive a notification for progre ss changes of media upload.",
1254 "type": "boolean"
1255 },
1256 "completeNotification": {
1257 "description": "A boolean that determines whether a notifica tion for the completion of an\nupload should be sent to the backend. These notif ications will not be seen\nby the client and will not consume quota.",
1258 "type": "boolean"
1259 },
1260 "dropzone": {
1261 "description": "Name of the Scotty dropzone to use for the c urrent API.",
1262 "type": "string"
1263 },
1264 "startNotification": {
1265 "description": "Whether to receive a notification on the sta rt of media upload.",
1266 "type": "boolean"
1267 },
1268 "uploadService": {
1269 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for up load.",
1270 "type": "string"
1271 },
1272 "mimeTypes": {
1273 "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
1274 "items": {
1275 "type": "string"
1276 },
1277 "type": "array"
1278 },
1279 "maxSize": {
1280 "description": "Optional maximum acceptable size for an uplo ad.\nThe size is specified in bytes.",
1281 "format": "int64",
1282 "type": "string"
1283 }
1284 },
1285 "type": "object"
1286 },
1287 "UsageRule": {
1288 "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the se rvice. Unregistered\ncalls are calls that do not contain consumer project identi ty.\n(Example: calls that do not contain an API key).\nBy default, API methods d o not allow unregistered calls, and each method call\nmust be identified by a co nsumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\ nExample of an API that wants to allow unregistered calls for entire service.\n\ n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_c alls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryServ ice.CreateBook\"\n allow_unregistered_calls: true",
1289 "id": "UsageRule",
1290 "properties": {
1291 "selector": {
1292 "description": "Selects the methods to which this rule appli es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta x details.",
1293 "type": "string"
1294 },
1295 "skipServiceControl": {
1296 "description": "True, if the method should skip service cont rol. If so, no control plane\nfeature (like quota and billing) will be enabled." ,
1297 "type": "boolean"
1298 },
1299 "allowUnregisteredCalls": {
1300 "description": "True, if the method allows unregistered call s; false otherwise.",
1301 "type": "boolean"
1302 }
1303 },
1304 "type": "object"
1305 },
1306 "AuthRequirement": {
1307 "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth -json-web-token-32).",
1308 "id": "AuthRequirement",
1309 "properties": {
1310 "audiences": {
1311 "description": "NOTE: This will be deprecated soon, once Aut hProvider.audiences is\nimplemented and accepted in all the runtime components.\ n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-jso n-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs wi th audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, i f no audiences are in the setting,\nLibraryService API will only accept JWTs wit h the following audience\n\"https://library-example.googleapis.com/google.exampl e.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.a pps.googleusercontent.com,\n bookstore_web.apps.googleusercontent. com",
1312 "type": "string"
1313 },
1314 "providerId": {
1315 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
1316 "type": "string"
1317 }
1318 },
1319 "type": "object"
1320 },
1321 "Documentation": {
1322 "description": "`Documentation` provides the information for describ ing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Goo gle Calendar API gives access\n to most calendar features.\n pages:\n - nam e: Overview\n content: &#40;== include google/foo/overview.md ==&#41;\n - na me: Tutorial\n content: &#40;== include google/foo/tutorial.md ==&#41;\n s ubpages;\n - name: Java\n content: &#40;== include google/foo/tutorial_j ava.md ==&#41;\n rules:\n - selector: google.calendar.Calendar.Get\n descri ption: >\n ...\n - selector: google.calendar.Calendar.Put\n description : >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\nco de blocks are supported. Section headers can be provided and are\ninterpreted re lative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvi a the config at normalization time, where documentation provided\nby config rule s overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>&#91;fully.qualified.proto.nam e]&#91;]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></ pre>\nText can be excluded from doc using the following notation:\n<pre><code>&# 40;-- internal comment --&#41;</code></pre>\nComments can be made conditional us ing a visibility label. The below\ntext will be only rendered if the `BETA` labe l is available:\n<pre><code>&#40;--BETA: comment for BETA users --&#41;</code></ pre>\nA few directives are available in documentation. Note that\ndirectives mus t appear on a single line to be properly\nidentified. The `include` directive in cludes a markdown file from\nan external source:\n<pre><code>&#40;== include pat h/to/file ==&#41;</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools att empt\nto infer the resource from the operations in a collection:\n<pre><code>&#4 0;== resource_for v1.shelves.books ==&#41;</code></pre>\nThe directive `suppress _warning` does not directly affect documentation\nand is documented together wit h service config validation.",
1323 "id": "Documentation",
1324 "properties": {
1325 "summary": {
1326 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
1327 "type": "string"
1328 },
1329 "documentationRootUrl": {
1330 "description": "The URL to the root of documentation.",
1331 "type": "string"
1332 },
1333 "overview": {
1334 "description": "Declares a single overview page. For example :\n<pre><code>documentation:\n summary: ...\n overview: &#40;== include overvi ew.md ==&#41;\n</code></pre>\nThis is a shortcut for the following declaration ( using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - na me: Overview\n content: &#40;== include overview.md ==&#41;\n</code></pre>\nN ote: you cannot specify both `overview` field and `pages` field.",
1335 "type": "string"
1336 },
1337 "rules": {
1338 "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"l ast one wins\" order.",
1339 "items": {
1340 "$ref": "DocumentationRule"
1341 },
1342 "type": "array"
1343 },
1344 "pages": {
1345 "description": "The top level pages for the documentation se t.",
1346 "items": {
1347 "$ref": "Page"
1348 },
1349 "type": "array"
1350 }
1351 },
1352 "type": "object"
1353 },
1354 "BackendRule": {
1355 "description": "A backend rule provides configuration for an individ ual API element.",
1356 "id": "BackendRule",
1357 "properties": {
1358 "address": {
1359 "description": "The address of the API backend.",
1360 "type": "string"
1361 },
1362 "selector": {
1363 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1364 "type": "string"
1365 },
1366 "deadline": {
1367 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
1368 "format": "double",
1369 "type": "number"
1370 },
1371 "minDeadline": {
1372 "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
1373 "format": "double",
1374 "type": "number"
1375 }
1376 },
1377 "type": "object"
1378 },
1379 "AuthenticationRule": {
1380 "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include mor e than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
1381 "id": "AuthenticationRule",
1382 "properties": {
1383 "customAuth": {
1384 "$ref": "CustomAuthRequirements",
1385 "description": "Configuration for custom authentication."
1386 },
1387 "oauth": {
1388 "$ref": "OAuthRequirements",
1389 "description": "The requirements for OAuth credentials."
1390 },
1391 "requirements": {
1392 "description": "Requirements for additional authentication p roviders.",
1393 "items": {
1394 "$ref": "AuthRequirement"
1395 },
1396 "type": "array"
1397 },
1398 "allowWithoutCredential": {
1399 "description": "Whether to allow requests without a credenti al. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control enviro nment is\nspecified, each incoming request **must** be associated with a service \nconsumer. This can be done by passing an API key that belongs to a consumer\np roject.",
1400 "type": "boolean"
1401 },
1402 "selector": {
1403 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1404 "type": "string"
1405 }
1406 },
1407 "type": "object"
1408 },
1409 "Api": {
1410 "description": "Api is a light-weight descriptor for a protocol buff er service.",
1411 "id": "Api",
1412 "properties": {
1413 "syntax": {
1414 "description": "The source syntax of the service.",
1415 "enum": [
1416 "SYNTAX_PROTO2",
1417 "SYNTAX_PROTO3"
1418 ],
1419 "enumDescriptions": [
1420 "Syntax `proto2`.",
1421 "Syntax `proto3`."
1422 ],
1423 "type": "string"
1424 },
1425 "sourceContext": {
1426 "$ref": "SourceContext",
1427 "description": "Source context for the protocol buffer servi ce represented by this\nmessage."
1428 },
1429 "version": {
1430 "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor v ersion\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the f ield is not empty, the version in the\npackage name will be verified to be consi stent with what is\nprovided here.\n\nThe versioning schema uses [semantic\nvers ioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version num bers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also refle cted in the package name of the\nAPI, which must end in `v<major-version>`, as i n\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, none-GA apis.\n",
1431 "type": "string"
1432 },
1433 "mixins": {
1434 "description": "Included APIs. See Mixin.",
1435 "items": {
1436 "$ref": "Mixin"
1437 },
1438 "type": "array"
1439 },
1440 "options": {
1441 "description": "Any metadata attached to the API.",
1442 "items": {
1443 "$ref": "Option"
1444 },
1445 "type": "array"
1446 },
1447 "methods": {
1448 "description": "The methods of this api, in unspecified orde r.",
1449 "items": {
1450 "$ref": "Method"
1451 },
1452 "type": "array"
1453 },
1454 "name": {
1455 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.",
1456 "type": "string"
1457 }
1458 },
1459 "type": "object"
1460 },
1461 "MetricRule": {
1462 "description": "Bind API methods to metrics. Binding a method to a m etric causes that\nmetric's configured quota behaviors to apply to the method ca ll.",
1463 "id": "MetricRule",
1464 "properties": {
1465 "metricCosts": {
1466 "additionalProperties": { 1428 "additionalProperties": {
1467 "format": "int64", 1429 "format": "int64",
1468 "type": "string" 1430 "type": "string"
1469 }, 1431 },
1470 "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the m ap is the metric name, and the values are the amount\nincreased for the metric a gainst which the quota limits are defined.\nThe value must not be negative.", 1432 "description": "Tiered limit values, currently only STANDARD is supported.",
1471 "type": "object" 1433 "type": "object"
1472 }, 1434 },
1473 "selector": { 1435 "unit": {
1474 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 1436 "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com /service-control)\nsupports the following unit components:\n* One of the time in tevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 h ours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{proj ect}\" for quota per minute per project.\n\nNote: the order of unit components i s insignificant.\nThe \"1\" at the beginning is required to follow the metric un it syntax.\n\nUsed by metric-based quotas only.",
1475 "type": "string" 1437 "type": "string"
1476 } 1438 },
1477 }, 1439 "maxLimit": {
1478 "type": "object" 1440 "description": "Maximum number of tokens that can be consume d during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default l imit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1 ,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
1479 }, 1441 "format": "int64",
1480 "Authentication": { 1442 "type": "string"
1481 "description": "`Authentication` defines the authentication configur ation for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: goog le_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", 1443 },
1482 "id": "Authentication", 1444 "name": {
1445 "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\ nFor metric-based quota limits, the name must be provided, and it must be\nuniqu e within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name o f a limit is used as a unique identifier for this limit.\nTherefore, once a limi t has been put into use, its name should be\nimmutable. You can use the display_ name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
1446 "type": "string"
1447 }
1448 },
1449 "type": "object"
1450 },
1451 "Mixin": {
1452 "description": "Declares an API to be included in this API. The incl uding API must\nredeclare all the methods from the included API, but documentati on\nand options are inherited as follows:\n\n- If after comment and whitespace s tripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n ve rsion of the including API plus the root path if specified.\n\nExample of a simp le mixin:\n\n package google.acl.v1;\n service AccessControl {\n // G et the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rp c GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\ n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in ` AccessControl` are\nalso declared with same name and request/response types in\n `Storage`. A documentation generator or annotation processor will\nsee the effec tive `Storage.GetAcl` method after inherting\ndocumentation and annotations as f ollows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the vers ion in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP pa ths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nTh is implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns ( Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\" ;\n }\n ...\n }",
1453 "id": "Mixin",
1454 "properties": {
1455 "name": {
1456 "description": "The fully qualified name of the API which is included.",
1457 "type": "string"
1458 },
1459 "root": {
1460 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
1461 "type": "string"
1462 }
1463 },
1464 "type": "object"
1465 },
1466 "CustomError": {
1467 "description": "Customize service error responses. For example, lis t any service\nspecific protobuf types that can appear in error detail lists of\ nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google .foo.v1.CustomError\n - google.foo.v1.AnotherError",
1468 "id": "CustomError",
1483 "properties": { 1469 "properties": {
1484 "rules": { 1470 "rules": {
1485 "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"l ast one wins\" order.", 1471 "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \" last one wins\" order.",
1486 "items": { 1472 "items": {
1487 "$ref": "AuthenticationRule" 1473 "$ref": "CustomErrorRule"
1488 }, 1474 },
1489 "type": "array" 1475 "type": "array"
1490 }, 1476 },
1491 "providers": { 1477 "types": {
1492 "description": "Defines a set of authentication providers th at a service supports.", 1478 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
1493 "items": { 1479 "items": {
1494 "$ref": "AuthProvider" 1480 "type": "string"
1495 }, 1481 },
1496 "type": "array" 1482 "type": "array"
1497 } 1483 }
1498 }, 1484 },
1499 "type": "object" 1485 "type": "object"
1500 }, 1486 },
1501 "Operation": { 1487 "Http": {
1502 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 1488 "description": "Defines the HTTP configuration for an API service. I t contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
1503 "id": "Operation", 1489 "id": "Http",
1504 "properties": { 1490 "properties": {
1505 "metadata": { 1491 "rules": {
1506 "additionalProperties": { 1492 "description": "A list of HTTP configuration rules that appl y to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
1507 "description": "Properties of the object. Contains field @type with type URL.", 1493 "items": {
1508 "type": "any" 1494 "$ref": "HttpRule"
1509 }, 1495 },
1510 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ", 1496 "type": "array"
1511 "type": "object" 1497 },
1512 }, 1498 "fullyDecodeReservedExpansion": {
1513 "done": { 1499 "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expans ion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not deco de RFC 6570 reserved characters in multi\nsegment matches.",
1514 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
1515 "type": "boolean" 1500 "type": "boolean"
1516 }, 1501 }
1517 "response": { 1502 },
1518 "additionalProperties": { 1503 "type": "object"
1519 "description": "Properties of the object. Contains field @type with type URL.", 1504 },
1520 "type": "any" 1505 "SourceInfo": {
1521 }, 1506 "description": "Source information used to create a Service Config",
1522 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", 1507 "id": "SourceInfo",
1523 "type": "object" 1508 "properties": {
1524 }, 1509 "sourceFiles": {
1525 "name": { 1510 "description": "All files used during config generation.",
1526 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
1527 "type": "string"
1528 },
1529 "error": {
1530 "$ref": "Status",
1531 "description": "The error result of the operation in case of failure or cancellation."
1532 }
1533 },
1534 "type": "object"
1535 },
1536 "Page": {
1537 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
1538 "id": "Page",
1539 "properties": {
1540 "name": {
1541 "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocum entation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== i nclude tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page us ing Markdown reference link syntax:\n`Java`.",
1542 "type": "string"
1543 },
1544 "content": {
1545 "description": "The Markdown content of the page. You can us e <code>&#40;== include {path} ==&#41;</code>\nto include content from a Markdow n file.",
1546 "type": "string"
1547 },
1548 "subpages": {
1549 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
1550 "items": {
1551 "$ref": "Page"
1552 },
1553 "type": "array"
1554 }
1555 },
1556 "type": "object"
1557 },
1558 "Status": {
1559 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
1560 "id": "Status",
1561 "properties": {
1562 "message": {
1563 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
1564 "type": "string"
1565 },
1566 "details": {
1567 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1568 "items": { 1511 "items": {
1569 "additionalProperties": { 1512 "additionalProperties": {
1570 "description": "Properties of the object. Contains f ield @type with type URL.", 1513 "description": "Properties of the object. Contains f ield @type with type URL.",
1571 "type": "any" 1514 "type": "any"
1572 }, 1515 },
1573 "type": "object" 1516 "type": "object"
1574 }, 1517 },
1575 "type": "array" 1518 "type": "array"
1576 }, 1519 }
1577 "code": { 1520 },
1578 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 1521 "type": "object"
1522 },
1523 "Control": {
1524 "description": "Selects and configures the service controller used b y the service. The\nservice controller handles features like abuse, quota, bill ing, logging,\nmonitoring, etc.",
1525 "id": "Control",
1526 "properties": {
1527 "environment": {
1528 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.",
1529 "type": "string"
1530 }
1531 },
1532 "type": "object"
1533 },
1534 "SystemParameter": {
1535 "description": "Define a parameter's name and location. The paramete r may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
1536 "id": "SystemParameter",
1537 "properties": {
1538 "name": {
1539 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.",
1540 "type": "string"
1541 },
1542 "urlQueryParameter": {
1543 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.",
1544 "type": "string"
1545 },
1546 "httpHeader": {
1547 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.",
1548 "type": "string"
1549 }
1550 },
1551 "type": "object"
1552 },
1553 "Field": {
1554 "description": "A single field of a message type.",
1555 "id": "Field",
1556 "properties": {
1557 "name": {
1558 "description": "The field name.",
1559 "type": "string"
1560 },
1561 "typeUrl": {
1562 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
1563 "type": "string"
1564 },
1565 "number": {
1566 "description": "The field number.",
1579 "format": "int32", 1567 "format": "int32",
1580 "type": "integer" 1568 "type": "integer"
1581 } 1569 },
1582 }, 1570 "jsonName": {
1583 "type": "object" 1571 "description": "The field JSON name.",
1584 }, 1572 "type": "string"
1585 "AuthProvider": { 1573 },
1586 "description": "Configuration for an anthentication provider, includ ing support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-o auth-json-web-token-32).", 1574 "kind": {
1587 "id": "AuthProvider", 1575 "description": "The field type.",
1588 "properties": { 1576 "enum": [
1589 "audiences": { 1577 "TYPE_UNKNOWN",
1590 "description": "The list of JWT\n[audiences](https://tools.i etf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowe d to access. A JWT containing any of these audiences will\nbe accepted. When thi s setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\ nwill be accepted. For example, if no audiences are in the setting,\nLibraryServ ice API will only accept JWTs with the following audience\n\"https://library-exa mple.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n book store_web.apps.googleusercontent.com", 1578 "TYPE_DOUBLE",
1591 "type": "string" 1579 "TYPE_FLOAT",
1592 }, 1580 "TYPE_INT64",
1593 "issuer": { 1581 "TYPE_UINT64",
1594 "description": "Identifies the principal that issued the JWT . See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4. 1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.c om\nExample: 1234567-compute@developer.gserviceaccount.com", 1582 "TYPE_INT32",
1595 "type": "string" 1583 "TYPE_FIXED64",
1596 }, 1584 "TYPE_FIXED32",
1597 "id": { 1585 "TYPE_BOOL",
1598 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".", 1586 "TYPE_STRING",
1599 "type": "string" 1587 "TYPE_GROUP",
1600 }, 1588 "TYPE_MESSAGE",
1601 "jwksUri": { 1589 "TYPE_BYTES",
1602 "description": "URL of the provider's public key set to vali date signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/open id-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set docume nt:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/op enid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https:// www.googleapis.com/oauth2/v1/certs", 1590 "TYPE_UINT32",
1603 "type": "string" 1591 "TYPE_ENUM",
1604 } 1592 "TYPE_SFIXED32",
1605 }, 1593 "TYPE_SFIXED64",
1606 "type": "object" 1594 "TYPE_SINT32",
1607 }, 1595 "TYPE_SINT64"
1608 "EnumValue": { 1596 ],
1609 "description": "Enum value definition.", 1597 "enumDescriptions": [
1610 "id": "EnumValue", 1598 "Field type unknown.",
1611 "properties": { 1599 "Field type double.",
1600 "Field type float.",
1601 "Field type int64.",
1602 "Field type uint64.",
1603 "Field type int32.",
1604 "Field type fixed64.",
1605 "Field type fixed32.",
1606 "Field type bool.",
1607 "Field type string.",
1608 "Field type group. Proto2 syntax only, and deprecated.",
1609 "Field type message.",
1610 "Field type bytes.",
1611 "Field type uint32.",
1612 "Field type enum.",
1613 "Field type sfixed32.",
1614 "Field type sfixed64.",
1615 "Field type sint32.",
1616 "Field type sint64."
1617 ],
1618 "type": "string"
1619 },
1620 "options": {
1621 "description": "The protocol buffer options.",
1622 "items": {
1623 "$ref": "Option"
1624 },
1625 "type": "array"
1626 },
1627 "oneofIndex": {
1628 "description": "The index of the field type in `Type.oneofs` , for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
1629 "format": "int32",
1630 "type": "integer"
1631 },
1632 "packed": {
1633 "description": "Whether to use alternative packed wire repre sentation.",
1634 "type": "boolean"
1635 },
1636 "cardinality": {
1637 "description": "The field cardinality.",
1638 "enum": [
1639 "CARDINALITY_UNKNOWN",
1640 "CARDINALITY_OPTIONAL",
1641 "CARDINALITY_REQUIRED",
1642 "CARDINALITY_REPEATED"
1643 ],
1644 "enumDescriptions": [
1645 "For fields with unknown cardinality.",
1646 "For optional fields.",
1647 "For required fields. Proto2 syntax only.",
1648 "For repeated fields."
1649 ],
1650 "type": "string"
1651 },
1652 "defaultValue": {
1653 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
1654 "type": "string"
1655 }
1656 },
1657 "type": "object"
1658 },
1659 "Monitoring": {
1660 "description": "Monitoring configuration of the service.\n\nThe exam ple below shows how to configure monitored resources and metrics\nfor monitoring . In the example, a monitored resource and two metrics are\ndefined. The `librar y.googleapis.com/book/returned_count` metric is sent\nto both producer and consu mer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: li brary.googleapis.com/branch\n labels:\n - key: /city\n descript ion: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googl eapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64 \n labels:\n - key: /customer_id\n - name: library.googleapis.com/b ook/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labe ls:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis. com/book/overdue_count",
1661 "id": "Monitoring",
1662 "properties": {
1663 "consumerDestinations": {
1664 "description": "Monitoring configurations for sending metric s to the consumer project.\nThere can be multiple consumer destinations, each on e must have a\ndifferent monitored resource type. A metric can be used in at mos t\none consumer destination.",
1665 "items": {
1666 "$ref": "MonitoringDestination"
1667 },
1668 "type": "array"
1669 },
1670 "producerDestinations": {
1671 "description": "Monitoring configurations for sending metric s to the producer project.\nThere can be multiple producer destinations, each on e must have a\ndifferent monitored resource type. A metric can be used in at mos t\none producer destination.",
1672 "items": {
1673 "$ref": "MonitoringDestination"
1674 },
1675 "type": "array"
1676 }
1677 },
1678 "type": "object"
1679 },
1680 "Enum": {
1681 "description": "Enum type definition.",
1682 "id": "Enum",
1683 "properties": {
1684 "enumvalue": {
1685 "description": "Enum value definitions.",
1686 "items": {
1687 "$ref": "EnumValue"
1688 },
1689 "type": "array"
1690 },
1691 "name": {
1692 "description": "Enum type name.",
1693 "type": "string"
1694 },
1612 "options": { 1695 "options": {
1613 "description": "Protocol buffer options.", 1696 "description": "Protocol buffer options.",
1614 "items": { 1697 "items": {
1615 "$ref": "Option" 1698 "$ref": "Option"
1616 }, 1699 },
1617 "type": "array" 1700 "type": "array"
1618 }, 1701 },
1619 "number": { 1702 "syntax": {
1620 "description": "Enum value number.", 1703 "description": "The source syntax.",
1621 "format": "int32", 1704 "enum": [
1622 "type": "integer" 1705 "SYNTAX_PROTO2",
1706 "SYNTAX_PROTO3"
1707 ],
1708 "enumDescriptions": [
1709 "Syntax `proto2`.",
1710 "Syntax `proto3`."
1711 ],
1712 "type": "string"
1713 },
1714 "sourceContext": {
1715 "$ref": "SourceContext",
1716 "description": "The source context."
1717 }
1718 },
1719 "type": "object"
1720 },
1721 "EnableServiceRequest": {
1722 "description": "Request message for EnableService method.",
1723 "id": "EnableServiceRequest",
1724 "properties": {},
1725 "type": "object"
1726 },
1727 "LabelDescriptor": {
1728 "description": "A description of a label.",
1729 "id": "LabelDescriptor",
1730 "properties": {
1731 "key": {
1732 "description": "The label key.",
1733 "type": "string"
1734 },
1735 "description": {
1736 "description": "A human-readable description for the label." ,
1737 "type": "string"
1738 },
1739 "valueType": {
1740 "description": "The type of data that can be assigned to the label.",
1741 "enum": [
1742 "STRING",
1743 "BOOL",
1744 "INT64"
1745 ],
1746 "enumDescriptions": [
1747 "A variable-length string. This is the default.",
1748 "Boolean; true or false.",
1749 "A 64-bit signed integer."
1750 ],
1751 "type": "string"
1752 }
1753 },
1754 "type": "object"
1755 },
1756 "Type": {
1757 "description": "A protocol buffer message type.",
1758 "id": "Type",
1759 "properties": {
1760 "fields": {
1761 "description": "The list of fields.",
1762 "items": {
1763 "$ref": "Field"
1764 },
1765 "type": "array"
1623 }, 1766 },
1624 "name": { 1767 "name": {
1625 "description": "Enum value name.", 1768 "description": "The fully qualified message name.",
1626 "type": "string" 1769 "type": "string"
1627 } 1770 },
1628 }, 1771 "oneofs": {
1629 "type": "object" 1772 "description": "The list of types appearing in `oneof` defin itions in this type.",
1630 }, 1773 "items": {
1631 "Service": { 1774 "type": "string"
1632 "description": "`Service` is the root object of Google service confi guration schema. It\ndescribes basic information about a service, such as the na me and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspeci fic aspect, such as auth. See each proto message definition for details.\n\nExam ple:\n\n type: google.api.Service\n config_version: 3\n name: calendar. googleapis.com\n title: Google Calendar API\n apis:\n - name: google.ca lendar.v3.Calendar\n authentication:\n providers:\n - id: google_ca lendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\" \n requirements:\n provider_id: google_calendar_auth", 1775 },
1633 "id": "Service", 1776 "type": "array"
1634 "properties": { 1777 },
1635 "logs": { 1778 "sourceContext": {
1636 "description": "Defines the logs used by this service.", 1779 "$ref": "SourceContext",
1637 "items": { 1780 "description": "The source context."
1638 "$ref": "LogDescriptor" 1781 },
1639 }, 1782 "syntax": {
1640 "type": "array" 1783 "description": "The source syntax.",
1641 }, 1784 "enum": [
1642 "apis": { 1785 "SYNTAX_PROTO2",
1643 "description": "A list of API interfaces exported by this se rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface h ere\nwhich cannot be resolved against the associated IDL files.", 1786 "SYNTAX_PROTO3"
1644 "items": { 1787 ],
1645 "$ref": "Api" 1788 "enumDescriptions": [
1646 }, 1789 "Syntax `proto2`.",
1647 "type": "array" 1790 "Syntax `proto3`."
1648 }, 1791 ],
1649 "types": { 1792 "type": "string"
1650 "description": "A list of all proto message types included i n this API service.\nTypes referenced directly or indirectly by the `apis` are\n automatically included. Messages which are not referenced but\nshall be include d, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32", 1793 },
1651 "items": { 1794 "options": {
1652 "$ref": "Type" 1795 "description": "The protocol buffer options.",
1653 }, 1796 "items": {
1654 "type": "array" 1797 "$ref": "Option"
1655 }, 1798 },
1656 "sourceInfo": { 1799 "type": "array"
1657 "$ref": "SourceInfo", 1800 }
1658 "description": "Output only. The source information for this configuration if available." 1801 },
1659 }, 1802 "type": "object"
1660 "http": { 1803 },
1661 "$ref": "Http", 1804 "Experimental": {
1662 "description": "HTTP configuration." 1805 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.",
1663 }, 1806 "id": "Experimental",
1664 "backend": { 1807 "properties": {
1665 "$ref": "Backend", 1808 "authorization": {
1666 "description": "API backend configuration." 1809 "$ref": "AuthorizationConfig",
1667 }, 1810 "description": "Authorization configuration."
1668 "systemParameters": { 1811 }
1669 "$ref": "SystemParameters", 1812 },
1670 "description": "System parameter configuration." 1813 "type": "object"
1671 }, 1814 },
1672 "documentation": { 1815 "Backend": {
1673 "$ref": "Documentation", 1816 "description": "`Backend` defines the backend configuration for a se rvice.",
1674 "description": "Additional API documentation." 1817 "id": "Backend",
1675 }, 1818 "properties": {
1676 "logging": { 1819 "rules": {
1677 "$ref": "Logging", 1820 "description": "A list of API backend rules that apply to in dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
1678 "description": "Logging configuration." 1821 "items": {
1679 }, 1822 "$ref": "BackendRule"
1680 "monitoredResources": { 1823 },
1681 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.", 1824 "type": "array"
1682 "items": { 1825 }
1683 "$ref": "MonitoredResourceDescriptor" 1826 },
1684 }, 1827 "type": "object"
1685 "type": "array" 1828 },
1686 }, 1829 "AuthorizationConfig": {
1687 "context": { 1830 "description": "Configuration of authorization.\n\nThis section dete rmines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n pr ovider: firebaserules.googleapis.com",
1688 "$ref": "Context", 1831 "id": "AuthorizationConfig",
1689 "description": "Context configuration." 1832 "properties": {
1690 }, 1833 "provider": {
1691 "enums": { 1834 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
1692 "description": "A list of all enum types included in this AP I service. Enums\nreferenced directly or indirectly by the `apis` are automatic ally\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.Some Enum", 1835 "type": "string"
1693 "items": { 1836 }
1694 "$ref": "Enum" 1837 },
1695 }, 1838 "type": "object"
1696 "type": "array" 1839 },
1697 }, 1840 "DocumentationRule": {
1698 "id": { 1841 "description": "A documentation rule provides information about indi vidual API elements.",
1699 "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the s erver may choose to\ngenerate one instead.", 1842 "id": "DocumentationRule",
1700 "type": "string" 1843 "properties": {
1701 }, 1844 "description": {
1702 "usage": { 1845 "description": "Description of the selected API(s).",
1703 "$ref": "Usage", 1846 "type": "string"
1704 "description": "Configuration controlling usage of this serv ice." 1847 },
1705 }, 1848 "deprecationDescription": {
1706 "metrics": { 1849 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.",
1707 "description": "Defines the metrics used by this service.", 1850 "type": "string"
1708 "items": { 1851 },
1709 "$ref": "MetricDescriptor" 1852 "selector": {
1710 }, 1853 "description": "The selector is a comma-separated list of pa tterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole c omponent of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"f oo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
1711 "type": "array" 1854 "type": "string"
1712 }, 1855 }
1713 "authentication": { 1856 },
1714 "$ref": "Authentication", 1857 "type": "object"
1715 "description": "Auth configuration." 1858 },
1716 }, 1859 "ContextRule": {
1717 "experimental": { 1860 "description": "A context rule provides information about the contex t for an individual API\nelement.",
1718 "$ref": "Experimental", 1861 "id": "ContextRule",
1719 "description": "Experimental configuration." 1862 "properties": {
1720 }, 1863 "selector": {
1721 "control": { 1864 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1722 "$ref": "Control", 1865 "type": "string"
1723 "description": "Configuration for the service control plane. " 1866 },
1724 }, 1867 "provided": {
1725 "configVersion": { 1868 "description": "A list of full type names of provided contex ts.",
1726 "description": "The version of the service configuration. Th e config version may\ninfluence interpretation of the configuration, for example , to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.", 1869 "items": {
1727 "format": "uint32", 1870 "type": "string"
1728 "type": "integer" 1871 },
1729 }, 1872 "type": "array"
1730 "monitoring": { 1873 },
1731 "$ref": "Monitoring", 1874 "requested": {
1732 "description": "Monitoring configuration." 1875 "description": "A list of full type names of requested conte xts.",
1733 }, 1876 "items": {
1734 "producerProjectId": { 1877 "type": "string"
1735 "description": "The Google project that owns this service.", 1878 },
1736 "type": "string" 1879 "type": "array"
1737 }, 1880 }
1738 "systemTypes": { 1881 },
1739 "description": "A list of all proto message types included i n this API service.\nIt serves similar purpose as [google.api.Service.types], ex cept that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", 1882 "type": "object"
1740 "items": { 1883 },
1741 "$ref": "Type" 1884 "SourceContext": {
1742 }, 1885 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
1743 "type": "array" 1886 "id": "SourceContext",
1744 }, 1887 "properties": {
1745 "visibility": { 1888 "fileName": {
1746 "$ref": "Visibility", 1889 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.",
1747 "description": "API visibility configuration." 1890 "type": "string"
1748 }, 1891 }
1749 "quota": { 1892 },
1750 "$ref": "Quota", 1893 "type": "object"
1751 "description": "Quota configuration." 1894 },
1895 "MetricDescriptor": {
1896 "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
1897 "id": "MetricDescriptor",
1898 "properties": {
1899 "metricKind": {
1900 "description": "Whether the metric records instantaneous val ues, changes to a value, etc.\nSome combinations of `metric_kind` and `value_typ e` might not be supported.",
1901 "enum": [
1902 "METRIC_KIND_UNSPECIFIED",
1903 "GAUGE",
1904 "DELTA",
1905 "CUMULATIVE"
1906 ],
1907 "enumDescriptions": [
1908 "Do not use this default value.",
1909 "An instantaneous measurement of a value.",
1910 "The change in a value during a time interval.",
1911 "A value accumulated over a time interval. Cumulative\n measurements in a time series should have the same start time\nand increasing en d times, until an event resets the cumulative\nvalue to zero and sets a new star t time for the following\npoints."
1912 ],
1913 "type": "string"
1914 },
1915 "description": {
1916 "description": "A detailed description of the metric, which can be used in documentation.",
1917 "type": "string"
1918 },
1919 "displayName": {
1920 "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for e xample \"Request count\".",
1921 "type": "string"
1922 },
1923 "unit": {
1924 "description": "The unit in which the metric value is report ed. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIB UTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMea sure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n \n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` h our\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P ` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n * `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**- 6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto ( 10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yo cto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includ es the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotati on\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s` , `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable AS CII characters not\n containing '{' or '}'.",
1925 "type": "string"
1926 },
1927 "labels": {
1928 "description": "The set of labels that can be used to descri be a specific\ninstance of this metric type. For example, the\n`appengine.google apis.com/http/server/response_latencies` metric\ntype has a label for the HTTP r esponse code, `response_code`, so\nyou can look at latencies for successful resp onses or just\nfor responses that failed.",
1929 "items": {
1930 "$ref": "LabelDescriptor"
1931 },
1932 "type": "array"
1752 }, 1933 },
1753 "name": { 1934 "name": {
1754 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.", 1935 "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent re source name\nthat defines the scope of the metric type or of its data; and (2) t he\nmetric's URL-encoded type, which also appears in the `type` field of this\nd escriptor. For example, following is the resource name of a custom\nmetric withi n the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescrip tors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
1755 "type": "string" 1936 "type": "string"
1756 }, 1937 },
1757 "customError": { 1938 "type": {
1758 "$ref": "CustomError", 1939 "description": "The metric type, including its DNS name pref ix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchi cal\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\" \n \"appengine.googleapis.com/http/server/response_latencies\"",
1759 "description": "Custom error configuration." 1940 "type": "string"
1760 }, 1941 },
1761 "title": { 1942 "valueType": {
1762 "description": "The product title for this service.", 1943 "description": "Whether the measurement is an integer, a flo ating-point number, etc.\nSome combinations of `metric_kind` and `value_type` mi ght not be supported.",
1763 "type": "string" 1944 "enum": [
1764 }, 1945 "VALUE_TYPE_UNSPECIFIED",
1765 "endpoints": { 1946 "BOOL",
1766 "description": "Configuration for network endpoints. If thi s is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", 1947 "INT64",
1767 "items": { 1948 "DOUBLE",
1768 "$ref": "Endpoint" 1949 "STRING",
1769 }, 1950 "DISTRIBUTION",
1770 "type": "array" 1951 "MONEY"
1771 } 1952 ],
1772 }, 1953 "enumDescriptions": [
1773 "type": "object" 1954 "Do not use this default value.",
1774 }, 1955 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.",
1775 "OperationMetadata": { 1956 "The value is a signed 64-bit integer.",
1776 "description": "The metadata associated with a long running operatio n resource.", 1957 "The value is a double precision floating point number." ,
1777 "id": "OperationMetadata", 1958 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.",
1778 "properties": { 1959 "The value is a `Distribution`.",
1779 "startTime": { 1960 "The value is money."
1780 "description": "The start time of the operation.", 1961 ],
1781 "format": "google-datetime", 1962 "type": "string"
1782 "type": "string" 1963 }
1783 }, 1964 },
1784 "steps": { 1965 "type": "object"
1785 "description": "Detailed status information for each step. T he order is undetermined.",
1786 "items": {
1787 "$ref": "Step"
1788 },
1789 "type": "array"
1790 },
1791 "resourceNames": {
1792 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
1793 "items": {
1794 "type": "string"
1795 },
1796 "type": "array"
1797 },
1798 "progressPercentage": {
1799 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
1800 "format": "int32",
1801 "type": "integer"
1802 }
1803 },
1804 "type": "object"
1805 },
1806 "CustomHttpPattern": {
1807 "description": "A custom pattern is used for defining custom HTTP ve rb.",
1808 "id": "CustomHttpPattern",
1809 "properties": {
1810 "path": {
1811 "description": "The path matched by this custom verb.",
1812 "type": "string"
1813 },
1814 "kind": {
1815 "description": "The name of this custom HTTP verb.",
1816 "type": "string"
1817 }
1818 },
1819 "type": "object"
1820 },
1821 "SystemParameterRule": {
1822 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
1823 "id": "SystemParameterRule",
1824 "properties": {
1825 "selector": {
1826 "description": "Selects the methods to which this rule appli es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta x details.",
1827 "type": "string"
1828 },
1829 "parameters": {
1830 "description": "Define parameters. Multiple names may be def ined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
1831 "items": {
1832 "$ref": "SystemParameter"
1833 },
1834 "type": "array"
1835 }
1836 },
1837 "type": "object"
1838 },
1839 "PublishedService": {
1840 "description": "The published version of a Service that is managed b y\nGoogle Service Management.",
1841 "id": "PublishedService",
1842 "properties": {
1843 "service": {
1844 "$ref": "Service",
1845 "description": "The service's published configuration."
1846 },
1847 "name": {
1848 "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
1849 "type": "string"
1850 }
1851 },
1852 "type": "object"
1853 },
1854 "HttpRule": {
1855 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nH TTP request body. The mapping is typically specified as an\n`google.api.http` an notation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n \nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the examp le below which describes a REST GET\noperation on a resource collection of messa ges:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) retur ns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_i d}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n mes sage SubMessage {\n string subfield = 1;\n }\n string message_i d = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is u rl-mapped\n }\n message Message {\n string text = 1; // content of th e resource\n }\n\nThe same http annotation can alternatively be expressed ins ide the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messa ges/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrect ional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v 1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(sub field: \"foo\"))`\n\nIn general, not only fields but also field paths can be ref erenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepea ted and must have a primitive (non-message) type.\n\nAny fields in the request m essage which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\ n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (M essage) {\n option (google.api.http).get = \"/v1/messages/{message_id}\"; \n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage s ub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123 456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to H TTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nr epeated in the URL, as in `...?param=A&param=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST u pdate method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n optio n (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2 ; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \ "Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define tha t\nevery field not bound by the path template should be mapped to the\nrequest b ody. This enables the following alternative definition of\nthe update method:\n \n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\ n option (google.api.http) = {\n put: \"/v1/messages/{message_id }\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HT TP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages /123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"H i!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nh ave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The commo n usage of `*` is in custom methods\nwhich don't use the URL at all for transfer ring data.\n\nIt is possible to define multiple HTTP methods for one RPC by usin g\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.ap i.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_ bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n stri ng message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the follo wing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GE T /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me /messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Ru les for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and b ody fields\nto the request message are as follows:\n\n1. The `body` field specif ies either `*` or a field path, or is\n omitted. If omitted, it indicates ther e is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messag es in the\n request) can be classified into three types:\n (a) Matched in t he URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other field s.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\ n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe synta x of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | L ITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe s yntax `*` matches a single path segment. The syntax `**` matches zero\nor more p ath segments, which must be the last part of the path except the\n`Verb`. The sy ntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matche s part of the URL path as specified by its\ntemplate. A variable template must n ot contain other variables. If a variable\nmatches a single path segment, its te mplate may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variabl e contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a- zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=f oo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, a ll\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nsh ow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment v ariable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570 ) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not* * match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ ndoes not expand special characters like `?` and `#`, which would lead\nto inval id URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
1856 "id": "HttpRule",
1857 "properties": {
1858 "selector": {
1859 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.",
1860 "type": "string"
1861 },
1862 "custom": {
1863 "$ref": "CustomHttpPattern",
1864 "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\ " to leave the\nHTTP method unspecified for this rule. The wild-card rule is use ful\nfor services that provide content to Web (HTML) clients."
1865 },
1866 "get": {
1867 "description": "Used for listing and getting information abo ut resources.",
1868 "type": "string"
1869 },
1870 "patch": {
1871 "description": "Used for updating a resource.",
1872 "type": "string"
1873 },
1874 "put": {
1875 "description": "Used for updating a resource.",
1876 "type": "string"
1877 },
1878 "delete": {
1879 "description": "Used for deleting a resource.",
1880 "type": "string"
1881 },
1882 "body": {
1883 "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the pat h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie ld and must be\npresent at the top-level of request message type.",
1884 "type": "string"
1885 },
1886 "post": {
1887 "description": "Used for creating a resource.",
1888 "type": "string"
1889 },
1890 "mediaDownload": {
1891 "$ref": "MediaDownload",
1892 "description": "Use this only for Scotty Requests. Do not us e this for bytestream methods.\nFor media support, add instead [][google.bytestr eam.RestByteStream] as an\nAPI to your configuration."
1893 },
1894 "restMethodName": {
1895 "description": "Optional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default m ethod name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest m ethod name \"create\", but\n for backwards compatability with apiary, it is spec ified as insert.",
1896 "type": "string"
1897 },
1898 "additionalBindings": {
1899 "description": "Additional HTTP bindings for the selector. N ested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
1900 "items": {
1901 "$ref": "HttpRule"
1902 },
1903 "type": "array"
1904 },
1905 "restCollection": {
1906 "description": "Optional. The REST collection name is by def ault derived from the URL\npattern. If specified, this field overrides the defau lt collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggreg atedListRequest)\n returns (AddressesAggregatedListResponse) {\n opt ion (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/a ddresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\n This method has the automatically derived collection name\n\"projects.aggregated \". Because, semantically, this rpc is actually an\noperation on the \"projects. addresses\" collection, the `rest_collection`\nfield is configured to override t he derived collection name.",
1907 "type": "string"
1908 },
1909 "responseBody": {
1910 "description": "The name of the response field whose value i s mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
1911 "type": "string"
1912 },
1913 "mediaUpload": {
1914 "$ref": "MediaUpload",
1915 "description": "Use this only for Scotty Requests. Do not us e this for media support using\nBytestream, add instead\n[][google.bytestream.Re stByteStream] as an API to your\nconfiguration for Bytestream methods."
1916 }
1917 },
1918 "type": "object"
1919 },
1920 "VisibilityRule": {
1921 "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
1922 "id": "VisibilityRule",
1923 "properties": {
1924 "restriction": {
1925 "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but no t all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restrictio n will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
1926 "type": "string"
1927 },
1928 "selector": {
1929 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
1930 "type": "string"
1931 }
1932 },
1933 "type": "object"
1934 },
1935 "MonitoringDestination": {
1936 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
1937 "id": "MonitoringDestination",
1938 "properties": {
1939 "monitoredResource": {
1940 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
1941 "type": "string"
1942 },
1943 "metrics": {
1944 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.",
1945 "items": {
1946 "type": "string"
1947 },
1948 "type": "array"
1949 }
1950 },
1951 "type": "object"
1952 },
1953 "Visibility": {
1954 "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g ., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visi bility for multiple labels is the union of each label's\nelements, plus any unre stricted elements.\n\nIf an element and its parents have no restrictions, visibi lity is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n res triction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for t he restricted methods\nEnhancedSearch and Delegate.",
1955 "id": "Visibility",
1956 "properties": {
1957 "rules": {
1958 "description": "A list of visibility rules that apply to ind ividual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
1959 "items": {
1960 "$ref": "VisibilityRule"
1961 },
1962 "type": "array"
1963 }
1964 },
1965 "type": "object"
1966 } 1966 }
1967 }, 1967 },
1968 "servicePath": "", 1968 "servicePath": "",
1969 "title": "Google Service User API", 1969 "title": "Google Service User API",
1970 "version": "v1" 1970 "version": "v1"
1971 } 1971 }
OLDNEW
« no previous file with comments | « discovery/googleapis/servicemanagement__v1.json ('k') | discovery/googleapis/sheets__v4.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698