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