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

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

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 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/service.management": { 5 "https://www.googleapis.com/auth/service.management": {
6 "description": "Manage your Google API service configuration " 6 "description": "Manage your Google API service configuration "
7 }, 7 },
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { 8 "https://www.googleapis.com/auth/cloud-platform.read-only": {
9 "description": "View your data across Google Cloud Platform services" 9 "description": "View your data across Google Cloud Platform services"
10 }, 10 },
(...skipping 13 matching lines...) Expand all
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 "upload_protocol": {
35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
36 "location": "query",
37 "type": "string"
38 },
39 "prettyPrint": {
40 "default": "true",
41 "description": "Returns response with indentations and line breaks." ,
42 "location": "query",
43 "type": "boolean"
44 },
45 "uploadType": {
46 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
47 "location": "query",
48 "type": "string"
49 },
50 "fields": {
51 "description": "Selector specifying which fields to include in a par tial response.",
52 "location": "query",
53 "type": "string"
54 },
55 "callback": { 34 "callback": {
56 "description": "JSONP", 35 "description": "JSONP",
57 "location": "query", 36 "location": "query",
58 "type": "string" 37 "type": "string"
59 }, 38 },
60 "$.xgafv": { 39 "$.xgafv": {
61 "description": "V1 error format.", 40 "description": "V1 error format.",
62 "enum": [ 41 "enum": [
63 "1", 42 "1",
64 "2" 43 "2"
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
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.", 79 "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.",
101 "location": "query", 80 "location": "query",
102 "type": "string" 81 "type": "string"
103 }, 82 },
104 "pp": { 83 "pp": {
105 "default": "true", 84 "default": "true",
106 "description": "Pretty-print response.", 85 "description": "Pretty-print response.",
107 "location": "query", 86 "location": "query",
108 "type": "boolean" 87 "type": "boolean"
109 }, 88 },
89 "oauth_token": {
90 "description": "OAuth 2.0 token for the current user.",
91 "location": "query",
92 "type": "string"
93 },
110 "bearer_token": { 94 "bearer_token": {
111 "description": "OAuth bearer token.", 95 "description": "OAuth bearer token.",
112 "location": "query", 96 "location": "query",
113 "type": "string" 97 "type": "string"
114 }, 98 },
115 "oauth_token": { 99 "upload_protocol": {
116 "description": "OAuth 2.0 token for the current user.", 100 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
101 "location": "query",
102 "type": "string"
103 },
104 "prettyPrint": {
105 "default": "true",
106 "description": "Returns response with indentations and line breaks." ,
107 "location": "query",
108 "type": "boolean"
109 },
110 "uploadType": {
111 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
112 "location": "query",
113 "type": "string"
114 },
115 "fields": {
116 "description": "Selector specifying which fields to include in a par tial response.",
117 "location": "query", 117 "location": "query",
118 "type": "string" 118 "type": "string"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "resources": { 124 "resources": {
125 "services": { 125 "services": {
126 "methods": { 126 "methods": {
(...skipping 26 matching lines...) Expand all
153 ] 153 ]
154 }, 154 },
155 "list": { 155 "list": {
156 "description": "List enabled services for the specif ied consumer.", 156 "description": "List enabled services for the specif ied consumer.",
157 "httpMethod": "GET", 157 "httpMethod": "GET",
158 "id": "serviceuser.projects.services.list", 158 "id": "serviceuser.projects.services.list",
159 "parameterOrder": [ 159 "parameterOrder": [
160 "parent" 160 "parent"
161 ], 161 ],
162 "parameters": { 162 "parameters": {
163 "parent": {
164 "description": "List enabled services for th e specified parent.\n\nAn example valid parent would be:\n- projects/my-project" ,
165 "location": "path",
166 "pattern": "^projects/[^/]+$",
167 "required": true,
168 "type": "string"
169 },
170 "pageToken": { 163 "pageToken": {
171 "description": "Token identifying which resu lt to start with; returned by a previous list\ncall.", 164 "description": "Token identifying which resu lt to start with; returned by a previous list\ncall.",
172 "location": "query", 165 "location": "query",
173 "type": "string" 166 "type": "string"
174 }, 167 },
175 "pageSize": { 168 "pageSize": {
176 "description": "Requested size of the next p age of data.", 169 "description": "Requested size of the next p age of data.",
177 "format": "int32", 170 "format": "int32",
178 "location": "query", 171 "location": "query",
179 "type": "integer" 172 "type": "integer"
173 },
174 "parent": {
175 "description": "List enabled services for th e specified parent.\n\nAn example valid parent would be:\n- projects/my-project" ,
176 "location": "path",
177 "pattern": "^projects/[^/]+$",
178 "required": true,
179 "type": "string"
180 } 180 }
181 }, 181 },
182 "path": "v1/{+parent}/services", 182 "path": "v1/{+parent}/services",
183 "response": { 183 "response": {
184 "$ref": "ListEnabledServicesResponse" 184 "$ref": "ListEnabledServicesResponse"
185 }, 185 },
186 "scopes": [ 186 "scopes": [
187 "https://www.googleapis.com/auth/cloud-platform" , 187 "https://www.googleapis.com/auth/cloud-platform" ,
188 "https://www.googleapis.com/auth/cloud-platform. read-only" 188 "https://www.googleapis.com/auth/cloud-platform. read-only"
189 ] 189 ]
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after
245 "$ref": "SearchServicesResponse" 245 "$ref": "SearchServicesResponse"
246 }, 246 },
247 "scopes": [ 247 "scopes": [
248 "https://www.googleapis.com/auth/cloud-platform", 248 "https://www.googleapis.com/auth/cloud-platform",
249 "https://www.googleapis.com/auth/cloud-platform.read-onl y" 249 "https://www.googleapis.com/auth/cloud-platform.read-onl y"
250 ] 250 ]
251 } 251 }
252 } 252 }
253 } 253 }
254 }, 254 },
255 "revision": "20170317", 255 "revision": "20170410",
256 "rootUrl": "https://serviceuser.googleapis.com/", 256 "rootUrl": "https://serviceuser.googleapis.com/",
257 "schemas": { 257 "schemas": {
258 "UsageRule": { 258 "LoggingDestination": {
259 "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", 259 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
260 "id": "UsageRule", 260 "id": "LoggingDestination",
261 "properties": { 261 "properties": {
262 "selector": { 262 "logs": {
263 "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.", 263 "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 \"/\".",
264 "type": "string" 264 "items": {
265 "type": "string"
266 },
267 "type": "array"
265 }, 268 },
266 "allowUnregisteredCalls": { 269 "monitoredResource": {
267 "description": "True, if the method allows unregistered call s; false otherwise.", 270 "description": "The monitored resource type. The type must b e defined in the\nService.monitored_resources section.",
268 "type": "boolean"
269 }
270 },
271 "type": "object"
272 },
273 "AuthRequirement": {
274 "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).",
275 "id": "AuthRequirement",
276 "properties": {
277 "providerId": {
278 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
279 "type": "string"
280 },
281 "audiences": {
282 "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",
283 "type": "string" 271 "type": "string"
284 } 272 }
285 }, 273 },
286 "type": "object" 274 "type": "object"
287 }, 275 },
288 "Documentation": { 276 "Option": {
289 "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.", 277 "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
290 "id": "Documentation", 278 "id": "Option",
291 "properties": { 279 "properties": {
292 "rules": { 280 "name": {
293 "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.", 281 "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\"`.",
294 "items": {
295 "$ref": "DocumentationRule"
296 },
297 "type": "array"
298 },
299 "overview": {
300 "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.",
301 "type": "string" 282 "type": "string"
302 }, 283 },
303 "pages": { 284 "value": {
304 "description": "The top level pages for the documentation se t.", 285 "additionalProperties": {
305 "items": { 286 "description": "Properties of the object. Contains field @type with type URL.",
306 "$ref": "Page" 287 "type": "any"
307 }, 288 },
308 "type": "array" 289 "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.",
309 }, 290 "type": "object"
310 "summary": {
311 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
312 "type": "string"
313 },
314 "documentationRootUrl": {
315 "description": "The URL to the root of documentation.",
316 "type": "string"
317 } 291 }
318 }, 292 },
319 "type": "object" 293 "type": "object"
320 }, 294 },
321 "AuthenticationRule": { 295 "Logging": {
322 "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.", 296 "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",
323 "id": "AuthenticationRule", 297 "id": "Logging",
324 "properties": { 298 "properties": {
325 "selector": { 299 "consumerDestinations": {
326 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 300 "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.",
327 "type": "string" 301 "items": {
302 "$ref": "LoggingDestination"
303 },
304 "type": "array"
328 }, 305 },
329 "allowWithoutCredential": { 306 "producerDestinations": {
330 "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.", 307 "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.",
331 "type": "boolean"
332 },
333 "oauth": {
334 "$ref": "OAuthRequirements",
335 "description": "The requirements for OAuth credentials."
336 },
337 "requirements": {
338 "description": "Requirements for additional authentication p roviders.",
339 "items": { 308 "items": {
340 "$ref": "AuthRequirement" 309 "$ref": "LoggingDestination"
341 }, 310 },
342 "type": "array" 311 "type": "array"
343 } 312 }
344 }, 313 },
345 "type": "object" 314 "type": "object"
346 }, 315 },
347 "BackendRule": { 316 "QuotaLimit": {
348 "description": "A backend rule provides configuration for an individ ual API element.", 317 "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`.",
349 "id": "BackendRule", 318 "id": "QuotaLimit",
350 "properties": { 319 "properties": {
351 "address": { 320 "freeTier": {
352 "description": "The address of the API backend.", 321 "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.",
322 "format": "int64",
353 "type": "string" 323 "type": "string"
354 }, 324 },
355 "selector": { 325 "duration": {
356 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 326 "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.",
357 "type": "string" 327 "type": "string"
358 }, 328 },
359 "deadline": { 329 "defaultLimit": {
360 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.", 330 "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.",
361 "format": "double", 331 "format": "int64",
362 "type": "number" 332 "type": "string"
333 },
334 "metric": {
335 "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.",
336 "type": "string"
337 },
338 "description": {
339 "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` ).",
340 "type": "string"
341 },
342 "displayName": {
343 "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.",
344 "type": "string"
345 },
346 "values": {
347 "additionalProperties": {
348 "format": "int64",
349 "type": "string"
350 },
351 "description": "Tiered limit values. Also allows for regiona l or zone overrides for these\nvalues if \"/{region}\" or \"/{zone}\" is specifi ed in the unit field.\n\nCurrently supported tiers from low to high:\nVERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH\n\nTo apply different limit values for users acco rding to their tiers, specify\nthe values for the tiers you want to differentiat e. For example:\n{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}\n\nThe limit value for each tier is optional except for the tier STANDARD.\nThe limit value for an unspecified tier falls to the value of its next\ntier towards tier STANDA RD. For the above example, the limit value for tier\nSTANDARD is 500.\n\nTo appl y the same limit value for all users, just specify limit value for\ntier STANDAR D. For example: {STANDARD:500}.\n\nTo apply a regional overide for a tier, add a map entry with key\n\"<TIER>/<region>\", where <region> is a region name. Simil arly, for a zone\noverride, add a map entry with key \"<TIER>/{zone}\".\nFurther , a wildcard can be used at the end of a zone name in order to\nspecify zone lev el overrides. For example:\nLOW: 10, STANDARD: 50, HIGH: 100,\nLOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,\nLOW/us-central1-*: 10, STA NDARD/us-central1-*: 20, HIGH/us-central1-*: 80\n\nThe regional overrides tier s et for each region must be the same as\nthe tier set for default limit values. S ame rule applies for zone overrides\ntier as well.\n\nUsed by metric-based quota s only.",
352 "type": "object"
353 },
354 "unit": {
355 "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 * \"/{organization}\" quota for an organization.\n * \"/{project}\" quota for a project.\n * \"/{folder}\" quota for a folder.\n * \"/{resource}\" quota for a universal resource.\n* Zero or more quota segmentation dimension. Not all comb os are valid.\n * \"/{region}\" quota for every region. Not to be used with tim e intervals.\n * Otherwise the resources granted on the target is not segmented .\n * \"/{zone}\" quota for every zone. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{resou rce}\" quota for a resource associated with a project or org.\n\nHere are some e xamples:\n* \"1/min/{project}\" for quota per minute per project.\n* \"1/min/{us er}\" for quota per minute per user.\n* \"1/min/{organization}\" for quota per m inute per organization.\n\nNote: the order of unit components is insignificant.\ nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUse d by metric-based quotas only.",
356 "type": "string"
357 },
358 "maxLimit": {
359 "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.",
360 "format": "int64",
361 "type": "string"
362 },
363 "name": {
364 "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 group-based quota limits, the name must be unique within the quota\ngroup. If a name is not provided, it will be generated from the limit_by\nand duration fields.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacte rs as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\n The name of a limit is used as a unique identifier for this limit.\nTherefore, o nce a limit has been put into use, its name should be\nimmutable. You can use th e 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.",
365 "type": "string"
363 } 366 }
364 }, 367 },
365 "type": "object" 368 "type": "object"
366 }, 369 },
367 "Api": { 370 "Method": {
368 "description": "Api is a light-weight descriptor for a protocol buff er service.", 371 "description": "Method represents a method of an api.",
369 "id": "Api", 372 "id": "Method",
370 "properties": { 373 "properties": {
374 "responseStreaming": {
375 "description": "If true, the response is streamed.",
376 "type": "boolean"
377 },
371 "name": { 378 "name": {
372 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.", 379 "description": "The simple name of this method.",
373 "type": "string" 380 "type": "string"
374 }, 381 },
382 "requestTypeUrl": {
383 "description": "A URL of the input message type.",
384 "type": "string"
385 },
386 "requestStreaming": {
387 "description": "If true, the request is streamed.",
388 "type": "boolean"
389 },
375 "syntax": { 390 "syntax": {
376 "description": "The source syntax of the service.", 391 "description": "The source syntax of this method.",
377 "enum": [ 392 "enum": [
378 "SYNTAX_PROTO2", 393 "SYNTAX_PROTO2",
379 "SYNTAX_PROTO3" 394 "SYNTAX_PROTO3"
380 ], 395 ],
381 "enumDescriptions": [ 396 "enumDescriptions": [
382 "Syntax `proto2`.", 397 "Syntax `proto2`.",
383 "Syntax `proto3`." 398 "Syntax `proto3`."
384 ], 399 ],
385 "type": "string" 400 "type": "string"
386 }, 401 },
387 "sourceContext": { 402 "responseTypeUrl": {
388 "$ref": "SourceContext", 403 "description": "The URL of the output message type.",
389 "description": "Source context for the protocol buffer servi ce represented by this\nmessage." 404 "type": "string"
390 },
391 "version": {
392 "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",
393 "type": "string"
394 },
395 "mixins": {
396 "description": "Included APIs. See Mixin.",
397 "items": {
398 "$ref": "Mixin"
399 },
400 "type": "array"
401 }, 405 },
402 "options": { 406 "options": {
403 "description": "Any metadata attached to the API.", 407 "description": "Any metadata attached to the method.",
404 "items": { 408 "items": {
405 "$ref": "Option" 409 "$ref": "Option"
406 }, 410 },
407 "type": "array" 411 "type": "array"
408 }, 412 }
409 "methods": { 413 },
410 "description": "The methods of this api, in unspecified orde r.", 414 "type": "object"
411 "items": { 415 },
412 "$ref": "Method" 416 "Mixin": {
413 }, 417 "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 }",
414 "type": "array" 418 "id": "Mixin",
415 } 419 "properties": {
416 }, 420 "name": {
417 "type": "object" 421 "description": "The fully qualified name of the API which is included.",
418 }, 422 "type": "string"
419 "Authentication": { 423 },
420 "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", 424 "root": {
421 "id": "Authentication", 425 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
426 "type": "string"
427 }
428 },
429 "type": "object"
430 },
431 "CustomError": {
432 "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",
433 "id": "CustomError",
422 "properties": { 434 "properties": {
423 "rules": { 435 "rules": {
424 "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.", 436 "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.",
425 "items": { 437 "items": {
426 "$ref": "AuthenticationRule" 438 "$ref": "CustomErrorRule"
427 }, 439 },
428 "type": "array" 440 "type": "array"
429 }, 441 },
430 "providers": { 442 "types": {
431 "description": "Defines a set of authentication providers th at a service supports.", 443 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
432 "items": { 444 "items": {
433 "$ref": "AuthProvider" 445 "type": "string"
434 }, 446 },
435 "type": "array" 447 "type": "array"
436 } 448 }
437 }, 449 },
438 "type": "object" 450 "type": "object"
439 }, 451 },
440 "Operation": { 452 "Http": {
441 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 453 "description": "Defines the HTTP configuration for a service. It con tains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
442 "id": "Operation", 454 "id": "Http",
443 "properties": { 455 "properties": {
444 "done": { 456 "fullyDecodeReservedExpansion": {
445 "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.", 457 "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.",
446 "type": "boolean" 458 "type": "boolean"
447 }, 459 },
448 "response": { 460 "rules": {
449 "additionalProperties": { 461 "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.",
450 "description": "Properties of the object. Contains field @type with type URL.", 462 "items": {
451 "type": "any" 463 "$ref": "HttpRule"
452 }, 464 },
453 "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`.", 465 "type": "array"
454 "type": "object" 466 }
455 }, 467 },
456 "name": { 468 "type": "object"
457 "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` .", 469 },
458 "type": "string" 470 "SourceInfo": {
459 }, 471 "description": "Source information used to create a Service Config",
460 "error": { 472 "id": "SourceInfo",
461 "$ref": "Status", 473 "properties": {
462 "description": "The error result of the operation in case of failure or cancellation." 474 "sourceFiles": {
463 }, 475 "description": "All files used during config generation.",
464 "metadata": {
465 "additionalProperties": {
466 "description": "Properties of the object. Contains field @type with type URL.",
467 "type": "any"
468 },
469 "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. ",
470 "type": "object"
471 }
472 },
473 "type": "object"
474 },
475 "Page": {
476 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
477 "id": "Page",
478 "properties": {
479 "name": {
480 "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`.",
481 "type": "string"
482 },
483 "content": {
484 "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.",
485 "type": "string"
486 },
487 "subpages": {
488 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
489 "items": {
490 "$ref": "Page"
491 },
492 "type": "array"
493 }
494 },
495 "type": "object"
496 },
497 "Status": {
498 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
499 "id": "Status",
500 "properties": {
501 "code": {
502 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
503 "format": "int32",
504 "type": "integer"
505 },
506 "message": {
507 "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.",
508 "type": "string"
509 },
510 "details": {
511 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
512 "items": { 476 "items": {
513 "additionalProperties": { 477 "additionalProperties": {
514 "description": "Properties of the object. Contains f ield @type with type URL.", 478 "description": "Properties of the object. Contains f ield @type with type URL.",
515 "type": "any" 479 "type": "any"
516 }, 480 },
517 "type": "object" 481 "type": "object"
518 }, 482 },
519 "type": "array" 483 "type": "array"
520 } 484 }
521 }, 485 },
522 "type": "object" 486 "type": "object"
523 }, 487 },
524 "AuthProvider": {
525 "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).",
526 "id": "AuthProvider",
527 "properties": {
528 "jwksUri": {
529 "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",
530 "type": "string"
531 },
532 "audiences": {
533 "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",
534 "type": "string"
535 },
536 "id": {
537 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".",
538 "type": "string"
539 },
540 "issuer": {
541 "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",
542 "type": "string"
543 }
544 },
545 "type": "object"
546 },
547 "EnumValue": {
548 "description": "Enum value definition.",
549 "id": "EnumValue",
550 "properties": {
551 "number": {
552 "description": "Enum value number.",
553 "format": "int32",
554 "type": "integer"
555 },
556 "name": {
557 "description": "Enum value name.",
558 "type": "string"
559 },
560 "options": {
561 "description": "Protocol buffer options.",
562 "items": {
563 "$ref": "Option"
564 },
565 "type": "array"
566 }
567 },
568 "type": "object"
569 },
570 "Service": {
571 "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",
572 "id": "Service",
573 "properties": {
574 "visibility": {
575 "$ref": "Visibility",
576 "description": "API visibility configuration."
577 },
578 "name": {
579 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
580 "type": "string"
581 },
582 "customError": {
583 "$ref": "CustomError",
584 "description": "Custom error configuration."
585 },
586 "title": {
587 "description": "The product title associated with this servi ce.",
588 "type": "string"
589 },
590 "endpoints": {
591 "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.",
592 "items": {
593 "$ref": "Endpoint"
594 },
595 "type": "array"
596 },
597 "apis": {
598 "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.",
599 "items": {
600 "$ref": "Api"
601 },
602 "type": "array"
603 },
604 "logs": {
605 "description": "Defines the logs used by this service.",
606 "items": {
607 "$ref": "LogDescriptor"
608 },
609 "type": "array"
610 },
611 "types": {
612 "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",
613 "items": {
614 "$ref": "Type"
615 },
616 "type": "array"
617 },
618 "sourceInfo": {
619 "$ref": "SourceInfo",
620 "description": "Output only. The source information for this configuration if available."
621 },
622 "http": {
623 "$ref": "Http",
624 "description": "HTTP configuration."
625 },
626 "backend": {
627 "$ref": "Backend",
628 "description": "API backend configuration."
629 },
630 "systemParameters": {
631 "$ref": "SystemParameters",
632 "description": "System parameter configuration."
633 },
634 "documentation": {
635 "$ref": "Documentation",
636 "description": "Additional API documentation."
637 },
638 "logging": {
639 "$ref": "Logging",
640 "description": "Logging configuration."
641 },
642 "monitoredResources": {
643 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.",
644 "items": {
645 "$ref": "MonitoredResourceDescriptor"
646 },
647 "type": "array"
648 },
649 "enums": {
650 "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",
651 "items": {
652 "$ref": "Enum"
653 },
654 "type": "array"
655 },
656 "context": {
657 "$ref": "Context",
658 "description": "Context configuration."
659 },
660 "id": {
661 "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.",
662 "type": "string"
663 },
664 "usage": {
665 "$ref": "Usage",
666 "description": "Configuration controlling usage of this serv ice."
667 },
668 "metrics": {
669 "description": "Defines the metrics used by this service.",
670 "items": {
671 "$ref": "MetricDescriptor"
672 },
673 "type": "array"
674 },
675 "authentication": {
676 "$ref": "Authentication",
677 "description": "Auth configuration."
678 },
679 "experimental": {
680 "$ref": "Experimental",
681 "description": "Experimental configuration."
682 },
683 "control": {
684 "$ref": "Control",
685 "description": "Configuration for the service control plane. "
686 },
687 "configVersion": {
688 "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`.",
689 "format": "uint32",
690 "type": "integer"
691 },
692 "monitoring": {
693 "$ref": "Monitoring",
694 "description": "Monitoring configuration."
695 },
696 "producerProjectId": {
697 "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration, \nmanage consumption of the service, etc.",
698 "type": "string"
699 },
700 "systemTypes": {
701 "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.",
702 "items": {
703 "$ref": "Type"
704 },
705 "type": "array"
706 }
707 },
708 "type": "object"
709 },
710 "OperationMetadata": {
711 "description": "The metadata associated with a long running operatio n resource.",
712 "id": "OperationMetadata",
713 "properties": {
714 "startTime": {
715 "description": "The start time of the operation.",
716 "format": "google-datetime",
717 "type": "string"
718 },
719 "resourceNames": {
720 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
721 "items": {
722 "type": "string"
723 },
724 "type": "array"
725 },
726 "steps": {
727 "description": "Detailed status information for each step. T he order is undetermined.",
728 "items": {
729 "$ref": "Step"
730 },
731 "type": "array"
732 },
733 "progressPercentage": {
734 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
735 "format": "int32",
736 "type": "integer"
737 }
738 },
739 "type": "object"
740 },
741 "CustomHttpPattern": {
742 "description": "A custom pattern is used for defining custom HTTP ve rb.",
743 "id": "CustomHttpPattern",
744 "properties": {
745 "path": {
746 "description": "The path matched by this custom verb.",
747 "type": "string"
748 },
749 "kind": {
750 "description": "The name of this custom HTTP verb.",
751 "type": "string"
752 }
753 },
754 "type": "object"
755 },
756 "SystemParameterRule": {
757 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
758 "id": "SystemParameterRule",
759 "properties": {
760 "selector": {
761 "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.",
762 "type": "string"
763 },
764 "parameters": {
765 "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.",
766 "items": {
767 "$ref": "SystemParameter"
768 },
769 "type": "array"
770 }
771 },
772 "type": "object"
773 },
774 "PublishedService": {
775 "description": "The published version of a Service that is managed b y\nGoogle Service Management.",
776 "id": "PublishedService",
777 "properties": {
778 "name": {
779 "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
780 "type": "string"
781 },
782 "service": {
783 "$ref": "Service",
784 "description": "The service's published configuration."
785 }
786 },
787 "type": "object"
788 },
789 "HttpRule": {
790 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST APIs. The mapping determines what portions of the request \nmessage are populated from the path, query parameters, or body of\nthe HTTP re quest. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refe r to fields in the request\nmessage, as in the example below which describes a R EST GET\noperation on a resource collection of messages:\n\n\n service Messag ing {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n opti on (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n s tring subfield = 1;\n }\n string message_id = 1; // mapped to the URL\ n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n messag e Message {\n string text = 1; // content of the resource\n }\n\nThe sam e http annotation can alternatively be expressed inside the\n`GRPC API Configura tion` YAML file.\n\n http:\n rules:\n - selector: <proto_package_ name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfie ld}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `G etMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn gene ral, not only fields but also field paths can be referenced\nfrom a path pattern . Fields mapped to the path pattern cannot be\nrepeated and must have a primitiv e (non-message) type.\n\nAny fields in the request message which are not bound b y the path\npattern automatically become (optional) HTTP query\nparameters. Assu me the following definition of the request message:\n\n\n message GetMessageR equest {\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 sub = 3; // `sub.subfield` becomes a pa rameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMe ssage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\ nNote that fields which are mapped to HTTP parameters must have a\nprimitive typ e or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A&pa ram=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\ns pecifies the mapping. Consider a REST update method on the\nmessage resource col lection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequ est) returns (Message) {\n option (google.api.http) = {\n put: \ "/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mappe d 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(m essage_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path temp late should be mapped to the\nrequest body. This enables the following alternat ive definition of\nthe update method:\n\n service Messaging {\n rpc Upda teMessage(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 HTTP JSON to RPC mapping is enabled:\n\nHTT P | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateM essage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bo und by the path end in\nthe body. This makes this option more rarely used in pra ctice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhic h don't use the URL at all for transferring data.\n\nIt is possible to define mu ltiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Exam ple:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/ {user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nma ppings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(mess age_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for map ping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursi ve expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body fi eld)\n (c) All other fields.\n3. URL query parameters found in the HTTP reque st are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Templa te = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments . It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) S ection 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n \nThe syntax `Variable` matches the entire path as specified by its template;\nt his nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent t o `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not re fer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any H TTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card r ule is useful for services that provide\ncontent to Web (HTML) clients.",
791 "id": "HttpRule",
792 "properties": {
793 "additionalBindings": {
794 "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).",
795 "items": {
796 "$ref": "HttpRule"
797 },
798 "type": "array"
799 },
800 "responseBody": {
801 "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.",
802 "type": "string"
803 },
804 "mediaUpload": {
805 "$ref": "MediaUpload",
806 "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."
807 },
808 "selector": {
809 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.",
810 "type": "string"
811 },
812 "custom": {
813 "$ref": "CustomHttpPattern",
814 "description": "Custom pattern is used for defining custom v erbs."
815 },
816 "get": {
817 "description": "Used for listing and getting information abo ut resources.",
818 "type": "string"
819 },
820 "patch": {
821 "description": "Used for updating a resource.",
822 "type": "string"
823 },
824 "put": {
825 "description": "Used for updating a resource.",
826 "type": "string"
827 },
828 "delete": {
829 "description": "Used for deleting a resource.",
830 "type": "string"
831 },
832 "body": {
833 "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.",
834 "type": "string"
835 },
836 "post": {
837 "description": "Used for creating a resource.",
838 "type": "string"
839 },
840 "mediaDownload": {
841 "$ref": "MediaDownload",
842 "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."
843 }
844 },
845 "type": "object"
846 },
847 "VisibilityRule": {
848 "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
849 "id": "VisibilityRule",
850 "properties": {
851 "selector": {
852 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
853 "type": "string"
854 },
855 "restriction": {
856 "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.",
857 "type": "string"
858 }
859 },
860 "type": "object"
861 },
862 "MonitoringDestination": {
863 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
864 "id": "MonitoringDestination",
865 "properties": {
866 "monitoredResource": {
867 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
868 "type": "string"
869 },
870 "metrics": {
871 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.",
872 "items": {
873 "type": "string"
874 },
875 "type": "array"
876 }
877 },
878 "type": "object"
879 },
880 "Visibility": {
881 "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.",
882 "id": "Visibility",
883 "properties": {
884 "rules": {
885 "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.",
886 "items": {
887 "$ref": "VisibilityRule"
888 },
889 "type": "array"
890 }
891 },
892 "type": "object"
893 },
894 "SystemParameters": {
895 "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.",
896 "id": "SystemParameters",
897 "properties": {
898 "rules": {
899 "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.",
900 "items": {
901 "$ref": "SystemParameterRule"
902 },
903 "type": "array"
904 }
905 },
906 "type": "object"
907 },
908 "Step": {
909 "description": "Represents the status of one operation step.",
910 "id": "Step",
911 "properties": {
912 "description": {
913 "description": "The short description of the step.",
914 "type": "string"
915 },
916 "status": {
917 "description": "The status code.",
918 "enum": [
919 "STATUS_UNSPECIFIED",
920 "DONE",
921 "NOT_STARTED",
922 "IN_PROGRESS",
923 "FAILED",
924 "CANCELLED"
925 ],
926 "enumDescriptions": [
927 "Unspecifed code.",
928 "The operation or step has completed without errors.",
929 "The operation or step has not started yet.",
930 "The operation or step is in progress.",
931 "The operation or step has completed with errors.",
932 "The operation or step has completed with cancellation."
933 ],
934 "type": "string"
935 }
936 },
937 "type": "object"
938 },
939 "LoggingDestination": {
940 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
941 "id": "LoggingDestination",
942 "properties": {
943 "logs": {
944 "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 \"/\".",
945 "items": {
946 "type": "string"
947 },
948 "type": "array"
949 },
950 "monitoredResource": {
951 "description": "The monitored resource type. The type must b e defined in the\nService.monitored_resources section.",
952 "type": "string"
953 }
954 },
955 "type": "object"
956 },
957 "Option": {
958 "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
959 "id": "Option",
960 "properties": {
961 "value": {
962 "additionalProperties": {
963 "description": "Properties of the object. Contains field @type with type URL.",
964 "type": "any"
965 },
966 "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.",
967 "type": "object"
968 },
969 "name": {
970 "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\"`.",
971 "type": "string"
972 }
973 },
974 "type": "object"
975 },
976 "Logging": {
977 "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",
978 "id": "Logging",
979 "properties": {
980 "consumerDestinations": {
981 "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.",
982 "items": {
983 "$ref": "LoggingDestination"
984 },
985 "type": "array"
986 },
987 "producerDestinations": {
988 "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.",
989 "items": {
990 "$ref": "LoggingDestination"
991 },
992 "type": "array"
993 }
994 },
995 "type": "object"
996 },
997 "Method": {
998 "description": "Method represents a method of an api.",
999 "id": "Method",
1000 "properties": {
1001 "responseTypeUrl": {
1002 "description": "The URL of the output message type.",
1003 "type": "string"
1004 },
1005 "options": {
1006 "description": "Any metadata attached to the method.",
1007 "items": {
1008 "$ref": "Option"
1009 },
1010 "type": "array"
1011 },
1012 "responseStreaming": {
1013 "description": "If true, the response is streamed.",
1014 "type": "boolean"
1015 },
1016 "name": {
1017 "description": "The simple name of this method.",
1018 "type": "string"
1019 },
1020 "requestTypeUrl": {
1021 "description": "A URL of the input message type.",
1022 "type": "string"
1023 },
1024 "requestStreaming": {
1025 "description": "If true, the request is streamed.",
1026 "type": "boolean"
1027 },
1028 "syntax": {
1029 "description": "The source syntax of this method.",
1030 "enum": [
1031 "SYNTAX_PROTO2",
1032 "SYNTAX_PROTO3"
1033 ],
1034 "enumDescriptions": [
1035 "Syntax `proto2`.",
1036 "Syntax `proto3`."
1037 ],
1038 "type": "string"
1039 }
1040 },
1041 "type": "object"
1042 },
1043 "Mixin": {
1044 "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 }",
1045 "id": "Mixin",
1046 "properties": {
1047 "name": {
1048 "description": "The fully qualified name of the API which is included.",
1049 "type": "string"
1050 },
1051 "root": {
1052 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
1053 "type": "string"
1054 }
1055 },
1056 "type": "object"
1057 },
1058 "CustomError": {
1059 "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",
1060 "id": "CustomError",
1061 "properties": {
1062 "types": {
1063 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
1064 "items": {
1065 "type": "string"
1066 },
1067 "type": "array"
1068 },
1069 "rules": {
1070 "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.",
1071 "items": {
1072 "$ref": "CustomErrorRule"
1073 },
1074 "type": "array"
1075 }
1076 },
1077 "type": "object"
1078 },
1079 "Http": {
1080 "description": "Defines the HTTP configuration for a service. It con tains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
1081 "id": "Http",
1082 "properties": {
1083 "rules": {
1084 "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.",
1085 "items": {
1086 "$ref": "HttpRule"
1087 },
1088 "type": "array"
1089 }
1090 },
1091 "type": "object"
1092 },
1093 "SourceInfo": {
1094 "description": "Source information used to create a Service Config",
1095 "id": "SourceInfo",
1096 "properties": {
1097 "sourceFiles": {
1098 "description": "All files used during config generation.",
1099 "items": {
1100 "additionalProperties": {
1101 "description": "Properties of the object. Contains f ield @type with type URL.",
1102 "type": "any"
1103 },
1104 "type": "object"
1105 },
1106 "type": "array"
1107 }
1108 },
1109 "type": "object"
1110 },
1111 "Control": { 488 "Control": {
1112 "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.", 489 "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.",
1113 "id": "Control", 490 "id": "Control",
1114 "properties": { 491 "properties": {
1115 "environment": { 492 "environment": {
1116 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.", 493 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.",
1117 "type": "string" 494 "type": "string"
1118 } 495 }
1119 }, 496 },
1120 "type": "object" 497 "type": "object"
1121 }, 498 },
1122 "SystemParameter": { 499 "SystemParameter": {
1123 "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.", 500 "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.",
1124 "id": "SystemParameter", 501 "id": "SystemParameter",
1125 "properties": { 502 "properties": {
503 "name": {
504 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.",
505 "type": "string"
506 },
1126 "urlQueryParameter": { 507 "urlQueryParameter": {
1127 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.", 508 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.",
1128 "type": "string" 509 "type": "string"
1129 }, 510 },
1130 "httpHeader": { 511 "httpHeader": {
1131 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.", 512 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.",
1132 "type": "string" 513 "type": "string"
1133 }, 514 }
1134 "name": { 515 },
1135 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.", 516 "type": "object"
1136 "type": "string" 517 },
518 "Monitoring": {
519 "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",
520 "id": "Monitoring",
521 "properties": {
522 "consumerDestinations": {
523 "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.",
524 "items": {
525 "$ref": "MonitoringDestination"
526 },
527 "type": "array"
528 },
529 "producerDestinations": {
530 "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.",
531 "items": {
532 "$ref": "MonitoringDestination"
533 },
534 "type": "array"
1137 } 535 }
1138 }, 536 },
1139 "type": "object" 537 "type": "object"
1140 }, 538 },
1141 "Field": { 539 "Field": {
1142 "description": "A single field of a message type.", 540 "description": "A single field of a message type.",
1143 "id": "Field", 541 "id": "Field",
1144 "properties": { 542 "properties": {
543 "cardinality": {
544 "description": "The field cardinality.",
545 "enum": [
546 "CARDINALITY_UNKNOWN",
547 "CARDINALITY_OPTIONAL",
548 "CARDINALITY_REQUIRED",
549 "CARDINALITY_REPEATED"
550 ],
551 "enumDescriptions": [
552 "For fields with unknown cardinality.",
553 "For optional fields.",
554 "For required fields. Proto2 syntax only.",
555 "For repeated fields."
556 ],
557 "type": "string"
558 },
559 "packed": {
560 "description": "Whether to use alternative packed wire repre sentation.",
561 "type": "boolean"
562 },
563 "defaultValue": {
564 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
565 "type": "string"
566 },
1145 "name": { 567 "name": {
1146 "description": "The field name.", 568 "description": "The field name.",
1147 "type": "string" 569 "type": "string"
1148 }, 570 },
1149 "typeUrl": { 571 "typeUrl": {
1150 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.", 572 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
1151 "type": "string" 573 "type": "string"
1152 }, 574 },
1153 "number": { 575 "number": {
1154 "description": "The field number.", 576 "description": "The field number.",
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
1209 "description": "The protocol buffer options.", 631 "description": "The protocol buffer options.",
1210 "items": { 632 "items": {
1211 "$ref": "Option" 633 "$ref": "Option"
1212 }, 634 },
1213 "type": "array" 635 "type": "array"
1214 }, 636 },
1215 "oneofIndex": { 637 "oneofIndex": {
1216 "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.", 638 "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.",
1217 "format": "int32", 639 "format": "int32",
1218 "type": "integer" 640 "type": "integer"
1219 },
1220 "cardinality": {
1221 "description": "The field cardinality.",
1222 "enum": [
1223 "CARDINALITY_UNKNOWN",
1224 "CARDINALITY_OPTIONAL",
1225 "CARDINALITY_REQUIRED",
1226 "CARDINALITY_REPEATED"
1227 ],
1228 "enumDescriptions": [
1229 "For fields with unknown cardinality.",
1230 "For optional fields.",
1231 "For required fields. Proto2 syntax only.",
1232 "For repeated fields."
1233 ],
1234 "type": "string"
1235 },
1236 "packed": {
1237 "description": "Whether to use alternative packed wire repre sentation.",
1238 "type": "boolean"
1239 },
1240 "defaultValue": {
1241 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
1242 "type": "string"
1243 }
1244 },
1245 "type": "object"
1246 },
1247 "Monitoring": {
1248 "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",
1249 "id": "Monitoring",
1250 "properties": {
1251 "consumerDestinations": {
1252 "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.",
1253 "items": {
1254 "$ref": "MonitoringDestination"
1255 },
1256 "type": "array"
1257 },
1258 "producerDestinations": {
1259 "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.",
1260 "items": {
1261 "$ref": "MonitoringDestination"
1262 },
1263 "type": "array"
1264 } 641 }
1265 }, 642 },
1266 "type": "object" 643 "type": "object"
1267 }, 644 },
1268 "Enum": { 645 "Enum": {
1269 "description": "Enum type definition.", 646 "description": "Enum type definition.",
1270 "id": "Enum", 647 "id": "Enum",
1271 "properties": { 648 "properties": {
1272 "name": { 649 "name": {
1273 "description": "Enum type name.", 650 "description": "Enum type name.",
(...skipping 25 matching lines...) Expand all
1299 ], 676 ],
1300 "enumDescriptions": [ 677 "enumDescriptions": [
1301 "Syntax `proto2`.", 678 "Syntax `proto2`.",
1302 "Syntax `proto3`." 679 "Syntax `proto3`."
1303 ], 680 ],
1304 "type": "string" 681 "type": "string"
1305 } 682 }
1306 }, 683 },
1307 "type": "object" 684 "type": "object"
1308 }, 685 },
1309 "EnableServiceRequest": {
1310 "description": "Request message for EnableService method.",
1311 "id": "EnableServiceRequest",
1312 "properties": {},
1313 "type": "object"
1314 },
1315 "LabelDescriptor": { 686 "LabelDescriptor": {
1316 "description": "A description of a label.", 687 "description": "A description of a label.",
1317 "id": "LabelDescriptor", 688 "id": "LabelDescriptor",
1318 "properties": { 689 "properties": {
1319 "key": { 690 "key": {
1320 "description": "The label key.", 691 "description": "The label key.",
1321 "type": "string" 692 "type": "string"
1322 }, 693 },
1323 "description": { 694 "description": {
1324 "description": "A human-readable description for the label." , 695 "description": "A human-readable description for the label." ,
1325 "type": "string" 696 "type": "string"
1326 }, 697 },
1327 "valueType": { 698 "valueType": {
1328 "description": "The type of data that can be assigned to the label.", 699 "description": "The type of data that can be assigned to the label.",
1329 "enum": [ 700 "enum": [
1330 "STRING", 701 "STRING",
1331 "BOOL", 702 "BOOL",
1332 "INT64" 703 "INT64"
1333 ], 704 ],
1334 "enumDescriptions": [ 705 "enumDescriptions": [
1335 "A variable-length string. This is the default.", 706 "A variable-length string. This is the default.",
1336 "Boolean; true or false.", 707 "Boolean; true or false.",
1337 "A 64-bit signed integer." 708 "A 64-bit signed integer."
1338 ], 709 ],
1339 "type": "string" 710 "type": "string"
1340 } 711 }
1341 }, 712 },
1342 "type": "object" 713 "type": "object"
1343 }, 714 },
715 "EnableServiceRequest": {
716 "description": "Request message for EnableService method.",
717 "id": "EnableServiceRequest",
718 "properties": {},
719 "type": "object"
720 },
1344 "Type": { 721 "Type": {
1345 "description": "A protocol buffer message type.", 722 "description": "A protocol buffer message type.",
1346 "id": "Type", 723 "id": "Type",
1347 "properties": { 724 "properties": {
1348 "options": {
1349 "description": "The protocol buffer options.",
1350 "items": {
1351 "$ref": "Option"
1352 },
1353 "type": "array"
1354 },
1355 "fields": {
1356 "description": "The list of fields.",
1357 "items": {
1358 "$ref": "Field"
1359 },
1360 "type": "array"
1361 },
1362 "name": { 725 "name": {
1363 "description": "The fully qualified message name.", 726 "description": "The fully qualified message name.",
1364 "type": "string" 727 "type": "string"
1365 }, 728 },
1366 "oneofs": { 729 "oneofs": {
1367 "description": "The list of types appearing in `oneof` defin itions in this type.", 730 "description": "The list of types appearing in `oneof` defin itions in this type.",
1368 "items": { 731 "items": {
1369 "type": "string" 732 "type": "string"
1370 }, 733 },
1371 "type": "array" 734 "type": "array"
1372 }, 735 },
736 "sourceContext": {
737 "$ref": "SourceContext",
738 "description": "The source context."
739 },
1373 "syntax": { 740 "syntax": {
1374 "description": "The source syntax.", 741 "description": "The source syntax.",
1375 "enum": [ 742 "enum": [
1376 "SYNTAX_PROTO2", 743 "SYNTAX_PROTO2",
1377 "SYNTAX_PROTO3" 744 "SYNTAX_PROTO3"
745 ],
746 "enumDescriptions": [
747 "Syntax `proto2`.",
748 "Syntax `proto3`."
749 ],
750 "type": "string"
751 },
752 "options": {
753 "description": "The protocol buffer options.",
754 "items": {
755 "$ref": "Option"
756 },
757 "type": "array"
758 },
759 "fields": {
760 "description": "The list of fields.",
761 "items": {
762 "$ref": "Field"
763 },
764 "type": "array"
765 }
766 },
767 "type": "object"
768 },
769 "Experimental": {
770 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.",
771 "id": "Experimental",
772 "properties": {
773 "authorization": {
774 "$ref": "AuthorizationConfig",
775 "description": "Authorization configuration."
776 }
777 },
778 "type": "object"
779 },
780 "Backend": {
781 "description": "`Backend` defines the backend configuration for a se rvice.",
782 "id": "Backend",
783 "properties": {
784 "rules": {
785 "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.",
786 "items": {
787 "$ref": "BackendRule"
788 },
789 "type": "array"
790 }
791 },
792 "type": "object"
793 },
794 "DocumentationRule": {
795 "description": "A documentation rule provides information about indi vidual API elements.",
796 "id": "DocumentationRule",
797 "properties": {
798 "selector": {
799 "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.",
800 "type": "string"
801 },
802 "description": {
803 "description": "Description of the selected API(s).",
804 "type": "string"
805 },
806 "deprecationDescription": {
807 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.",
808 "type": "string"
809 }
810 },
811 "type": "object"
812 },
813 "AuthorizationConfig": {
814 "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",
815 "id": "AuthorizationConfig",
816 "properties": {
817 "provider": {
818 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
819 "type": "string"
820 }
821 },
822 "type": "object"
823 },
824 "ContextRule": {
825 "description": "A context rule provides information about the contex t for an individual API\nelement.",
826 "id": "ContextRule",
827 "properties": {
828 "selector": {
829 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
830 "type": "string"
831 },
832 "provided": {
833 "description": "A list of full type names of provided contex ts.",
834 "items": {
835 "type": "string"
836 },
837 "type": "array"
838 },
839 "requested": {
840 "description": "A list of full type names of requested conte xts.",
841 "items": {
842 "type": "string"
843 },
844 "type": "array"
845 }
846 },
847 "type": "object"
848 },
849 "MetricDescriptor": {
850 "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.",
851 "id": "MetricDescriptor",
852 "properties": {
853 "name": {
854 "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\"",
855 "type": "string"
856 },
857 "type": {
858 "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\"",
859 "type": "string"
860 },
861 "valueType": {
862 "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.",
863 "enum": [
864 "VALUE_TYPE_UNSPECIFIED",
865 "BOOL",
866 "INT64",
867 "DOUBLE",
868 "STRING",
869 "DISTRIBUTION",
870 "MONEY"
871 ],
872 "enumDescriptions": [
873 "Do not use this default value.",
874 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.",
875 "The value is a signed 64-bit integer.",
876 "The value is a double precision floating point number." ,
877 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.",
878 "The value is a `Distribution`.",
879 "The value is money."
880 ],
881 "type": "string"
882 },
883 "metricKind": {
884 "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.",
885 "enum": [
886 "METRIC_KIND_UNSPECIFIED",
887 "GAUGE",
888 "DELTA",
889 "CUMULATIVE"
890 ],
891 "enumDescriptions": [
892 "Do not use this default value.",
893 "An instantaneous measurement of a value.",
894 "The change in a value during a time interval.",
895 "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."
896 ],
897 "type": "string"
898 },
899 "displayName": {
900 "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\".",
901 "type": "string"
902 },
903 "description": {
904 "description": "A detailed description of the metric, which can be used in documentation.",
905 "type": "string"
906 },
907 "unit": {
908 "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 '}'.",
909 "type": "string"
910 },
911 "labels": {
912 "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.",
913 "items": {
914 "$ref": "LabelDescriptor"
915 },
916 "type": "array"
917 }
918 },
919 "type": "object"
920 },
921 "SourceContext": {
922 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
923 "id": "SourceContext",
924 "properties": {
925 "fileName": {
926 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.",
927 "type": "string"
928 }
929 },
930 "type": "object"
931 },
932 "Endpoint": {
933 "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",
934 "id": "Endpoint",
935 "properties": {
936 "apis": {
937 "description": "The list of APIs served by this endpoint.",
938 "items": {
939 "type": "string"
940 },
941 "type": "array"
942 },
943 "aliases": {
944 "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.",
945 "items": {
946 "type": "string"
947 },
948 "type": "array"
949 },
950 "allowCors": {
951 "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.",
952 "type": "boolean"
953 },
954 "name": {
955 "description": "The canonical name of this endpoint.",
956 "type": "string"
957 },
958 "target": {
959 "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\".",
960 "type": "string"
961 },
962 "features": {
963 "description": "The list of features enabled on this endpoin t.",
964 "items": {
965 "type": "string"
966 },
967 "type": "array"
968 }
969 },
970 "type": "object"
971 },
972 "ListEnabledServicesResponse": {
973 "description": "Response message for `ListEnabledServices` method.",
974 "id": "ListEnabledServicesResponse",
975 "properties": {
976 "services": {
977 "description": "Services enabled for the specified parent.",
978 "items": {
979 "$ref": "PublishedService"
980 },
981 "type": "array"
982 },
983 "nextPageToken": {
984 "description": "Token that can be passed to `ListEnabledServ ices` to resume a paginated\nquery.",
985 "type": "string"
986 }
987 },
988 "type": "object"
989 },
990 "OAuthRequirements": {
991 "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.",
992 "id": "OAuthRequirements",
993 "properties": {
994 "canonicalScopes": {
995 "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 ",
996 "type": "string"
997 }
998 },
999 "type": "object"
1000 },
1001 "Usage": {
1002 "description": "Configuration controlling usage of a service.",
1003 "id": "Usage",
1004 "properties": {
1005 "producerNotificationChannel": {
1006 "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.",
1007 "type": "string"
1008 },
1009 "rules": {
1010 "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.",
1011 "items": {
1012 "$ref": "UsageRule"
1013 },
1014 "type": "array"
1015 },
1016 "requirements": {
1017 "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'.",
1018 "items": {
1019 "type": "string"
1020 },
1021 "type": "array"
1022 }
1023 },
1024 "type": "object"
1025 },
1026 "Context": {
1027 "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`.",
1028 "id": "Context",
1029 "properties": {
1030 "rules": {
1031 "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.",
1032 "items": {
1033 "$ref": "ContextRule"
1034 },
1035 "type": "array"
1036 }
1037 },
1038 "type": "object"
1039 },
1040 "LogDescriptor": {
1041 "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",
1042 "id": "LogDescriptor",
1043 "properties": {
1044 "name": {
1045 "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 [/_-.].",
1046 "type": "string"
1047 },
1048 "description": {
1049 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
1050 "type": "string"
1051 },
1052 "displayName": {
1053 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.",
1054 "type": "string"
1055 },
1056 "labels": {
1057 "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.",
1058 "items": {
1059 "$ref": "LabelDescriptor"
1060 },
1061 "type": "array"
1062 }
1063 },
1064 "type": "object"
1065 },
1066 "CustomErrorRule": {
1067 "description": "A custom error rule.",
1068 "id": "CustomErrorRule",
1069 "properties": {
1070 "selector": {
1071 "description": "Selects messages to which this rule applies. \n\nRefer to selector for syntax details.",
1072 "type": "string"
1073 },
1074 "isErrorType": {
1075 "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.",
1076 "type": "boolean"
1077 }
1078 },
1079 "type": "object"
1080 },
1081 "MonitoredResourceDescriptor": {
1082 "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.",
1083 "id": "MonitoredResourceDescriptor",
1084 "properties": {
1085 "name": {
1086 "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}\"`.",
1087 "type": "string"
1088 },
1089 "displayName": {
1090 "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\"`.",
1091 "type": "string"
1092 },
1093 "description": {
1094 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.",
1095 "type": "string"
1096 },
1097 "type": {
1098 "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.",
1099 "type": "string"
1100 },
1101 "labels": {
1102 "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\"`.",
1103 "items": {
1104 "$ref": "LabelDescriptor"
1105 },
1106 "type": "array"
1107 }
1108 },
1109 "type": "object"
1110 },
1111 "MediaDownload": {
1112 "description": "Use this only for Scotty Requests. Do not use this f or media support using\nBytestream, add instead [][google.bytestream.RestByteStr eam] as an API to\nyour configuration for Bytestream methods.",
1113 "id": "MediaDownload",
1114 "properties": {
1115 "enabled": {
1116 "description": "Whether download is enabled.",
1117 "type": "boolean"
1118 },
1119 "downloadService": {
1120 "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
1121 "type": "string"
1122 }
1123 },
1124 "type": "object"
1125 },
1126 "DisableServiceRequest": {
1127 "description": "Request message for DisableService method.",
1128 "id": "DisableServiceRequest",
1129 "properties": {},
1130 "type": "object"
1131 },
1132 "SearchServicesResponse": {
1133 "description": "Response message for SearchServices method.",
1134 "id": "SearchServicesResponse",
1135 "properties": {
1136 "services": {
1137 "description": "Services available publicly or available to the authenticated caller.",
1138 "items": {
1139 "$ref": "PublishedService"
1140 },
1141 "type": "array"
1142 },
1143 "nextPageToken": {
1144 "description": "Token that can be passed to `ListAvailableSe rvices` to resume a paginated\nquery.",
1145 "type": "string"
1146 }
1147 },
1148 "type": "object"
1149 },
1150 "MediaUpload": {
1151 "description": "Use this only for Scotty Requests. Do not use this f or media support using\nBytestream, add instead [][google.bytestream.RestByteStr eam] as an API to\nyour configuration for Bytestream methods.",
1152 "id": "MediaUpload",
1153 "properties": {
1154 "enabled": {
1155 "description": "Whether upload is enabled.",
1156 "type": "boolean"
1157 },
1158 "uploadService": {
1159 "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
1160 "type": "string"
1161 }
1162 },
1163 "type": "object"
1164 },
1165 "UsageRule": {
1166 "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",
1167 "id": "UsageRule",
1168 "properties": {
1169 "selector": {
1170 "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.",
1171 "type": "string"
1172 },
1173 "allowUnregisteredCalls": {
1174 "description": "True, if the method allows unregistered call s; false otherwise.",
1175 "type": "boolean"
1176 }
1177 },
1178 "type": "object"
1179 },
1180 "AuthRequirement": {
1181 "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).",
1182 "id": "AuthRequirement",
1183 "properties": {
1184 "audiences": {
1185 "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",
1186 "type": "string"
1187 },
1188 "providerId": {
1189 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
1190 "type": "string"
1191 }
1192 },
1193 "type": "object"
1194 },
1195 "Documentation": {
1196 "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.",
1197 "id": "Documentation",
1198 "properties": {
1199 "summary": {
1200 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
1201 "type": "string"
1202 },
1203 "documentationRootUrl": {
1204 "description": "The URL to the root of documentation.",
1205 "type": "string"
1206 },
1207 "rules": {
1208 "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.",
1209 "items": {
1210 "$ref": "DocumentationRule"
1211 },
1212 "type": "array"
1213 },
1214 "overview": {
1215 "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.",
1216 "type": "string"
1217 },
1218 "pages": {
1219 "description": "The top level pages for the documentation se t.",
1220 "items": {
1221 "$ref": "Page"
1222 },
1223 "type": "array"
1224 }
1225 },
1226 "type": "object"
1227 },
1228 "AuthenticationRule": {
1229 "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.",
1230 "id": "AuthenticationRule",
1231 "properties": {
1232 "requirements": {
1233 "description": "Requirements for additional authentication p roviders.",
1234 "items": {
1235 "$ref": "AuthRequirement"
1236 },
1237 "type": "array"
1238 },
1239 "selector": {
1240 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1241 "type": "string"
1242 },
1243 "allowWithoutCredential": {
1244 "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.",
1245 "type": "boolean"
1246 },
1247 "oauth": {
1248 "$ref": "OAuthRequirements",
1249 "description": "The requirements for OAuth credentials."
1250 }
1251 },
1252 "type": "object"
1253 },
1254 "BackendRule": {
1255 "description": "A backend rule provides configuration for an individ ual API element.",
1256 "id": "BackendRule",
1257 "properties": {
1258 "selector": {
1259 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1260 "type": "string"
1261 },
1262 "deadline": {
1263 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
1264 "format": "double",
1265 "type": "number"
1266 },
1267 "address": {
1268 "description": "The address of the API backend.",
1269 "type": "string"
1270 }
1271 },
1272 "type": "object"
1273 },
1274 "Api": {
1275 "description": "Api is a light-weight descriptor for a protocol buff er service.",
1276 "id": "Api",
1277 "properties": {
1278 "version": {
1279 "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",
1280 "type": "string"
1281 },
1282 "mixins": {
1283 "description": "Included APIs. See Mixin.",
1284 "items": {
1285 "$ref": "Mixin"
1286 },
1287 "type": "array"
1288 },
1289 "options": {
1290 "description": "Any metadata attached to the API.",
1291 "items": {
1292 "$ref": "Option"
1293 },
1294 "type": "array"
1295 },
1296 "methods": {
1297 "description": "The methods of this api, in unspecified orde r.",
1298 "items": {
1299 "$ref": "Method"
1300 },
1301 "type": "array"
1302 },
1303 "name": {
1304 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.",
1305 "type": "string"
1306 },
1307 "syntax": {
1308 "description": "The source syntax of the service.",
1309 "enum": [
1310 "SYNTAX_PROTO2",
1311 "SYNTAX_PROTO3"
1378 ], 1312 ],
1379 "enumDescriptions": [ 1313 "enumDescriptions": [
1380 "Syntax `proto2`.", 1314 "Syntax `proto2`.",
1381 "Syntax `proto3`." 1315 "Syntax `proto3`."
1382 ], 1316 ],
1383 "type": "string" 1317 "type": "string"
1384 }, 1318 },
1385 "sourceContext": { 1319 "sourceContext": {
1386 "$ref": "SourceContext", 1320 "$ref": "SourceContext",
1387 "description": "The source context." 1321 "description": "Source context for the protocol buffer servi ce represented by this\nmessage."
1388 } 1322 }
1389 }, 1323 },
1390 "type": "object" 1324 "type": "object"
1391 }, 1325 },
1392 "Experimental": { 1326 "MetricRule": {
1393 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.", 1327 "description": "Bind API methods to metrics. Binding a method to a m etric causes that\nmetric's configured quota, billing, and monitoring behaviors to apply to the\nmethod call.\n\nUsed by metric-based quotas only.",
1394 "id": "Experimental", 1328 "id": "MetricRule",
1395 "properties": { 1329 "properties": {
1396 "authorization": {
1397 "$ref": "AuthorizationConfig",
1398 "description": "Authorization configuration."
1399 }
1400 },
1401 "type": "object"
1402 },
1403 "Backend": {
1404 "description": "`Backend` defines the backend configuration for a se rvice.",
1405 "id": "Backend",
1406 "properties": {
1407 "rules": {
1408 "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.",
1409 "items": {
1410 "$ref": "BackendRule"
1411 },
1412 "type": "array"
1413 }
1414 },
1415 "type": "object"
1416 },
1417 "DocumentationRule": {
1418 "description": "A documentation rule provides information about indi vidual API elements.",
1419 "id": "DocumentationRule",
1420 "properties": {
1421 "selector": {
1422 "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.",
1423 "type": "string"
1424 },
1425 "description": {
1426 "description": "Description of the selected API(s).",
1427 "type": "string"
1428 },
1429 "deprecationDescription": {
1430 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.",
1431 "type": "string"
1432 }
1433 },
1434 "type": "object"
1435 },
1436 "AuthorizationConfig": {
1437 "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",
1438 "id": "AuthorizationConfig",
1439 "properties": {
1440 "provider": {
1441 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
1442 "type": "string"
1443 }
1444 },
1445 "type": "object"
1446 },
1447 "ContextRule": {
1448 "description": "A context rule provides information about the contex t for an individual API\nelement.",
1449 "id": "ContextRule",
1450 "properties": {
1451 "requested": {
1452 "description": "A list of full type names of requested conte xts.",
1453 "items": {
1454 "type": "string"
1455 },
1456 "type": "array"
1457 },
1458 "selector": { 1330 "selector": {
1459 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 1331 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1460 "type": "string" 1332 "type": "string"
1461 }, 1333 },
1462 "provided": { 1334 "metricCosts": {
1463 "description": "A list of full type names of provided contex ts.", 1335 "additionalProperties": {
1464 "items": { 1336 "format": "int64",
1465 "type": "string" 1337 "type": "string"
1466 }, 1338 },
1467 "type": "array" 1339 "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.",
1468 } 1340 "type": "object"
1469 }, 1341 }
1470 "type": "object" 1342 },
1471 }, 1343 "type": "object"
1472 "SourceContext": { 1344 },
1473 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.", 1345 "Authentication": {
1474 "id": "SourceContext", 1346 "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",
1475 "properties": { 1347 "id": "Authentication",
1476 "fileName": { 1348 "properties": {
1477 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.", 1349 "rules": {
1478 "type": "string" 1350 "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.",
1479 } 1351 "items": {
1480 }, 1352 "$ref": "AuthenticationRule"
1481 "type": "object" 1353 },
1482 }, 1354 "type": "array"
1483 "MetricDescriptor": { 1355 },
1484 "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.", 1356 "providers": {
1485 "id": "MetricDescriptor", 1357 "description": "Defines a set of authentication providers th at a service supports.",
1486 "properties": { 1358 "items": {
1487 "unit": { 1359 "$ref": "AuthProvider"
1488 "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 '}'.", 1360 },
1489 "type": "string" 1361 "type": "array"
1490 }, 1362 }
1491 "labels": { 1363 },
1492 "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.", 1364 "type": "object"
1493 "items": { 1365 },
1494 "$ref": "LabelDescriptor" 1366 "Operation": {
1495 }, 1367 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
1496 "type": "array" 1368 "id": "Operation",
1497 }, 1369 "properties": {
1498 "name": { 1370 "name": {
1499 "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\"", 1371 "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` .",
1500 "type": "string" 1372 "type": "string"
1501 }, 1373 },
1502 "type": { 1374 "error": {
1503 "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\"", 1375 "$ref": "Status",
1504 "type": "string" 1376 "description": "The error result of the operation in case of failure or cancellation."
1505 }, 1377 },
1506 "valueType": { 1378 "metadata": {
1507 "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.", 1379 "additionalProperties": {
1380 "description": "Properties of the object. Contains field @type with type URL.",
1381 "type": "any"
1382 },
1383 "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. ",
1384 "type": "object"
1385 },
1386 "done": {
1387 "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.",
1388 "type": "boolean"
1389 },
1390 "response": {
1391 "additionalProperties": {
1392 "description": "Properties of the object. Contains field @type with type URL.",
1393 "type": "any"
1394 },
1395 "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`.",
1396 "type": "object"
1397 }
1398 },
1399 "type": "object"
1400 },
1401 "Page": {
1402 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
1403 "id": "Page",
1404 "properties": {
1405 "name": {
1406 "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`.",
1407 "type": "string"
1408 },
1409 "content": {
1410 "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.",
1411 "type": "string"
1412 },
1413 "subpages": {
1414 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
1415 "items": {
1416 "$ref": "Page"
1417 },
1418 "type": "array"
1419 }
1420 },
1421 "type": "object"
1422 },
1423 "Status": {
1424 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
1425 "id": "Status",
1426 "properties": {
1427 "message": {
1428 "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.",
1429 "type": "string"
1430 },
1431 "details": {
1432 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1433 "items": {
1434 "additionalProperties": {
1435 "description": "Properties of the object. Contains f ield @type with type URL.",
1436 "type": "any"
1437 },
1438 "type": "object"
1439 },
1440 "type": "array"
1441 },
1442 "code": {
1443 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1444 "format": "int32",
1445 "type": "integer"
1446 }
1447 },
1448 "type": "object"
1449 },
1450 "AuthProvider": {
1451 "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).",
1452 "id": "AuthProvider",
1453 "properties": {
1454 "id": {
1455 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".",
1456 "type": "string"
1457 },
1458 "issuer": {
1459 "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",
1460 "type": "string"
1461 },
1462 "jwksUri": {
1463 "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",
1464 "type": "string"
1465 },
1466 "audiences": {
1467 "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",
1468 "type": "string"
1469 }
1470 },
1471 "type": "object"
1472 },
1473 "EnumValue": {
1474 "description": "Enum value definition.",
1475 "id": "EnumValue",
1476 "properties": {
1477 "number": {
1478 "description": "Enum value number.",
1479 "format": "int32",
1480 "type": "integer"
1481 },
1482 "name": {
1483 "description": "Enum value name.",
1484 "type": "string"
1485 },
1486 "options": {
1487 "description": "Protocol buffer options.",
1488 "items": {
1489 "$ref": "Option"
1490 },
1491 "type": "array"
1492 }
1493 },
1494 "type": "object"
1495 },
1496 "Service": {
1497 "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",
1498 "id": "Service",
1499 "properties": {
1500 "customError": {
1501 "$ref": "CustomError",
1502 "description": "Custom error configuration."
1503 },
1504 "title": {
1505 "description": "The product title associated with this servi ce.",
1506 "type": "string"
1507 },
1508 "endpoints": {
1509 "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.",
1510 "items": {
1511 "$ref": "Endpoint"
1512 },
1513 "type": "array"
1514 },
1515 "logs": {
1516 "description": "Defines the logs used by this service.",
1517 "items": {
1518 "$ref": "LogDescriptor"
1519 },
1520 "type": "array"
1521 },
1522 "apis": {
1523 "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.",
1524 "items": {
1525 "$ref": "Api"
1526 },
1527 "type": "array"
1528 },
1529 "types": {
1530 "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",
1531 "items": {
1532 "$ref": "Type"
1533 },
1534 "type": "array"
1535 },
1536 "sourceInfo": {
1537 "$ref": "SourceInfo",
1538 "description": "Output only. The source information for this configuration if available."
1539 },
1540 "http": {
1541 "$ref": "Http",
1542 "description": "HTTP configuration."
1543 },
1544 "systemParameters": {
1545 "$ref": "SystemParameters",
1546 "description": "System parameter configuration."
1547 },
1548 "backend": {
1549 "$ref": "Backend",
1550 "description": "API backend configuration."
1551 },
1552 "documentation": {
1553 "$ref": "Documentation",
1554 "description": "Additional API documentation."
1555 },
1556 "logging": {
1557 "$ref": "Logging",
1558 "description": "Logging configuration."
1559 },
1560 "monitoredResources": {
1561 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.",
1562 "items": {
1563 "$ref": "MonitoredResourceDescriptor"
1564 },
1565 "type": "array"
1566 },
1567 "enums": {
1568 "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",
1569 "items": {
1570 "$ref": "Enum"
1571 },
1572 "type": "array"
1573 },
1574 "context": {
1575 "$ref": "Context",
1576 "description": "Context configuration."
1577 },
1578 "id": {
1579 "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.",
1580 "type": "string"
1581 },
1582 "usage": {
1583 "$ref": "Usage",
1584 "description": "Configuration controlling usage of this serv ice."
1585 },
1586 "metrics": {
1587 "description": "Defines the metrics used by this service.",
1588 "items": {
1589 "$ref": "MetricDescriptor"
1590 },
1591 "type": "array"
1592 },
1593 "authentication": {
1594 "$ref": "Authentication",
1595 "description": "Auth configuration."
1596 },
1597 "experimental": {
1598 "$ref": "Experimental",
1599 "description": "Experimental configuration."
1600 },
1601 "control": {
1602 "$ref": "Control",
1603 "description": "Configuration for the service control plane. "
1604 },
1605 "configVersion": {
1606 "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`.",
1607 "format": "uint32",
1608 "type": "integer"
1609 },
1610 "monitoring": {
1611 "$ref": "Monitoring",
1612 "description": "Monitoring configuration."
1613 },
1614 "producerProjectId": {
1615 "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration, \nmanage consumption of the service, etc.",
1616 "type": "string"
1617 },
1618 "systemTypes": {
1619 "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.",
1620 "items": {
1621 "$ref": "Type"
1622 },
1623 "type": "array"
1624 },
1625 "visibility": {
1626 "$ref": "Visibility",
1627 "description": "API visibility configuration."
1628 },
1629 "quota": {
1630 "$ref": "Quota",
1631 "description": "Quota configuration."
1632 },
1633 "name": {
1634 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
1635 "type": "string"
1636 }
1637 },
1638 "type": "object"
1639 },
1640 "OperationMetadata": {
1641 "description": "The metadata associated with a long running operatio n resource.",
1642 "id": "OperationMetadata",
1643 "properties": {
1644 "startTime": {
1645 "description": "The start time of the operation.",
1646 "format": "google-datetime",
1647 "type": "string"
1648 },
1649 "resourceNames": {
1650 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
1651 "items": {
1652 "type": "string"
1653 },
1654 "type": "array"
1655 },
1656 "steps": {
1657 "description": "Detailed status information for each step. T he order is undetermined.",
1658 "items": {
1659 "$ref": "Step"
1660 },
1661 "type": "array"
1662 },
1663 "progressPercentage": {
1664 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
1665 "format": "int32",
1666 "type": "integer"
1667 }
1668 },
1669 "type": "object"
1670 },
1671 "CustomHttpPattern": {
1672 "description": "A custom pattern is used for defining custom HTTP ve rb.",
1673 "id": "CustomHttpPattern",
1674 "properties": {
1675 "path": {
1676 "description": "The path matched by this custom verb.",
1677 "type": "string"
1678 },
1679 "kind": {
1680 "description": "The name of this custom HTTP verb.",
1681 "type": "string"
1682 }
1683 },
1684 "type": "object"
1685 },
1686 "PublishedService": {
1687 "description": "The published version of a Service that is managed b y\nGoogle Service Management.",
1688 "id": "PublishedService",
1689 "properties": {
1690 "service": {
1691 "$ref": "Service",
1692 "description": "The service's published configuration."
1693 },
1694 "name": {
1695 "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
1696 "type": "string"
1697 }
1698 },
1699 "type": "object"
1700 },
1701 "SystemParameterRule": {
1702 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
1703 "id": "SystemParameterRule",
1704 "properties": {
1705 "parameters": {
1706 "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.",
1707 "items": {
1708 "$ref": "SystemParameter"
1709 },
1710 "type": "array"
1711 },
1712 "selector": {
1713 "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.",
1714 "type": "string"
1715 }
1716 },
1717 "type": "object"
1718 },
1719 "HttpRule": {
1720 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST APIs. The mapping determines what portions of the request \nmessage are populated from the path, query parameters, or body of\nthe HTTP re quest. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refe r to fields in the request\nmessage, as in the example below which describes a R EST GET\noperation on a resource collection of messages:\n\n\n service Messag ing {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n opti on (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n s tring subfield = 1;\n }\n string message_id = 1; // mapped to the URL\ n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n messag e Message {\n string text = 1; // content of the resource\n }\n\nThe sam e http annotation can alternatively be expressed inside the\n`GRPC API Configura tion` YAML file.\n\n http:\n rules:\n - selector: <proto_package_ name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfie ld}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `G etMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn gene ral, not only fields but also field paths can be referenced\nfrom a path pattern . Fields mapped to the path pattern cannot be\nrepeated and must have a primitiv e (non-message) type.\n\nAny fields in the request message which are not bound b y the path\npattern automatically become (optional) HTTP query\nparameters. Assu me the following definition of the request message:\n\n\n message GetMessageR equest {\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 sub = 3; // `sub.subfield` becomes a pa rameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMe ssage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\ nNote that fields which are mapped to HTTP parameters must have a\nprimitive typ e or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A&pa ram=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\ns pecifies the mapping. Consider a REST update method on the\nmessage resource col lection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequ est) returns (Message) {\n option (google.api.http) = {\n put: \ "/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mappe d 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(m essage_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path temp late should be mapped to the\nrequest body. This enables the following alternat ive definition of\nthe update method:\n\n service Messaging {\n rpc Upda teMessage(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 HTTP JSON to RPC mapping is enabled:\n\nHTT P | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateM essage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bo und by the path end in\nthe body. This makes this option more rarely used in pra ctice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhic h don't use the URL at all for transferring data.\n\nIt is possible to define mu ltiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Exam ple:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/ {user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nma ppings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(mess age_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for map ping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursi ve expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body fi eld)\n (c) All other fields.\n3. URL query parameters found in the HTTP reque st are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Templa te = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments . It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) S ection 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n \nThe syntax `Variable` matches the entire path as specified by its template;\nt his nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent t o `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not re fer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any H TTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card r ule is useful for services that provide\ncontent to Web (HTML) clients.",
1721 "id": "HttpRule",
1722 "properties": {
1723 "additionalBindings": {
1724 "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).",
1725 "items": {
1726 "$ref": "HttpRule"
1727 },
1728 "type": "array"
1729 },
1730 "responseBody": {
1731 "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.",
1732 "type": "string"
1733 },
1734 "mediaUpload": {
1735 "$ref": "MediaUpload",
1736 "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."
1737 },
1738 "selector": {
1739 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.",
1740 "type": "string"
1741 },
1742 "custom": {
1743 "$ref": "CustomHttpPattern",
1744 "description": "Custom pattern is used for defining custom v erbs."
1745 },
1746 "get": {
1747 "description": "Used for listing and getting information abo ut resources.",
1748 "type": "string"
1749 },
1750 "patch": {
1751 "description": "Used for updating a resource.",
1752 "type": "string"
1753 },
1754 "put": {
1755 "description": "Used for updating a resource.",
1756 "type": "string"
1757 },
1758 "delete": {
1759 "description": "Used for deleting a resource.",
1760 "type": "string"
1761 },
1762 "body": {
1763 "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.",
1764 "type": "string"
1765 },
1766 "post": {
1767 "description": "Used for creating a resource.",
1768 "type": "string"
1769 },
1770 "mediaDownload": {
1771 "$ref": "MediaDownload",
1772 "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."
1773 }
1774 },
1775 "type": "object"
1776 },
1777 "VisibilityRule": {
1778 "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
1779 "id": "VisibilityRule",
1780 "properties": {
1781 "selector": {
1782 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
1783 "type": "string"
1784 },
1785 "restriction": {
1786 "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.",
1787 "type": "string"
1788 }
1789 },
1790 "type": "object"
1791 },
1792 "MonitoringDestination": {
1793 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
1794 "id": "MonitoringDestination",
1795 "properties": {
1796 "monitoredResource": {
1797 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
1798 "type": "string"
1799 },
1800 "metrics": {
1801 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.",
1802 "items": {
1803 "type": "string"
1804 },
1805 "type": "array"
1806 }
1807 },
1808 "type": "object"
1809 },
1810 "Visibility": {
1811 "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.",
1812 "id": "Visibility",
1813 "properties": {
1814 "rules": {
1815 "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.",
1816 "items": {
1817 "$ref": "VisibilityRule"
1818 },
1819 "type": "array"
1820 }
1821 },
1822 "type": "object"
1823 },
1824 "SystemParameters": {
1825 "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.",
1826 "id": "SystemParameters",
1827 "properties": {
1828 "rules": {
1829 "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.",
1830 "items": {
1831 "$ref": "SystemParameterRule"
1832 },
1833 "type": "array"
1834 }
1835 },
1836 "type": "object"
1837 },
1838 "Quota": {
1839 "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",
1840 "id": "Quota",
1841 "properties": {
1842 "limits": {
1843 "description": "List of `QuotaLimit` definitions for the ser vice.\n\nUsed by metric-based quotas only.",
1844 "items": {
1845 "$ref": "QuotaLimit"
1846 },
1847 "type": "array"
1848 },
1849 "metricRules": {
1850 "description": "List of `MetricRule` definitions, each one m apping a selected method to one\nor more metrics.\n\nUsed by metric-based quotas only.",
1851 "items": {
1852 "$ref": "MetricRule"
1853 },
1854 "type": "array"
1855 }
1856 },
1857 "type": "object"
1858 },
1859 "Step": {
1860 "description": "Represents the status of one operation step.",
1861 "id": "Step",
1862 "properties": {
1863 "status": {
1864 "description": "The status code.",
1508 "enum": [ 1865 "enum": [
1509 "VALUE_TYPE_UNSPECIFIED", 1866 "STATUS_UNSPECIFIED",
1510 "BOOL", 1867 "DONE",
1511 "INT64", 1868 "NOT_STARTED",
1512 "DOUBLE", 1869 "IN_PROGRESS",
1513 "STRING", 1870 "FAILED",
1514 "DISTRIBUTION", 1871 "CANCELLED"
1515 "MONEY"
1516 ], 1872 ],
1517 "enumDescriptions": [ 1873 "enumDescriptions": [
1518 "Do not use this default value.", 1874 "Unspecifed code.",
1519 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.", 1875 "The operation or step has completed without errors.",
1520 "The value is a signed 64-bit integer.", 1876 "The operation or step has not started yet.",
1521 "The value is a double precision floating point number." , 1877 "The operation or step is in progress.",
1522 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.", 1878 "The operation or step has completed with errors.",
1523 "The value is a `Distribution`.", 1879 "The operation or step has completed with cancellation."
1524 "The value is money."
1525 ], 1880 ],
1526 "type": "string" 1881 "type": "string"
1527 }, 1882 },
1528 "metricKind": {
1529 "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.",
1530 "enum": [
1531 "METRIC_KIND_UNSPECIFIED",
1532 "GAUGE",
1533 "DELTA",
1534 "CUMULATIVE"
1535 ],
1536 "enumDescriptions": [
1537 "Do not use this default value.",
1538 "An instantaneous measurement of a value.",
1539 "The change in a value during a time interval.",
1540 "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."
1541 ],
1542 "type": "string"
1543 },
1544 "description": { 1883 "description": {
1545 "description": "A detailed description of the metric, which can be used in documentation.", 1884 "description": "The short description of the step.",
1546 "type": "string" 1885 "type": "string"
1547 }, 1886 }
1548 "displayName": { 1887 },
1549 "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\".",
1550 "type": "string"
1551 }
1552 },
1553 "type": "object"
1554 },
1555 "ListEnabledServicesResponse": {
1556 "description": "Response message for `ListEnabledServices` method.",
1557 "id": "ListEnabledServicesResponse",
1558 "properties": {
1559 "services": {
1560 "description": "Services enabled for the specified parent.",
1561 "items": {
1562 "$ref": "PublishedService"
1563 },
1564 "type": "array"
1565 },
1566 "nextPageToken": {
1567 "description": "Token that can be passed to `ListEnabledServ ices` to resume a paginated\nquery.",
1568 "type": "string"
1569 }
1570 },
1571 "type": "object"
1572 },
1573 "Endpoint": {
1574 "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",
1575 "id": "Endpoint",
1576 "properties": {
1577 "aliases": {
1578 "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.",
1579 "items": {
1580 "type": "string"
1581 },
1582 "type": "array"
1583 },
1584 "features": {
1585 "description": "The list of features enabled on this endpoin t.",
1586 "items": {
1587 "type": "string"
1588 },
1589 "type": "array"
1590 },
1591 "allowCors": {
1592 "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.",
1593 "type": "boolean"
1594 },
1595 "name": {
1596 "description": "The canonical name of this endpoint.",
1597 "type": "string"
1598 },
1599 "apis": {
1600 "description": "The list of APIs served by this endpoint.",
1601 "items": {
1602 "type": "string"
1603 },
1604 "type": "array"
1605 }
1606 },
1607 "type": "object"
1608 },
1609 "OAuthRequirements": {
1610 "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.",
1611 "id": "OAuthRequirements",
1612 "properties": {
1613 "canonicalScopes": {
1614 "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 ",
1615 "type": "string"
1616 }
1617 },
1618 "type": "object"
1619 },
1620 "Usage": {
1621 "description": "Configuration controlling usage of a service.",
1622 "id": "Usage",
1623 "properties": {
1624 "rules": {
1625 "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.",
1626 "items": {
1627 "$ref": "UsageRule"
1628 },
1629 "type": "array"
1630 },
1631 "requirements": {
1632 "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'.",
1633 "items": {
1634 "type": "string"
1635 },
1636 "type": "array"
1637 },
1638 "producerNotificationChannel": {
1639 "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.",
1640 "type": "string"
1641 }
1642 },
1643 "type": "object"
1644 },
1645 "Context": {
1646 "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`.",
1647 "id": "Context",
1648 "properties": {
1649 "rules": {
1650 "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.",
1651 "items": {
1652 "$ref": "ContextRule"
1653 },
1654 "type": "array"
1655 }
1656 },
1657 "type": "object"
1658 },
1659 "LogDescriptor": {
1660 "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",
1661 "id": "LogDescriptor",
1662 "properties": {
1663 "labels": {
1664 "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.",
1665 "items": {
1666 "$ref": "LabelDescriptor"
1667 },
1668 "type": "array"
1669 },
1670 "name": {
1671 "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 [/_-.].",
1672 "type": "string"
1673 },
1674 "description": {
1675 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
1676 "type": "string"
1677 },
1678 "displayName": {
1679 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.",
1680 "type": "string"
1681 }
1682 },
1683 "type": "object"
1684 },
1685 "MonitoredResourceDescriptor": {
1686 "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.",
1687 "id": "MonitoredResourceDescriptor",
1688 "properties": {
1689 "labels": {
1690 "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\"`.",
1691 "items": {
1692 "$ref": "LabelDescriptor"
1693 },
1694 "type": "array"
1695 },
1696 "name": {
1697 "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}\"`.",
1698 "type": "string"
1699 },
1700 "displayName": {
1701 "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\"`.",
1702 "type": "string"
1703 },
1704 "description": {
1705 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.",
1706 "type": "string"
1707 },
1708 "type": {
1709 "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.",
1710 "type": "string"
1711 }
1712 },
1713 "type": "object"
1714 },
1715 "CustomErrorRule": {
1716 "description": "A custom error rule.",
1717 "id": "CustomErrorRule",
1718 "properties": {
1719 "isErrorType": {
1720 "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.",
1721 "type": "boolean"
1722 },
1723 "selector": {
1724 "description": "Selects messages to which this rule applies. \n\nRefer to selector for syntax details.",
1725 "type": "string"
1726 }
1727 },
1728 "type": "object"
1729 },
1730 "MediaDownload": {
1731 "description": "Use this only for Scotty Requests. Do not use this f or media support using\nBytestream, add instead [][google.bytestream.RestByteStr eam] as an API to\nyour configuration for Bytestream methods.",
1732 "id": "MediaDownload",
1733 "properties": {
1734 "enabled": {
1735 "description": "Whether download is enabled.",
1736 "type": "boolean"
1737 },
1738 "downloadService": {
1739 "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
1740 "type": "string"
1741 }
1742 },
1743 "type": "object"
1744 },
1745 "DisableServiceRequest": {
1746 "description": "Request message for DisableService method.",
1747 "id": "DisableServiceRequest",
1748 "properties": {},
1749 "type": "object"
1750 },
1751 "SearchServicesResponse": {
1752 "description": "Response message for SearchServices method.",
1753 "id": "SearchServicesResponse",
1754 "properties": {
1755 "services": {
1756 "description": "Services available publicly or available to the authenticated caller.",
1757 "items": {
1758 "$ref": "PublishedService"
1759 },
1760 "type": "array"
1761 },
1762 "nextPageToken": {
1763 "description": "Token that can be passed to `ListAvailableSe rvices` to resume a paginated\nquery.",
1764 "type": "string"
1765 }
1766 },
1767 "type": "object"
1768 },
1769 "MediaUpload": {
1770 "description": "Use this only for Scotty Requests. Do not use this f or media support using\nBytestream, add instead [][google.bytestream.RestByteStr eam] as an API to\nyour configuration for Bytestream methods.",
1771 "id": "MediaUpload",
1772 "properties": {
1773 "enabled": {
1774 "description": "Whether upload is enabled.",
1775 "type": "boolean"
1776 },
1777 "uploadService": {
1778 "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
1779 "type": "string"
1780 }
1781 },
1782 "type": "object" 1888 "type": "object"
1783 } 1889 }
1784 }, 1890 },
1785 "servicePath": "", 1891 "servicePath": "",
1786 "title": "Google Service User API", 1892 "title": "Google Service User API",
1787 "version": "v1" 1893 "version": "v1"
1788 } 1894 }
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