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