OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/servicecontrol": { |
| 6 "description": "Manage your Google Service Control data" |
| 7 }, |
5 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | |
8 "https://www.googleapis.com/auth/servicecontrol": { | |
9 "description": "Manage your Google Service Control data" | |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://servicecontrol.googleapis.com/", | 15 "baseUrl": "https://servicecontrol.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Service Control", | 17 "canonicalName": "Service Control", |
18 "description": "Google Service Control provides control plane functionality
to managed services, such as logging, monitoring, and status checks.", | 18 "description": "Google Service Control provides control plane functionality
to managed services, such as logging, monitoring, and status checks.", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://cloud.google.com/service-control/", | 20 "documentationLink": "https://cloud.google.com/service-control/", |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "servicecontrol:v1", | 25 "id": "servicecontrol:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "servicecontrol", | 27 "name": "servicecontrol", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
| 31 "uploadType": { |
| 32 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "fields": { |
| 37 "description": "Selector specifying which fields to include in a par
tial response.", |
| 38 "location": "query", |
| 39 "type": "string" |
| 40 }, |
31 "$.xgafv": { | 41 "$.xgafv": { |
32 "description": "V1 error format.", | 42 "description": "V1 error format.", |
33 "enum": [ | 43 "enum": [ |
34 "1", | 44 "1", |
35 "2" | 45 "2" |
36 ], | 46 ], |
37 "enumDescriptions": [ | 47 "enumDescriptions": [ |
38 "v1 error format", | 48 "v1 error format", |
39 "v2 error format" | 49 "v2 error format" |
40 ], | 50 ], |
(...skipping 14 matching lines...) Expand all Loading... |
55 "proto" | 65 "proto" |
56 ], | 66 ], |
57 "enumDescriptions": [ | 67 "enumDescriptions": [ |
58 "Responses with Content-Type of application/json", | 68 "Responses with Content-Type of application/json", |
59 "Media download with context-dependent Content-Type", | 69 "Media download with context-dependent Content-Type", |
60 "Responses with Content-Type of application/x-protobuf" | 70 "Responses with Content-Type of application/x-protobuf" |
61 ], | 71 ], |
62 "location": "query", | 72 "location": "query", |
63 "type": "string" | 73 "type": "string" |
64 }, | 74 }, |
| 75 "access_token": { |
| 76 "description": "OAuth access token.", |
| 77 "location": "query", |
| 78 "type": "string" |
| 79 }, |
65 "key": { | 80 "key": { |
66 "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.", | 81 "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.", |
67 "location": "query", | 82 "location": "query", |
68 "type": "string" | 83 "type": "string" |
69 }, | 84 }, |
70 "access_token": { | |
71 "description": "OAuth access token.", | |
72 "location": "query", | |
73 "type": "string" | |
74 }, | |
75 "quotaUser": { | 85 "quotaUser": { |
76 "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.", | 86 "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.", |
77 "location": "query", | 87 "location": "query", |
78 "type": "string" | 88 "type": "string" |
79 }, | 89 }, |
80 "pp": { | 90 "pp": { |
81 "default": "true", | 91 "default": "true", |
82 "description": "Pretty-print response.", | 92 "description": "Pretty-print response.", |
83 "location": "query", | 93 "location": "query", |
84 "type": "boolean" | 94 "type": "boolean" |
(...skipping 11 matching lines...) Expand all Loading... |
96 "upload_protocol": { | 106 "upload_protocol": { |
97 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
98 "location": "query", | 108 "location": "query", |
99 "type": "string" | 109 "type": "string" |
100 }, | 110 }, |
101 "prettyPrint": { | 111 "prettyPrint": { |
102 "default": "true", | 112 "default": "true", |
103 "description": "Returns response with indentations and line breaks."
, | 113 "description": "Returns response with indentations and line breaks."
, |
104 "location": "query", | 114 "location": "query", |
105 "type": "boolean" | 115 "type": "boolean" |
106 }, | |
107 "uploadType": { | |
108 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
109 "location": "query", | |
110 "type": "string" | |
111 }, | |
112 "fields": { | |
113 "description": "Selector specifying which fields to include in a par
tial response.", | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "services": { | 120 "services": { |
121 "methods": { | 121 "methods": { |
122 "endReconciliation": { | 122 "check": { |
123 "description": "Signals the quota controller that service en
ds the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanage
ment.services.quota`\npermission on the specified service. For more information,
see\n[Google Cloud IAM](https://cloud.google.com/iam).", | 123 "description": "Checks an operation with Google Service Cont
rol to decide whether\nthe given operation should proceed. It should be called b
efore the\noperation is executed.\n\nIf feasible, the client should cache the ch
eck results and reuse them for\n60 seconds. In case of server errors, the client
can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` ha
s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service
s.check` permission\non the specified service. For more information, see\n[Googl
e Cloud IAM](https://cloud.google.com/iam).", |
124 "httpMethod": "POST", | 124 "httpMethod": "POST", |
125 "id": "servicecontrol.services.endReconciliation", | 125 "id": "servicecontrol.services.check", |
| 126 "parameterOrder": [ |
| 127 "serviceName" |
| 128 ], |
| 129 "parameters": { |
| 130 "serviceName": { |
| 131 "description": "The service name as specified in its
service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google
.api.Service for the definition of a service name.", |
| 132 "location": "path", |
| 133 "required": true, |
| 134 "type": "string" |
| 135 } |
| 136 }, |
| 137 "path": "v1/services/{serviceName}:check", |
| 138 "request": { |
| 139 "$ref": "CheckRequest" |
| 140 }, |
| 141 "response": { |
| 142 "$ref": "CheckResponse" |
| 143 }, |
| 144 "scopes": [ |
| 145 "https://www.googleapis.com/auth/cloud-platform", |
| 146 "https://www.googleapis.com/auth/servicecontrol" |
| 147 ] |
| 148 }, |
| 149 "releaseQuota": { |
| 150 "description": "Releases previously allocated quota done thr
ough AllocateQuota method.\n\nThis method requires the `servicemanagement.servic
es.quota`\npermission on the specified service. For more information, see\n[Goog
le Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must
** fail-open if the server returns one\nof the following quota errors:\n- `PRO
JECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_
UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above erro
rs to prohibit any hard dependency\non the quota system.", |
| 151 "httpMethod": "POST", |
| 152 "id": "servicecontrol.services.releaseQuota", |
126 "parameterOrder": [ | 153 "parameterOrder": [ |
127 "serviceName" | 154 "serviceName" |
128 ], | 155 ], |
129 "parameters": { | 156 "parameters": { |
130 "serviceName": { | 157 "serviceName": { |
131 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", | 158 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
132 "location": "path", | 159 "location": "path", |
133 "required": true, | 160 "required": true, |
134 "type": "string" | 161 "type": "string" |
135 } | 162 } |
136 }, | 163 }, |
137 "path": "v1/services/{serviceName}:endReconciliation", | 164 "path": "v1/services/{serviceName}:releaseQuota", |
138 "request": { | 165 "request": { |
139 "$ref": "EndReconciliationRequest" | 166 "$ref": "ReleaseQuotaRequest" |
140 }, | 167 }, |
141 "response": { | 168 "response": { |
142 "$ref": "EndReconciliationResponse" | 169 "$ref": "ReleaseQuotaResponse" |
143 }, | 170 }, |
144 "scopes": [ | 171 "scopes": [ |
145 "https://www.googleapis.com/auth/cloud-platform", | 172 "https://www.googleapis.com/auth/cloud-platform", |
146 "https://www.googleapis.com/auth/servicecontrol" | 173 "https://www.googleapis.com/auth/servicecontrol" |
147 ] | 174 ] |
148 }, | 175 }, |
149 "report": { | 176 "endReconciliation": { |
150 "description": "Reports operation results to Google Service
Control, such as logs and\nmetrics. It should be called after an operation is co
mpleted.\n\nIf feasible, the client should aggregate reporting data for up to 5\
nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce
data loss during client crashes. Clients should carefully choose\nthe aggregatio
n time window to avoid data loss risk more than 0.01%\nfor business and complian
ce reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis meth
od requires the `servicemanagement.services.report` permission\non the specified
service. For more information, see\n[Google Cloud IAM](https://cloud.google.com
/iam).", | 177 "description": "Signals the quota controller that service en
ds the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanage
ment.services.quota`\npermission on the specified service. For more information,
see\n[Google Cloud IAM](https://cloud.google.com/iam).", |
151 "httpMethod": "POST", | 178 "httpMethod": "POST", |
152 "id": "servicecontrol.services.report", | 179 "id": "servicecontrol.services.endReconciliation", |
153 "parameterOrder": [ | 180 "parameterOrder": [ |
154 "serviceName" | 181 "serviceName" |
155 ], | 182 ], |
156 "parameters": { | |
157 "serviceName": { | |
158 "description": "The service name as specified in its
service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google
.api.Service for the definition of a service name.", | |
159 "location": "path", | |
160 "required": true, | |
161 "type": "string" | |
162 } | |
163 }, | |
164 "path": "v1/services/{serviceName}:report", | |
165 "request": { | |
166 "$ref": "ReportRequest" | |
167 }, | |
168 "response": { | |
169 "$ref": "ReportResponse" | |
170 }, | |
171 "scopes": [ | |
172 "https://www.googleapis.com/auth/cloud-platform", | |
173 "https://www.googleapis.com/auth/servicecontrol" | |
174 ] | |
175 }, | |
176 "allocateQuota": { | |
177 "description": "Attempts to allocate quota for the specified
consumer. It should be called\nbefore the operation is executed.\n\nThis method
requires the `servicemanagement.services.quota`\npermission on the specified se
rvice. For more information, see\n[Google Cloud IAM](https://cloud.google.com/ia
m).\n\n**NOTE:** the client code **must** fail-open if the server returns one\no
f the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_ST
ATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILAB
LE`\n\nThe server may inject above errors to prohibit any hard dependency\non th
e quota system.", | |
178 "httpMethod": "POST", | |
179 "id": "servicecontrol.services.allocateQuota", | |
180 "parameterOrder": [ | |
181 "serviceName" | |
182 ], | |
183 "parameters": { | 183 "parameters": { |
184 "serviceName": { | 184 "serviceName": { |
185 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", | 185 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
186 "location": "path", | 186 "location": "path", |
187 "required": true, | 187 "required": true, |
188 "type": "string" | 188 "type": "string" |
189 } | 189 } |
190 }, | 190 }, |
| 191 "path": "v1/services/{serviceName}:endReconciliation", |
| 192 "request": { |
| 193 "$ref": "EndReconciliationRequest" |
| 194 }, |
| 195 "response": { |
| 196 "$ref": "EndReconciliationResponse" |
| 197 }, |
| 198 "scopes": [ |
| 199 "https://www.googleapis.com/auth/cloud-platform", |
| 200 "https://www.googleapis.com/auth/servicecontrol" |
| 201 ] |
| 202 }, |
| 203 "report": { |
| 204 "description": "Reports operation results to Google Service
Control, such as logs and\nmetrics. It should be called after an operation is co
mpleted.\n\nIf feasible, the client should aggregate reporting data for up to 5\
nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce
data loss during client crashes. Clients should carefully choose\nthe aggregatio
n time window to avoid data loss risk more than 0.01%\nfor business and complian
ce reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis meth
od requires the `servicemanagement.services.report` permission\non the specified
service. For more information, see\n[Google Cloud IAM](https://cloud.google.com
/iam).", |
| 205 "httpMethod": "POST", |
| 206 "id": "servicecontrol.services.report", |
| 207 "parameterOrder": [ |
| 208 "serviceName" |
| 209 ], |
| 210 "parameters": { |
| 211 "serviceName": { |
| 212 "description": "The service name as specified in its
service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google
.api.Service for the definition of a service name.", |
| 213 "location": "path", |
| 214 "required": true, |
| 215 "type": "string" |
| 216 } |
| 217 }, |
| 218 "path": "v1/services/{serviceName}:report", |
| 219 "request": { |
| 220 "$ref": "ReportRequest" |
| 221 }, |
| 222 "response": { |
| 223 "$ref": "ReportResponse" |
| 224 }, |
| 225 "scopes": [ |
| 226 "https://www.googleapis.com/auth/cloud-platform", |
| 227 "https://www.googleapis.com/auth/servicecontrol" |
| 228 ] |
| 229 }, |
| 230 "allocateQuota": { |
| 231 "description": "Attempts to allocate quota for the specified
consumer. It should be called\nbefore the operation is executed.\n\nThis method
requires the `servicemanagement.services.quota`\npermission on the specified se
rvice. For more information, see\n[Google Cloud IAM](https://cloud.google.com/ia
m).\n\n**NOTE:** the client code **must** fail-open if the server returns one\no
f the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_ST
ATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILAB
LE`\n\nThe server may inject above errors to prohibit any hard dependency\non th
e quota system.", |
| 232 "httpMethod": "POST", |
| 233 "id": "servicecontrol.services.allocateQuota", |
| 234 "parameterOrder": [ |
| 235 "serviceName" |
| 236 ], |
| 237 "parameters": { |
| 238 "serviceName": { |
| 239 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
| 240 "location": "path", |
| 241 "required": true, |
| 242 "type": "string" |
| 243 } |
| 244 }, |
191 "path": "v1/services/{serviceName}:allocateQuota", | 245 "path": "v1/services/{serviceName}:allocateQuota", |
192 "request": { | 246 "request": { |
193 "$ref": "AllocateQuotaRequest" | 247 "$ref": "AllocateQuotaRequest" |
194 }, | 248 }, |
195 "response": { | 249 "response": { |
196 "$ref": "AllocateQuotaResponse" | 250 "$ref": "AllocateQuotaResponse" |
197 }, | 251 }, |
198 "scopes": [ | 252 "scopes": [ |
199 "https://www.googleapis.com/auth/cloud-platform", | 253 "https://www.googleapis.com/auth/cloud-platform", |
200 "https://www.googleapis.com/auth/servicecontrol" | 254 "https://www.googleapis.com/auth/servicecontrol" |
201 ] | 255 ] |
202 }, | 256 }, |
203 "startReconciliation": { | 257 "startReconciliation": { |
204 "description": "Unlike rate quota, allocation quota does not
get refilled periodically.\nSo, it is possible that the quota usage as seen by
the service differs from\nwhat the One Platform considers the usage is. This is
expected to happen\nonly rarely, but over time this can accumulate. Services can
invoke\nStartReconciliation and EndReconciliation to correct this usage drift,
as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in f
uture for each\n metric that needs to be reconciled. The timestamp being in fu
ture allows\n to account for in-flight AllocateQuota and ReleaseQuota requests
for the\n same metric.\n2. One Platform records this timestamp and starts tra
cking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconcilia
tion is\n called.\n3. At or after the time specified in the StartReconciliatio
n, service\n sends EndReconciliation with the usage that needs to be reconcile
d to.\n4. One Platform adjusts its own record of usage for that metric to the\n
value specified in EndReconciliation by taking in to account any\n allocatio
n or release between StartReconciliation and EndReconciliation.\n\nSignals the q
uota controller that the service wants to perform a usage\nreconciliation as spe
cified in the request.\n\nThis method requires the `servicemanagement.services.q
uota`\npermission on the specified service. For more information, see\n[Google C
loud IAM](https://cloud.google.com/iam).", | 258 "description": "Unlike rate quota, allocation quota does not
get refilled periodically.\nSo, it is possible that the quota usage as seen by
the service differs from\nwhat the One Platform considers the usage is. This is
expected to happen\nonly rarely, but over time this can accumulate. Services can
invoke\nStartReconciliation and EndReconciliation to correct this usage drift,
as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in f
uture for each\n metric that needs to be reconciled. The timestamp being in fu
ture allows\n to account for in-flight AllocateQuota and ReleaseQuota requests
for the\n same metric.\n2. One Platform records this timestamp and starts tra
cking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconcilia
tion is\n called.\n3. At or after the time specified in the StartReconciliatio
n, service\n sends EndReconciliation with the usage that needs to be reconcile
d to.\n4. One Platform adjusts its own record of usage for that metric to the\n
value specified in EndReconciliation by taking in to account any\n allocatio
n or release between StartReconciliation and EndReconciliation.\n\nSignals the q
uota controller that the service wants to perform a usage\nreconciliation as spe
cified in the request.\n\nThis method requires the `servicemanagement.services.q
uota`\npermission on the specified service. For more information, see\n[Google C
loud IAM](https://cloud.google.com/iam).", |
205 "httpMethod": "POST", | 259 "httpMethod": "POST", |
206 "id": "servicecontrol.services.startReconciliation", | 260 "id": "servicecontrol.services.startReconciliation", |
207 "parameterOrder": [ | 261 "parameterOrder": [ |
208 "serviceName" | 262 "serviceName" |
209 ], | 263 ], |
210 "parameters": { | |
211 "serviceName": { | |
212 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", | |
213 "location": "path", | |
214 "required": true, | |
215 "type": "string" | |
216 } | |
217 }, | |
218 "path": "v1/services/{serviceName}:startReconciliation", | |
219 "request": { | |
220 "$ref": "StartReconciliationRequest" | |
221 }, | |
222 "response": { | |
223 "$ref": "StartReconciliationResponse" | |
224 }, | |
225 "scopes": [ | |
226 "https://www.googleapis.com/auth/cloud-platform", | |
227 "https://www.googleapis.com/auth/servicecontrol" | |
228 ] | |
229 }, | |
230 "check": { | |
231 "description": "Checks an operation with Google Service Cont
rol to decide whether\nthe given operation should proceed. It should be called b
efore the\noperation is executed.\n\nIf feasible, the client should cache the ch
eck results and reuse them for\n60 seconds. In case of server errors, the client
can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` ha
s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service
s.check` permission\non the specified service. For more information, see\n[Googl
e Cloud IAM](https://cloud.google.com/iam).", | |
232 "httpMethod": "POST", | |
233 "id": "servicecontrol.services.check", | |
234 "parameterOrder": [ | |
235 "serviceName" | |
236 ], | |
237 "parameters": { | |
238 "serviceName": { | |
239 "description": "The service name as specified in its
service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google
.api.Service for the definition of a service name.", | |
240 "location": "path", | |
241 "required": true, | |
242 "type": "string" | |
243 } | |
244 }, | |
245 "path": "v1/services/{serviceName}:check", | |
246 "request": { | |
247 "$ref": "CheckRequest" | |
248 }, | |
249 "response": { | |
250 "$ref": "CheckResponse" | |
251 }, | |
252 "scopes": [ | |
253 "https://www.googleapis.com/auth/cloud-platform", | |
254 "https://www.googleapis.com/auth/servicecontrol" | |
255 ] | |
256 }, | |
257 "releaseQuota": { | |
258 "description": "Releases previously allocated quota done thr
ough AllocateQuota method.\n\nThis method requires the `servicemanagement.servic
es.quota`\npermission on the specified service. For more information, see\n[Goog
le Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must
** fail-open if the server returns one\nof the following quota errors:\n- `PRO
JECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_
UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above erro
rs to prohibit any hard dependency\non the quota system.", | |
259 "httpMethod": "POST", | |
260 "id": "servicecontrol.services.releaseQuota", | |
261 "parameterOrder": [ | |
262 "serviceName" | |
263 ], | |
264 "parameters": { | 264 "parameters": { |
265 "serviceName": { | 265 "serviceName": { |
266 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", | 266 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
267 "location": "path", | 267 "location": "path", |
268 "required": true, | 268 "required": true, |
269 "type": "string" | 269 "type": "string" |
270 } | 270 } |
271 }, | 271 }, |
272 "path": "v1/services/{serviceName}:releaseQuota", | 272 "path": "v1/services/{serviceName}:startReconciliation", |
273 "request": { | 273 "request": { |
274 "$ref": "ReleaseQuotaRequest" | 274 "$ref": "StartReconciliationRequest" |
275 }, | 275 }, |
276 "response": { | 276 "response": { |
277 "$ref": "ReleaseQuotaResponse" | 277 "$ref": "StartReconciliationResponse" |
278 }, | 278 }, |
279 "scopes": [ | 279 "scopes": [ |
280 "https://www.googleapis.com/auth/cloud-platform", | 280 "https://www.googleapis.com/auth/cloud-platform", |
281 "https://www.googleapis.com/auth/servicecontrol" | 281 "https://www.googleapis.com/auth/servicecontrol" |
282 ] | 282 ] |
283 } | 283 } |
284 } | 284 } |
285 } | 285 } |
286 }, | 286 }, |
287 "revision": "20170626", | 287 "revision": "20170724", |
288 "rootUrl": "https://servicecontrol.googleapis.com/", | 288 "rootUrl": "https://servicecontrol.googleapis.com/", |
289 "schemas": { | 289 "schemas": { |
290 "CheckResponse": { | 290 "Money": { |
291 "description": "Response message for the Check method.", | 291 "description": "Represents an amount of money with its currency type
.", |
292 "id": "CheckResponse", | 292 "id": "Money", |
293 "properties": { | 293 "properties": { |
294 "checkInfo": { | 294 "nanos": { |
295 "$ref": "CheckInfo", | 295 "description": "Number of nano (10^-9) units of the amount.\
nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units`
is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can
be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negativ
e or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000
,000.", |
296 "description": "Feedback data returned from the server durin
g processing a Check request." | |
297 }, | |
298 "checkErrors": { | |
299 "description": "Indicate the decision of the check.\n\nIf no
check errors are present, the service should process the operation.\nOtherwise
the service should use the list of errors to determine the\nappropriate action."
, | |
300 "items": { | |
301 "$ref": "CheckError" | |
302 }, | |
303 "type": "array" | |
304 }, | |
305 "operationId": { | |
306 "description": "The same operation_id value used in the Chec
kRequest.\nUsed for logging and diagnostics purposes.", | |
307 "type": "string" | |
308 }, | |
309 "serviceConfigId": { | |
310 "description": "The actual config id used to process the req
uest.", | |
311 "type": "string" | |
312 }, | |
313 "quotaInfo": { | |
314 "$ref": "QuotaInfo", | |
315 "description": "Quota information for the check request asso
ciated with this response.\n" | |
316 } | |
317 }, | |
318 "type": "object" | |
319 }, | |
320 "ReportRequest": { | |
321 "description": "Request message for the Report method.", | |
322 "id": "ReportRequest", | |
323 "properties": { | |
324 "serviceConfigId": { | |
325 "description": "Specifies which version of service config sh
ould be used to process the\nrequest.\n\nIf unspecified or no matching version c
an be found, the\nlatest one will be used.", | |
326 "type": "string" | |
327 }, | |
328 "operations": { | |
329 "description": "Operations to be reported.\n\nTypically the
service should report one operation per request.\nPutting multiple operations in
to a single request is allowed, but should\nbe used only when multiple operation
s are natually available at the time\nof the report.\n\nIf multiple operations a
re in a single request, the total request size\nshould be no larger than 1MB. Se
e ReportResponse.report_errors for\npartial failure behavior.", | |
330 "items": { | |
331 "$ref": "Operation" | |
332 }, | |
333 "type": "array" | |
334 } | |
335 }, | |
336 "type": "object" | |
337 }, | |
338 "Status": { | |
339 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | |
340 "id": "Status", | |
341 "properties": { | |
342 "details": { | |
343 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
344 "items": { | |
345 "additionalProperties": { | |
346 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
347 "type": "any" | |
348 }, | |
349 "type": "object" | |
350 }, | |
351 "type": "array" | |
352 }, | |
353 "code": { | |
354 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
355 "format": "int32", | 296 "format": "int32", |
356 "type": "integer" | 297 "type": "integer" |
357 }, | 298 }, |
358 "message": { | 299 "units": { |
359 "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.", | 300 "description": "The whole units of the amount.\nFor example
if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", |
360 "type": "string" | 301 "format": "int64", |
361 } | 302 "type": "string" |
362 }, | 303 }, |
363 "type": "object" | 304 "currencyCode": { |
364 }, | 305 "description": "The 3-letter currency code defined in ISO 42
17.", |
365 "LogEntry": { | 306 "type": "string" |
366 "description": "An individual log entry.", | 307 } |
367 "id": "LogEntry", | 308 }, |
368 "properties": { | 309 "type": "object" |
369 "labels": { | 310 }, |
| 311 "EndReconciliationResponse": { |
| 312 "id": "EndReconciliationResponse", |
| 313 "properties": { |
| 314 "quotaMetrics": { |
| 315 "description": "Metric values as tracked by One Platform bef
ore the adjustment was made.\nThe following metrics will be included:\n\n1. Per
quota metric total usage will be specified using the following gauge\nmetric:\n
\"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Va
lue for each quota limit associated with the metrics will be specified\nusing th
e following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3.
Delta value of the usage after the reconciliation for limits associated\nwith t
he metrics will be specified using the following metric:\n \"serviceruntime.goo
gleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n
new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined
in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' u
se only. Since this metric is not\ndefined in the monitoring backend, reporting
on this metric will result in\nan error.", |
| 316 "items": { |
| 317 "$ref": "MetricValueSet" |
| 318 }, |
| 319 "type": "array" |
| 320 }, |
| 321 "reconciliationErrors": { |
| 322 "description": "Indicates the decision of the reconciliation
end.", |
| 323 "items": { |
| 324 "$ref": "QuotaError" |
| 325 }, |
| 326 "type": "array" |
| 327 }, |
| 328 "operationId": { |
| 329 "description": "The same operation_id value used in the EndR
econciliationRequest. Used for\nlogging and diagnostics purposes.", |
| 330 "type": "string" |
| 331 }, |
| 332 "serviceConfigId": { |
| 333 "description": "ID of the actual config used to process the
request.", |
| 334 "type": "string" |
| 335 } |
| 336 }, |
| 337 "type": "object" |
| 338 }, |
| 339 "Distribution": { |
| 340 "description": "Distribution represents a frequency distribution of
double-valued sample\npoints. It contains the size of the population of sample p
oints plus\nadditional optional information:\n\n - the arithmetic mean of the s
amples\n - the minimum and maximum of the samples\n - the sum-squared-deviatio
n of the samples, used to compute variance\n - a histogram of the values of the
sample points", |
| 341 "id": "Distribution", |
| 342 "properties": { |
| 343 "minimum": { |
| 344 "description": "The minimum of the population of values. Ign
ored if `count` is zero.", |
| 345 "format": "double", |
| 346 "type": "number" |
| 347 }, |
| 348 "linearBuckets": { |
| 349 "$ref": "LinearBuckets", |
| 350 "description": "Buckets with constant width." |
| 351 }, |
| 352 "mean": { |
| 353 "description": "The arithmetic mean of the samples in the di
stribution. If `count` is\nzero then this field must be zero.", |
| 354 "format": "double", |
| 355 "type": "number" |
| 356 }, |
| 357 "count": { |
| 358 "description": "The total number of samples in the distribut
ion. Must be >= 0.", |
| 359 "format": "int64", |
| 360 "type": "string" |
| 361 }, |
| 362 "bucketCounts": { |
| 363 "description": "The number of samples in each histogram buck
et. `bucket_counts` are\noptional. If present, they must sum to the `count` valu
e.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`b
ucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_coun
ts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite
buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket
. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of
trailing zeros may be omitted.", |
| 364 "items": { |
| 365 "format": "int64", |
| 366 "type": "string" |
| 367 }, |
| 368 "type": "array" |
| 369 }, |
| 370 "explicitBuckets": { |
| 371 "$ref": "ExplicitBuckets", |
| 372 "description": "Buckets with arbitrary user-provided width." |
| 373 }, |
| 374 "maximum": { |
| 375 "description": "The maximum of the population of values. Ign
ored if `count` is zero.", |
| 376 "format": "double", |
| 377 "type": "number" |
| 378 }, |
| 379 "sumOfSquaredDeviation": { |
| 380 "description": "The sum of squared deviations from the mean:
\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `coun
t` is zero then this field\nmust be zero, otherwise validation of the request fa
ils.", |
| 381 "format": "double", |
| 382 "type": "number" |
| 383 }, |
| 384 "exponentialBuckets": { |
| 385 "$ref": "ExponentialBuckets", |
| 386 "description": "Buckets with exponentially growing width." |
| 387 } |
| 388 }, |
| 389 "type": "object" |
| 390 }, |
| 391 "ExplicitBuckets": { |
| 392 "description": "Describing buckets with arbitrary user-provided widt
h.", |
| 393 "id": "ExplicitBuckets", |
| 394 "properties": { |
| 395 "bounds": { |
| 396 "description": "'bound' is a list of strictly increasing bou
ndaries between\nbuckets. Note that a list of length N-1 defines N buckets becau
se\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th f
inite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from
1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound'
only contains a single element; in\nthat special case the single bound defines t
he boundary between the\nunderflow and overflow buckets.\n\nbucket number
lower bound upper bound\n i == 0 (underflow) -inf
bound[i]\n 0 < i < bound_size() bound[i-1] bound[i]\n i =
= bound_size() (overflow) bound[i-1] +inf", |
| 397 "items": { |
| 398 "format": "double", |
| 399 "type": "number" |
| 400 }, |
| 401 "type": "array" |
| 402 } |
| 403 }, |
| 404 "type": "object" |
| 405 }, |
| 406 "ExponentialBuckets": { |
| 407 "description": "Describing buckets with exponentially growing width.
", |
| 408 "id": "ExponentialBuckets", |
| 409 "properties": { |
| 410 "numFiniteBuckets": { |
| 411 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", |
| 412 "format": "int32", |
| 413 "type": "integer" |
| 414 }, |
| 415 "growthFactor": { |
| 416 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", |
| 417 "format": "double", |
| 418 "type": "number" |
| 419 }, |
| 420 "scale": { |
| 421 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be > 0.", |
| 422 "format": "double", |
| 423 "type": "number" |
| 424 } |
| 425 }, |
| 426 "type": "object" |
| 427 }, |
| 428 "AuthorizationInfo": { |
| 429 "description": "Authorization information for the operation.", |
| 430 "id": "AuthorizationInfo", |
| 431 "properties": { |
| 432 "resource": { |
| 433 "description": "The resource being accessed, as a REST-style
string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets
/DATASETID", |
| 434 "type": "string" |
| 435 }, |
| 436 "granted": { |
| 437 "description": "Whether or not authorization for `resource`
and `permission`\nwas granted.", |
| 438 "type": "boolean" |
| 439 }, |
| 440 "permission": { |
| 441 "description": "The required IAM permission.", |
| 442 "type": "string" |
| 443 } |
| 444 }, |
| 445 "type": "object" |
| 446 }, |
| 447 "StartReconciliationResponse": { |
| 448 "id": "StartReconciliationResponse", |
| 449 "properties": { |
| 450 "quotaMetrics": { |
| 451 "description": "Metric values as tracked by One Platform bef
ore the start of\nreconciliation. The following metrics will be included:\n\n1.
Per quota metric total usage will be specified using the following gauge\nmetric
:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2
. Value for each quota limit associated with the metrics will be specified\nusin
g the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"", |
| 452 "items": { |
| 453 "$ref": "MetricValueSet" |
| 454 }, |
| 455 "type": "array" |
| 456 }, |
| 457 "reconciliationErrors": { |
| 458 "description": "Indicates the decision of the reconciliation
start.", |
| 459 "items": { |
| 460 "$ref": "QuotaError" |
| 461 }, |
| 462 "type": "array" |
| 463 }, |
| 464 "operationId": { |
| 465 "description": "The same operation_id value used in the Star
tReconciliationRequest. Used\nfor logging and diagnostics purposes.", |
| 466 "type": "string" |
| 467 }, |
| 468 "serviceConfigId": { |
| 469 "description": "ID of the actual config used to process the
request.", |
| 470 "type": "string" |
| 471 } |
| 472 }, |
| 473 "type": "object" |
| 474 }, |
| 475 "QuotaProperties": { |
| 476 "description": "Represents the properties needed for quota operation
s.", |
| 477 "id": "QuotaProperties", |
| 478 "properties": { |
| 479 "limitByIds": { |
370 "additionalProperties": { | 480 "additionalProperties": { |
371 "type": "string" | 481 "type": "string" |
372 }, | 482 }, |
373 "description": "A set of user-defined (key, value) data that
provides additional\ninformation about the log entry.", | 483 "description": "LimitType IDs that should be used for checki
ng quota. Key in this map\nshould be a valid LimitType string, and the value is
the ID to be used. For\nexample, an entry <USER, 123> will cause all user quota
limits to use 123\nas the user ID. See google/api/quota.proto for the definition
of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will b
e used for enforcing user-level quota\n limits. If none specified, caller I
P passed in the\n servicecontrol.googleapis.com/caller_ip label will be use
d instead.\n If the server cannot resolve a value for this LimitType, an er
ror\n will be thrown. No validation will be performed on this ID.\nDeprecat
ed: use servicecontrol.googleapis.com/user label to send user ID.", |
374 "type": "object" | 484 "type": "object" |
375 }, | 485 }, |
376 "severity": { | 486 "quotaMode": { |
377 "description": "The severity of the log entry. The default v
alue is\n`LogSeverity.DEFAULT`.", | 487 "description": "Quota mode for this operation.", |
378 "enum": [ | 488 "enum": [ |
379 "DEFAULT", | 489 "ACQUIRE", |
380 "DEBUG", | 490 "ACQUIRE_BEST_EFFORT", |
381 "INFO", | 491 "CHECK", |
382 "NOTICE", | 492 "RELEASE" |
383 "WARNING", | |
384 "ERROR", | |
385 "CRITICAL", | |
386 "ALERT", | |
387 "EMERGENCY" | |
388 ], | 493 ], |
389 "enumDescriptions": [ | 494 "enumDescriptions": [ |
390 "(0) The log entry has no assigned severity level.", | 495 "Decreases available quota by the cost specified for the
operation.\nIf cost is higher than available quota, operation fails and returns
\nerror.", |
391 "(100) Debug or trace information.", | 496 "Decreases available quota by the cost specified for the
operation.\nIf cost is higher than available quota, operation does not fail and
\navailable quota goes down to zero but it returns error.", |
392 "(200) Routine information, such as ongoing status or pe
rformance.", | 497 "Does not change any available quota. Only checks if the
re is enough\nquota.\nNo lock is placed on the checked tokens neither.", |
393 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", | 498 "Increases available quota by the operation cost specifi
ed for the\noperation." |
394 "(400) Warning events might cause problems.", | |
395 "(500) Error events are likely to cause problems.", | |
396 "(600) Critical events cause more severe problems or out
ages.", | |
397 "(700) A person must take an action immediately.", | |
398 "(800) One or more systems are unusable." | |
399 ], | 499 ], |
400 "type": "string" | 500 "type": "string" |
401 }, | 501 } |
402 "insertId": { | 502 }, |
403 "description": "A unique ID for the log entry used for dedup
lication. If omitted,\nthe implementation will generate one based on operation_i
d.", | 503 "type": "object" |
404 "type": "string" | 504 }, |
405 }, | 505 "LinearBuckets": { |
406 "name": { | 506 "description": "Describing buckets with constant width.", |
407 "description": "Required. The log to which this log entry be
longs. Examples: `\"syslog\"`,\n`\"book_log\"`.", | 507 "id": "LinearBuckets", |
408 "type": "string" | 508 "properties": { |
409 }, | 509 "numFiniteBuckets": { |
410 "structPayload": { | 510 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", |
411 "additionalProperties": { | 511 "format": "int32", |
412 "description": "Properties of the object.", | 512 "type": "integer" |
413 "type": "any" | 513 }, |
414 }, | 514 "width": { |
415 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", | 515 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.\nMust be strictly positive.", |
416 "type": "object" | 516 "format": "double", |
417 }, | 517 "type": "number" |
418 "textPayload": { | 518 }, |
419 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", | 519 "offset": { |
420 "type": "string" | 520 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.", |
421 }, | 521 "format": "double", |
422 "protoPayload": { | 522 "type": "number" |
423 "additionalProperties": { | 523 } |
424 "description": "Properties of the object. Contains field
@type with type URL.", | 524 }, |
425 "type": "any" | 525 "type": "object" |
426 }, | 526 }, |
427 "description": "The log entry payload, represented as a prot
ocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload
`\nvalues that belong to a set of approved types.", | 527 "AuthenticationInfo": { |
428 "type": "object" | 528 "description": "Authentication information for the operation.", |
429 }, | 529 "id": "AuthenticationInfo", |
430 "timestamp": { | 530 "properties": { |
431 "description": "The time the event described by the log entr
y occurred. If\nomitted, defaults to operation start time.", | 531 "principalEmail": { |
432 "format": "google-datetime", | 532 "description": "The email address of the authenticated user
making the request.", |
433 "type": "string" | 533 "type": "string" |
434 } | 534 }, |
435 }, | 535 "authoritySelector": { |
436 "type": "object" | 536 "description": "The authority selector specified by the requ
estor, if any.\nIt is not guaranteed that the principal was allowed to use this
authority.", |
437 }, | 537 "type": "string" |
438 "AuditLog": { | 538 } |
439 "description": "Common audit log format for Google Cloud Platform AP
I operations.\n\n", | 539 }, |
440 "id": "AuditLog", | 540 "type": "object" |
441 "properties": { | 541 }, |
442 "request": { | 542 "AllocateQuotaResponse": { |
443 "additionalProperties": { | 543 "description": "Response message for the AllocateQuota method.", |
444 "description": "Properties of the object.", | 544 "id": "AllocateQuotaResponse", |
445 "type": "any" | 545 "properties": { |
446 }, | |
447 "description": "The operation request. This may not include
all request parameters,\nsuch as those that are too large, privacy-sensitive, or
duplicated\nelsewhere in the log record.\nIt should never include user-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", | |
448 "type": "object" | |
449 }, | |
450 "requestMetadata": { | |
451 "$ref": "RequestMetadata", | |
452 "description": "Metadata about the operation." | |
453 }, | |
454 "serviceData": { | |
455 "additionalProperties": { | |
456 "description": "Properties of the object. Contains field
@type with type URL.", | |
457 "type": "any" | |
458 }, | |
459 "description": "Other service-specific data about the reques
t, response, and other\nactivities.", | |
460 "type": "object" | |
461 }, | |
462 "numResponseItems": { | |
463 "description": "The number of items returned from a List or
Query API method,\nif applicable.", | |
464 "format": "int64", | |
465 "type": "string" | |
466 }, | |
467 "status": { | |
468 "$ref": "Status", | |
469 "description": "The status of the overall operation." | |
470 }, | |
471 "authenticationInfo": { | |
472 "$ref": "AuthenticationInfo", | |
473 "description": "Authentication information." | |
474 }, | |
475 "serviceName": { | |
476 "description": "The name of the API service performing the o
peration. For example,\n`\"datastore.googleapis.com\"`.", | |
477 "type": "string" | |
478 }, | |
479 "response": { | |
480 "additionalProperties": { | |
481 "description": "Properties of the object.", | |
482 "type": "any" | |
483 }, | |
484 "description": "The operation response. This may not include
all response elements,\nsuch as those that are too large, privacy-sensitive, or
duplicated\nelsewhere in the log record.\nIt should never include user-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", | |
485 "type": "object" | |
486 }, | |
487 "methodName": { | |
488 "description": "The name of the service method or operation.
\nFor API calls, this should be the name of the API method.\nFor example,\n\n
\"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingServ
ice.DeleteLog\"", | |
489 "type": "string" | |
490 }, | |
491 "resourceName": { | |
492 "description": "The resource or collection that is the targe
t of the operation.\nThe name is a scheme-less URI, not including the API servic
e name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/
books/BOOK_ID\"", | |
493 "type": "string" | |
494 }, | |
495 "authorizationInfo": { | |
496 "description": "Authorization information. If there are mult
iple\nresources or permissions involved, then there is\none AuthorizationInfo el
ement for each {resource, permission} tuple.", | |
497 "items": { | |
498 "$ref": "AuthorizationInfo" | |
499 }, | |
500 "type": "array" | |
501 } | |
502 }, | |
503 "type": "object" | |
504 }, | |
505 "MetricValue": { | |
506 "description": "Represents a single metric value.", | |
507 "id": "MetricValue", | |
508 "properties": { | |
509 "stringValue": { | |
510 "description": "A text string value.", | |
511 "type": "string" | |
512 }, | |
513 "labels": { | |
514 "additionalProperties": { | |
515 "type": "string" | |
516 }, | |
517 "description": "The labels describing the metric value.\nSee
comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r
elationship.", | |
518 "type": "object" | |
519 }, | |
520 "doubleValue": { | |
521 "description": "A double precision floating point value.", | |
522 "format": "double", | |
523 "type": "number" | |
524 }, | |
525 "int64Value": { | |
526 "description": "A signed 64-bit integer value.", | |
527 "format": "int64", | |
528 "type": "string" | |
529 }, | |
530 "distributionValue": { | |
531 "$ref": "Distribution", | |
532 "description": "A distribution value." | |
533 }, | |
534 "boolValue": { | |
535 "description": "A boolean value.", | |
536 "type": "boolean" | |
537 }, | |
538 "endTime": { | |
539 "description": "The end of the time period over which this m
etric value's measurement\napplies.", | |
540 "format": "google-datetime", | |
541 "type": "string" | |
542 }, | |
543 "startTime": { | |
544 "description": "The start of the time period over which this
metric value's measurement\napplies. The time period has different semantics fo
r different metric\ntypes (cumulative, delta, and gauge). See the metric definit
ion\ndocumentation in the service configuration for details.", | |
545 "format": "google-datetime", | |
546 "type": "string" | |
547 }, | |
548 "moneyValue": { | |
549 "$ref": "Money", | |
550 "description": "A money value." | |
551 } | |
552 }, | |
553 "type": "object" | |
554 }, | |
555 "EndReconciliationResponse": { | |
556 "id": "EndReconciliationResponse", | |
557 "properties": { | |
558 "reconciliationErrors": { | |
559 "description": "Indicates the decision of the reconciliation
end.", | |
560 "items": { | |
561 "$ref": "QuotaError" | |
562 }, | |
563 "type": "array" | |
564 }, | |
565 "operationId": { | 546 "operationId": { |
566 "description": "The same operation_id value used in the EndR
econciliationRequest. Used for\nlogging and diagnostics purposes.", | 547 "description": "The same operation_id value used in the Allo
cateQuotaRequest. Used for\nlogging and diagnostics purposes.", |
567 "type": "string" | 548 "type": "string" |
568 }, | 549 }, |
569 "serviceConfigId": { | 550 "serviceConfigId": { |
570 "description": "ID of the actual config used to process the
request.", | 551 "description": "ID of the actual config used to process the
request.", |
571 "type": "string" | 552 "type": "string" |
572 }, | 553 }, |
| 554 "allocateErrors": { |
| 555 "description": "Indicates the decision of the allocate.", |
| 556 "items": { |
| 557 "$ref": "QuotaError" |
| 558 }, |
| 559 "type": "array" |
| 560 }, |
573 "quotaMetrics": { | 561 "quotaMetrics": { |
574 "description": "Metric values as tracked by One Platform bef
ore the adjustment was made.\nThe following metrics will be included:\n\n1. Per
quota metric total usage will be specified using the following gauge\nmetric:\n
\"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Va
lue for each quota limit associated with the metrics will be specified\nusing th
e following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3.
Delta value of the usage after the reconciliation for limits associated\nwith t
he metrics will be specified using the following metric:\n \"serviceruntime.goo
gleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n
new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined
in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' u
se only. Since this metric is not\ndefined in the monitoring backend, reporting
on this metric will result in\nan error.", | 562 "description": "Quota metrics to indicate the result of allo
cation. Depending on the\nrequest, one or more of the following metrics will be
included:\n\n1. For rate quota, per quota group or per quota metric incremental
usage\nwill be specified using the following delta metric:\n \"serviceruntime.g
oogleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per qu
ota metric total usage will be specified\nusing the following gauge metric:\n \
"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For
both rate quota and allocation quota, the quota limit reached\ncondition will be
specified using the following boolean metric:\n \"serviceruntime.googleapis.co
m/quota/exceeded\"\n\n4. For allocation quota, value for each quota limit associ
ated with\nthe metrics will be specified using the following gauge metric:\n \"
serviceruntime.googleapis.com/quota/limit\"", |
575 "items": { | 563 "items": { |
576 "$ref": "MetricValueSet" | 564 "$ref": "MetricValueSet" |
577 }, | 565 }, |
578 "type": "array" | 566 "type": "array" |
579 } | 567 } |
580 }, | 568 }, |
581 "type": "object" | 569 "type": "object" |
582 }, | 570 }, |
583 "Money": { | |
584 "description": "Represents an amount of money with its currency type
.", | |
585 "id": "Money", | |
586 "properties": { | |
587 "currencyCode": { | |
588 "description": "The 3-letter currency code defined in ISO 42
17.", | |
589 "type": "string" | |
590 }, | |
591 "nanos": { | |
592 "description": "Number of nano (10^-9) units of the amount.\
nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units`
is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can
be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negativ
e or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000
,000.", | |
593 "format": "int32", | |
594 "type": "integer" | |
595 }, | |
596 "units": { | |
597 "description": "The whole units of the amount.\nFor example
if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", | |
598 "format": "int64", | |
599 "type": "string" | |
600 } | |
601 }, | |
602 "type": "object" | |
603 }, | |
604 "Distribution": { | |
605 "description": "Distribution represents a frequency distribution of
double-valued sample\npoints. It contains the size of the population of sample p
oints plus\nadditional optional information:\n\n - the arithmetic mean of the s
amples\n - the minimum and maximum of the samples\n - the sum-squared-deviatio
n of the samples, used to compute variance\n - a histogram of the values of the
sample points", | |
606 "id": "Distribution", | |
607 "properties": { | |
608 "explicitBuckets": { | |
609 "$ref": "ExplicitBuckets", | |
610 "description": "Buckets with arbitrary user-provided width." | |
611 }, | |
612 "maximum": { | |
613 "description": "The maximum of the population of values. Ign
ored if `count` is zero.", | |
614 "format": "double", | |
615 "type": "number" | |
616 }, | |
617 "sumOfSquaredDeviation": { | |
618 "description": "The sum of squared deviations from the mean:
\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `coun
t` is zero then this field\nmust be zero, otherwise validation of the request fa
ils.", | |
619 "format": "double", | |
620 "type": "number" | |
621 }, | |
622 "exponentialBuckets": { | |
623 "$ref": "ExponentialBuckets", | |
624 "description": "Buckets with exponentially growing width." | |
625 }, | |
626 "minimum": { | |
627 "description": "The minimum of the population of values. Ign
ored if `count` is zero.", | |
628 "format": "double", | |
629 "type": "number" | |
630 }, | |
631 "linearBuckets": { | |
632 "$ref": "LinearBuckets", | |
633 "description": "Buckets with constant width." | |
634 }, | |
635 "count": { | |
636 "description": "The total number of samples in the distribut
ion. Must be >= 0.", | |
637 "format": "int64", | |
638 "type": "string" | |
639 }, | |
640 "mean": { | |
641 "description": "The arithmetic mean of the samples in the di
stribution. If `count` is\nzero then this field must be zero.", | |
642 "format": "double", | |
643 "type": "number" | |
644 }, | |
645 "bucketCounts": { | |
646 "description": "The number of samples in each histogram buck
et. `bucket_counts` are\noptional. If present, they must sum to the `count` valu
e.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`b
ucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_coun
ts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite
buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket
. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of
trailing zeros may be omitted.", | |
647 "items": { | |
648 "format": "int64", | |
649 "type": "string" | |
650 }, | |
651 "type": "array" | |
652 } | |
653 }, | |
654 "type": "object" | |
655 }, | |
656 "ExplicitBuckets": { | |
657 "description": "Describing buckets with arbitrary user-provided widt
h.", | |
658 "id": "ExplicitBuckets", | |
659 "properties": { | |
660 "bounds": { | |
661 "description": "'bound' is a list of strictly increasing bou
ndaries between\nbuckets. Note that a list of length N-1 defines N buckets becau
se\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th f
inite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from
1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound'
only contains a single element; in\nthat special case the single bound defines t
he boundary between the\nunderflow and overflow buckets.\n\nbucket number
lower bound upper bound\n i == 0 (underflow) -inf
bound[i]\n 0 < i < bound_size() bound[i-1] bound[i]\n i =
= bound_size() (overflow) bound[i-1] +inf", | |
662 "items": { | |
663 "format": "double", | |
664 "type": "number" | |
665 }, | |
666 "type": "array" | |
667 } | |
668 }, | |
669 "type": "object" | |
670 }, | |
671 "ExponentialBuckets": { | |
672 "description": "Describing buckets with exponentially growing width.
", | |
673 "id": "ExponentialBuckets", | |
674 "properties": { | |
675 "growthFactor": { | |
676 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", | |
677 "format": "double", | |
678 "type": "number" | |
679 }, | |
680 "scale": { | |
681 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be > 0.", | |
682 "format": "double", | |
683 "type": "number" | |
684 }, | |
685 "numFiniteBuckets": { | |
686 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", | |
687 "format": "int32", | |
688 "type": "integer" | |
689 } | |
690 }, | |
691 "type": "object" | |
692 }, | |
693 "AuthorizationInfo": { | |
694 "description": "Authorization information for the operation.", | |
695 "id": "AuthorizationInfo", | |
696 "properties": { | |
697 "resource": { | |
698 "description": "The resource being accessed, as a REST-style
string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/
DATASETID", | |
699 "type": "string" | |
700 }, | |
701 "granted": { | |
702 "description": "Whether or not authorization for `resource`
and `permission`\nwas granted.", | |
703 "type": "boolean" | |
704 }, | |
705 "permission": { | |
706 "description": "The required IAM permission.", | |
707 "type": "string" | |
708 } | |
709 }, | |
710 "type": "object" | |
711 }, | |
712 "StartReconciliationResponse": { | |
713 "id": "StartReconciliationResponse", | |
714 "properties": { | |
715 "quotaMetrics": { | |
716 "description": "Metric values as tracked by One Platform bef
ore the start of\nreconciliation. The following metrics will be included:\n\n1.
Per quota metric total usage will be specified using the following gauge\nmetric
:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2
. Value for each quota limit associated with the metrics will be specified\nusin
g the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"", | |
717 "items": { | |
718 "$ref": "MetricValueSet" | |
719 }, | |
720 "type": "array" | |
721 }, | |
722 "reconciliationErrors": { | |
723 "description": "Indicates the decision of the reconciliation
start.", | |
724 "items": { | |
725 "$ref": "QuotaError" | |
726 }, | |
727 "type": "array" | |
728 }, | |
729 "operationId": { | |
730 "description": "The same operation_id value used in the Star
tReconciliationRequest. Used\nfor logging and diagnostics purposes.", | |
731 "type": "string" | |
732 }, | |
733 "serviceConfigId": { | |
734 "description": "ID of the actual config used to process the
request.", | |
735 "type": "string" | |
736 } | |
737 }, | |
738 "type": "object" | |
739 }, | |
740 "QuotaProperties": { | |
741 "description": "Represents the properties needed for quota operation
s.", | |
742 "id": "QuotaProperties", | |
743 "properties": { | |
744 "limitByIds": { | |
745 "additionalProperties": { | |
746 "type": "string" | |
747 }, | |
748 "description": "LimitType IDs that should be used for checki
ng quota. Key in this map\nshould be a valid LimitType string, and the value is
the ID to be used. For\nexample, an entry <USER, 123> will cause all user quota
limits to use 123\nas the user ID. See google/api/quota.proto for the definition
of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will b
e used for enforcing user-level quota\n limits. If none specified, caller I
P passed in the\n servicecontrol.googleapis.com/caller_ip label will be use
d instead.\n If the server cannot resolve a value for this LimitType, an er
ror\n will be thrown. No validation will be performed on this ID.\nDeprecat
ed: use servicecontrol.googleapis.com/user label to send user ID.", | |
749 "type": "object" | |
750 }, | |
751 "quotaMode": { | |
752 "description": "Quota mode for this operation.", | |
753 "enum": [ | |
754 "ACQUIRE", | |
755 "ACQUIRE_BEST_EFFORT", | |
756 "CHECK", | |
757 "RELEASE" | |
758 ], | |
759 "enumDescriptions": [ | |
760 "Decreases available quota by the cost specified for the
operation.\nIf cost is higher than available quota, operation fails and returns
\nerror.", | |
761 "Decreases available quota by the cost specified for the
operation.\nIf cost is higher than available quota, operation does not fail and
\navailable quota goes down to zero but it returns error.", | |
762 "Does not change any available quota. Only checks if the
re is enough\nquota.\nNo lock is placed on the checked tokens neither.", | |
763 "Increases available quota by the operation cost specifi
ed for the\noperation." | |
764 ], | |
765 "type": "string" | |
766 } | |
767 }, | |
768 "type": "object" | |
769 }, | |
770 "LinearBuckets": { | |
771 "description": "Describing buckets with constant width.", | |
772 "id": "LinearBuckets", | |
773 "properties": { | |
774 "offset": { | |
775 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.", | |
776 "format": "double", | |
777 "type": "number" | |
778 }, | |
779 "numFiniteBuckets": { | |
780 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", | |
781 "format": "int32", | |
782 "type": "integer" | |
783 }, | |
784 "width": { | |
785 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.\nMust be strictly positive.", | |
786 "format": "double", | |
787 "type": "number" | |
788 } | |
789 }, | |
790 "type": "object" | |
791 }, | |
792 "AuthenticationInfo": { | |
793 "description": "Authentication information for the operation.", | |
794 "id": "AuthenticationInfo", | |
795 "properties": { | |
796 "principalEmail": { | |
797 "description": "The email address of the authenticated user
making the request.", | |
798 "type": "string" | |
799 }, | |
800 "authoritySelector": { | |
801 "description": "The authority selector specified by the requ
estor, if any.\nIt is not guaranteed that the principal was allowed to use this
authority.", | |
802 "type": "string" | |
803 } | |
804 }, | |
805 "type": "object" | |
806 }, | |
807 "AllocateQuotaResponse": { | |
808 "description": "Response message for the AllocateQuota method.", | |
809 "id": "AllocateQuotaResponse", | |
810 "properties": { | |
811 "quotaMetrics": { | |
812 "description": "Quota metrics to indicate the result of allo
cation. Depending on the\nrequest, one or more of the following metrics will be
included:\n\n1. For rate quota, per quota group or per quota metric incremental
usage\nwill be specified using the following delta metric:\n \"serviceruntime.g
oogleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per qu
ota metric total usage will be specified\nusing the following gauge metric:\n \
"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For
both rate quota and allocation quota, the quota limit reached\ncondition will be
specified using the following boolean metric:\n \"serviceruntime.googleapis.co
m/quota/exceeded\"\n\n4. For allocation quota, value for each quota limit associ
ated with\nthe metrics will be specified using the following gauge metric:\n \"
serviceruntime.googleapis.com/quota/limit\"", | |
813 "items": { | |
814 "$ref": "MetricValueSet" | |
815 }, | |
816 "type": "array" | |
817 }, | |
818 "operationId": { | |
819 "description": "The same operation_id value used in the Allo
cateQuotaRequest. Used for\nlogging and diagnostics purposes.", | |
820 "type": "string" | |
821 }, | |
822 "serviceConfigId": { | |
823 "description": "ID of the actual config used to process the
request.", | |
824 "type": "string" | |
825 }, | |
826 "allocateErrors": { | |
827 "description": "Indicates the decision of the allocate.", | |
828 "items": { | |
829 "$ref": "QuotaError" | |
830 }, | |
831 "type": "array" | |
832 } | |
833 }, | |
834 "type": "object" | |
835 }, | |
836 "ReleaseQuotaRequest": { | 571 "ReleaseQuotaRequest": { |
837 "description": "Request message for the ReleaseQuota method.", | 572 "description": "Request message for the ReleaseQuota method.", |
838 "id": "ReleaseQuotaRequest", | 573 "id": "ReleaseQuotaRequest", |
839 "properties": { | 574 "properties": { |
840 "serviceConfigId": { | 575 "serviceConfigId": { |
841 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", | 576 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
842 "type": "string" | 577 "type": "string" |
843 }, | 578 }, |
844 "releaseOperation": { | 579 "releaseOperation": { |
845 "$ref": "QuotaOperation", | 580 "$ref": "QuotaOperation", |
846 "description": "Operation that describes the quota release." | 581 "description": "Operation that describes the quota release." |
847 } | 582 } |
848 }, | 583 }, |
849 "type": "object" | 584 "type": "object" |
850 }, | 585 }, |
851 "RequestMetadata": { | |
852 "description": "Metadata about the request.", | |
853 "id": "RequestMetadata", | |
854 "properties": { | |
855 "callerIp": { | |
856 "description": "The IP address of the caller.", | |
857 "type": "string" | |
858 }, | |
859 "callerSuppliedUserAgent": { | |
860 "description": "The user agent of the caller.\nThis informat
ion is not authenticated and should be treated accordingly.\nFor example:\n\n+
`google-api-python-client/1.4.0`:\n The request was made by the Google API c
lient for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0
.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `Ap
pEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n T
he request was made from the `my-project` App Engine app.\n\nNOLINT", | |
861 "type": "string" | |
862 } | |
863 }, | |
864 "type": "object" | |
865 }, | |
866 "QuotaError": { | 586 "QuotaError": { |
867 "id": "QuotaError", | 587 "id": "QuotaError", |
868 "properties": { | 588 "properties": { |
869 "description": { | 589 "description": { |
870 "description": "Free-form text that provides details on the
cause of the error.", | 590 "description": "Free-form text that provides details on the
cause of the error.", |
871 "type": "string" | 591 "type": "string" |
872 }, | 592 }, |
873 "subject": { | 593 "subject": { |
874 "description": "Subject to whom this error applies. See the
specific enum for more details\non this field. For example, \"clientip:<ip addre
ss of client>\" or\n\"project:<Google developer project id>\".", | 594 "description": "Subject to whom this error applies. See the
specific enum for more details\non this field. For example, \"clientip:<ip addre
ss of client>\" or\n\"project:<Google developer project id>\".", |
875 "type": "string" | 595 "type": "string" |
876 }, | 596 }, |
877 "code": { | 597 "code": { |
878 "description": "Error code.", | 598 "description": "Error code.", |
879 "enum": [ | 599 "enum": [ |
880 "UNSPECIFIED", | 600 "UNSPECIFIED", |
881 "RESOURCE_EXHAUSTED", | 601 "RESOURCE_EXHAUSTED", |
| 602 "OUT_OF_RANGE", |
882 "BILLING_NOT_ACTIVE", | 603 "BILLING_NOT_ACTIVE", |
883 "PROJECT_DELETED", | 604 "PROJECT_DELETED", |
884 "API_KEY_INVALID", | 605 "API_KEY_INVALID", |
885 "API_KEY_EXPIRED", | 606 "API_KEY_EXPIRED", |
886 "SPATULA_HEADER_INVALID", | 607 "SPATULA_HEADER_INVALID", |
887 "LOAS_ROLE_INVALID", | 608 "LOAS_ROLE_INVALID", |
888 "NO_LOAS_PROJECT", | 609 "NO_LOAS_PROJECT", |
889 "PROJECT_STATUS_UNAVAILABLE", | 610 "PROJECT_STATUS_UNAVAILABLE", |
890 "SERVICE_STATUS_UNAVAILABLE", | 611 "SERVICE_STATUS_UNAVAILABLE", |
891 "BILLING_STATUS_UNAVAILABLE", | 612 "BILLING_STATUS_UNAVAILABLE", |
892 "QUOTA_SYSTEM_UNAVAILABLE" | 613 "QUOTA_SYSTEM_UNAVAILABLE" |
893 ], | 614 ], |
894 "enumDescriptions": [ | 615 "enumDescriptions": [ |
895 "This is never used.", | 616 "This is never used.", |
896 "Quota allocation failed.\nSame as google.rpc.Code.RESOU
RCE_EXHAUSTED.", | 617 "Quota allocation failed.\nSame as google.rpc.Code.RESOU
RCE_EXHAUSTED.", |
| 618 "Quota release failed. This error is ONLY returned on a
NORMAL release.\nMore formally: if a user requests a release of 10 tokens, but
only\n5 tokens were previously allocated, in a BEST_EFFORT release, this will\n
be considered a success, 5 tokens will be released, and the result will\nbe \"Ok
\". If this is done in NORMAL mode, no tokens will be released,\nand an OUT_OF_
RANGE error will be returned.\nSame as google.rpc.Code.OUT_OF_RANGE.", |
897 "Consumer cannot access the service because the service
requires active\nbilling.", | 619 "Consumer cannot access the service because the service
requires active\nbilling.", |
898 "Consumer's project has been marked as deleted (soft del
etion).", | 620 "Consumer's project has been marked as deleted (soft del
etion).", |
899 "Specified API key is invalid.", | 621 "Specified API key is invalid.", |
900 "Specified API Key has expired.", | 622 "Specified API Key has expired.", |
901 "Consumer's spatula header is invalid.", | 623 "Consumer's spatula header is invalid.", |
902 "The consumer's LOAS role is invalid.", | 624 "The consumer's LOAS role is invalid.", |
903 "The consumer's LOAS role has no associated project.", | 625 "The consumer's LOAS role has no associated project.", |
904 "The backend server for looking up project id/number is
unavailable.", | 626 "The backend server for looking up project id/number is
unavailable.", |
905 "The backend server for checking service status is unava
ilable.", | 627 "The backend server for checking service status is unava
ilable.", |
906 "The backend server for checking billing status is unava
ilable.", | 628 "The backend server for checking billing status is unava
ilable.", |
907 "The backend server for checking quota limits is unavail
able." | 629 "The backend server for checking quota limits is unavail
able." |
908 ], | 630 ], |
909 "type": "string" | 631 "type": "string" |
910 } | 632 } |
911 }, | 633 }, |
912 "type": "object" | 634 "type": "object" |
913 }, | 635 }, |
| 636 "RequestMetadata": { |
| 637 "description": "Metadata about the request.", |
| 638 "id": "RequestMetadata", |
| 639 "properties": { |
| 640 "callerIp": { |
| 641 "description": "The IP address of the caller.\nFor caller fr
om internet, this will be public IPv4 or IPv6 address.\nFor caller from GCE VM w
ith external IP address, this will be the VM's\nexternal IP address. For caller
from GCE VM without external IP address, if\nthe VM is in the same GCP organizat
ion (or project) as the accessed\nresource, `caller_ip` will be the GCE VM's int
ernal IPv4 address, otherwise\nit will be redacted to \"gce-internal-ip\".\nSee
https://cloud.google.com/compute/docs/vpc/ for more information.", |
| 642 "type": "string" |
| 643 }, |
| 644 "callerSuppliedUserAgent": { |
| 645 "description": "The user agent of the caller.\nThis informat
ion is not authenticated and should be treated accordingly.\nFor example:\n\n+
`google-api-python-client/1.4.0`:\n The request was made by the Google API c
lient for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0
.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `Ap
pEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n T
he request was made from the `my-project` App Engine app.\nNOLINT", |
| 646 "type": "string" |
| 647 } |
| 648 }, |
| 649 "type": "object" |
| 650 }, |
914 "CheckInfo": { | 651 "CheckInfo": { |
915 "id": "CheckInfo", | 652 "id": "CheckInfo", |
916 "properties": { | 653 "properties": { |
917 "unusedArguments": { | 654 "unusedArguments": { |
918 "description": "A list of fields and label keys that are ign
ored by the server.\nThe client doesn't need to send them for following requests
to improve\nperformance and allow better aggregation.", | 655 "description": "A list of fields and label keys that are ign
ored by the server.\nThe client doesn't need to send them for following requests
to improve\nperformance and allow better aggregation.", |
919 "items": { | 656 "items": { |
920 "type": "string" | 657 "type": "string" |
921 }, | 658 }, |
922 "type": "array" | 659 "type": "array" |
| 660 }, |
| 661 "consumerInfo": { |
| 662 "$ref": "ConsumerInfo", |
| 663 "description": "Consumer info of this check." |
923 } | 664 } |
924 }, | 665 }, |
925 "type": "object" | 666 "type": "object" |
926 }, | 667 }, |
927 "ReleaseQuotaResponse": { | 668 "ReleaseQuotaResponse": { |
928 "description": "Response message for the ReleaseQuota method.", | 669 "description": "Response message for the ReleaseQuota method.", |
929 "id": "ReleaseQuotaResponse", | 670 "id": "ReleaseQuotaResponse", |
930 "properties": { | 671 "properties": { |
931 "operationId": { | 672 "operationId": { |
932 "description": "The same operation_id value used in the Rele
aseQuotaRequest. Used for\nlogging and diagnostics purposes.", | 673 "description": "The same operation_id value used in the Rele
aseQuotaRequest. Used for\nlogging and diagnostics purposes.", |
(...skipping 17 matching lines...) Expand all Loading... |
950 }, | 691 }, |
951 "type": "array" | 692 "type": "array" |
952 } | 693 } |
953 }, | 694 }, |
954 "type": "object" | 695 "type": "object" |
955 }, | 696 }, |
956 "AllocateQuotaRequest": { | 697 "AllocateQuotaRequest": { |
957 "description": "Request message for the AllocateQuota method.", | 698 "description": "Request message for the AllocateQuota method.", |
958 "id": "AllocateQuotaRequest", | 699 "id": "AllocateQuotaRequest", |
959 "properties": { | 700 "properties": { |
960 "serviceConfigId": { | |
961 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", | |
962 "type": "string" | |
963 }, | |
964 "allocateOperation": { | |
965 "$ref": "QuotaOperation", | |
966 "description": "Operation that describes the quota allocatio
n." | |
967 }, | |
968 "allocationMode": { | 701 "allocationMode": { |
969 "description": "Allocation mode for this operation.\nDepreca
ted: use QuotaMode inside the QuotaOperation.", | 702 "description": "Allocation mode for this operation.\nDepreca
ted: use QuotaMode inside the QuotaOperation.", |
970 "enum": [ | 703 "enum": [ |
971 "UNSPECIFIED", | 704 "UNSPECIFIED", |
972 "NORMAL", | 705 "NORMAL", |
973 "BEST_EFFORT", | 706 "BEST_EFFORT", |
974 "CHECK_ONLY" | 707 "CHECK_ONLY" |
975 ], | 708 ], |
976 "enumDescriptions": [ | 709 "enumDescriptions": [ |
977 "", | 710 "", |
978 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, allocation error will be returned and no quota will be\
nallocated.", | 711 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, allocation error will be returned and no quota will be\
nallocated.", |
979 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, request does not fail but all available quota will be\n
allocated.", | 712 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, request does not fail but all available quota will be\n
allocated.", |
980 "Only checks if there is enough quota available and does
not change the\navailable quota. No lock is placed on the available quota eithe
r." | 713 "Only checks if there is enough quota available and does
not change the\navailable quota. No lock is placed on the available quota eithe
r." |
981 ], | 714 ], |
982 "type": "string" | 715 "type": "string" |
| 716 }, |
| 717 "serviceConfigId": { |
| 718 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
| 719 "type": "string" |
| 720 }, |
| 721 "allocateOperation": { |
| 722 "$ref": "QuotaOperation", |
| 723 "description": "Operation that describes the quota allocatio
n." |
983 } | 724 } |
984 }, | 725 }, |
985 "type": "object" | 726 "type": "object" |
986 }, | 727 }, |
987 "MetricValueSet": { | 728 "MetricValueSet": { |
988 "description": "Represents a set of metric values in the same metric
.\nEach metric value in the set should have a unique combination of start time,\
nend time, and label values.", | 729 "description": "Represents a set of metric values in the same metric
.\nEach metric value in the set should have a unique combination of start time,\
nend time, and label values.", |
989 "id": "MetricValueSet", | 730 "id": "MetricValueSet", |
990 "properties": { | 731 "properties": { |
| 732 "metricName": { |
| 733 "description": "The metric name defined in the service confi
guration.", |
| 734 "type": "string" |
| 735 }, |
991 "metricValues": { | 736 "metricValues": { |
992 "description": "The values in this metric.", | 737 "description": "The values in this metric.", |
993 "items": { | 738 "items": { |
994 "$ref": "MetricValue" | 739 "$ref": "MetricValue" |
995 }, | 740 }, |
996 "type": "array" | 741 "type": "array" |
997 }, | |
998 "metricName": { | |
999 "description": "The metric name defined in the service confi
guration.", | |
1000 "type": "string" | |
1001 } | 742 } |
1002 }, | 743 }, |
1003 "type": "object" | 744 "type": "object" |
1004 }, | 745 }, |
1005 "ReportError": { | 746 "ReportError": { |
1006 "description": "Represents the processing error of one `Operation` i
n the request.", | 747 "description": "Represents the processing error of one `Operation` i
n the request.", |
1007 "id": "ReportError", | 748 "id": "ReportError", |
1008 "properties": { | 749 "properties": { |
| 750 "operationId": { |
| 751 "description": "The Operation.operation_id value from the re
quest.", |
| 752 "type": "string" |
| 753 }, |
1009 "status": { | 754 "status": { |
1010 "$ref": "Status", | 755 "$ref": "Status", |
1011 "description": "Details of the error when processing the `Op
eration`." | 756 "description": "Details of the error when processing the `Op
eration`." |
1012 }, | 757 } |
1013 "operationId": { | 758 }, |
1014 "description": "The Operation.operation_id value from the re
quest.", | 759 "type": "object" |
1015 "type": "string" | 760 }, |
1016 } | 761 "StartReconciliationRequest": { |
1017 }, | 762 "id": "StartReconciliationRequest", |
1018 "type": "object" | 763 "properties": { |
| 764 "serviceConfigId": { |
| 765 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
| 766 "type": "string" |
| 767 }, |
| 768 "reconciliationOperation": { |
| 769 "$ref": "QuotaOperation", |
| 770 "description": "Operation that describes the quota reconcili
ation." |
| 771 } |
| 772 }, |
| 773 "type": "object" |
1019 }, | 774 }, |
1020 "CheckError": { | 775 "CheckError": { |
1021 "description": "Defines the errors to be returned in\ngoogle.api.ser
vicecontrol.v1.CheckResponse.check_errors.", | 776 "description": "Defines the errors to be returned in\ngoogle.api.ser
vicecontrol.v1.CheckResponse.check_errors.", |
1022 "id": "CheckError", | 777 "id": "CheckError", |
1023 "properties": { | 778 "properties": { |
1024 "detail": { | |
1025 "description": "Free-form text providing details on the erro
r cause of the error.", | |
1026 "type": "string" | |
1027 }, | |
1028 "code": { | 779 "code": { |
1029 "description": "The error code.", | 780 "description": "The error code.", |
1030 "enum": [ | 781 "enum": [ |
1031 "ERROR_CODE_UNSPECIFIED", | 782 "ERROR_CODE_UNSPECIFIED", |
1032 "NOT_FOUND", | 783 "NOT_FOUND", |
1033 "PERMISSION_DENIED", | 784 "PERMISSION_DENIED", |
1034 "RESOURCE_EXHAUSTED", | 785 "RESOURCE_EXHAUSTED", |
1035 "BUDGET_EXCEEDED", | 786 "BUDGET_EXCEEDED", |
1036 "DENIAL_OF_SERVICE_DETECTED", | 787 "DENIAL_OF_SERVICE_DETECTED", |
1037 "LOAD_SHEDDING", | 788 "LOAD_SHEDDING", |
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1089 "Request is not allowed as per security policies defined
in Org Policy.", | 840 "Request is not allowed as per security policies defined
in Org Policy.", |
1090 "The backend server for looking up project id/number is
unavailable.", | 841 "The backend server for looking up project id/number is
unavailable.", |
1091 "The backend server for checking service status is unava
ilable.", | 842 "The backend server for checking service status is unava
ilable.", |
1092 "The backend server for checking billing status is unava
ilable.", | 843 "The backend server for checking billing status is unava
ilable.", |
1093 "The backend server for checking quota limits is unavail
able.", | 844 "The backend server for checking quota limits is unavail
able.", |
1094 "The Spanner for looking up LOAS project is unavailable.
", | 845 "The Spanner for looking up LOAS project is unavailable.
", |
1095 "Cloud Resource Manager backend server is unavailable.", | 846 "Cloud Resource Manager backend server is unavailable.", |
1096 "Backend server for evaluating security policy is unavai
lable." | 847 "Backend server for evaluating security policy is unavai
lable." |
1097 ], | 848 ], |
1098 "type": "string" | 849 "type": "string" |
| 850 }, |
| 851 "detail": { |
| 852 "description": "Free-form text providing details on the erro
r cause of the error.", |
| 853 "type": "string" |
1099 } | 854 } |
1100 }, | 855 }, |
1101 "type": "object" | 856 "type": "object" |
1102 }, | |
1103 "StartReconciliationRequest": { | |
1104 "id": "StartReconciliationRequest", | |
1105 "properties": { | |
1106 "serviceConfigId": { | |
1107 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", | |
1108 "type": "string" | |
1109 }, | |
1110 "reconciliationOperation": { | |
1111 "$ref": "QuotaOperation", | |
1112 "description": "Operation that describes the quota reconcili
ation." | |
1113 } | |
1114 }, | |
1115 "type": "object" | |
1116 }, | 857 }, |
1117 "QuotaInfo": { | 858 "QuotaInfo": { |
1118 "description": "Contains the quota information for a quota check res
ponse.", | 859 "description": "Contains the quota information for a quota check res
ponse.", |
1119 "id": "QuotaInfo", | 860 "id": "QuotaInfo", |
1120 "properties": { | 861 "properties": { |
1121 "quotaConsumed": { | 862 "quotaConsumed": { |
1122 "additionalProperties": { | 863 "additionalProperties": { |
1123 "format": "int32", | 864 "format": "int32", |
1124 "type": "integer" | 865 "type": "integer" |
1125 }, | 866 }, |
(...skipping 10 matching lines...) Expand all Loading... |
1136 "limitExceeded": { | 877 "limitExceeded": { |
1137 "description": "Quota Metrics that have exceeded quota limit
s.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based qu
ota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metri
cs to get per quota group limit exceeded status.", | 878 "description": "Quota Metrics that have exceeded quota limit
s.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based qu
ota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metri
cs to get per quota group limit exceeded status.", |
1138 "items": { | 879 "items": { |
1139 "type": "string" | 880 "type": "string" |
1140 }, | 881 }, |
1141 "type": "array" | 882 "type": "array" |
1142 } | 883 } |
1143 }, | 884 }, |
1144 "type": "object" | 885 "type": "object" |
1145 }, | 886 }, |
| 887 "ConsumerInfo": { |
| 888 "description": "`ConsumerInfo` provides information about the consum
er project.", |
| 889 "id": "ConsumerInfo", |
| 890 "properties": { |
| 891 "projectNumber": { |
| 892 "description": "The Google cloud project number, e.g. 123456
7890. A value of 0 indicates\nno project number is found.", |
| 893 "format": "int64", |
| 894 "type": "string" |
| 895 } |
| 896 }, |
| 897 "type": "object" |
| 898 }, |
1146 "CheckRequest": { | 899 "CheckRequest": { |
1147 "description": "Request message for the Check method.", | 900 "description": "Request message for the Check method.", |
1148 "id": "CheckRequest", | 901 "id": "CheckRequest", |
1149 "properties": { | 902 "properties": { |
1150 "serviceConfigId": { | 903 "serviceConfigId": { |
1151 "description": "Specifies which version of service configura
tion should be used to process\nthe request.\n\nIf unspecified or no matching ve
rsion can be found, the\nlatest one will be used.", | 904 "description": "Specifies which version of service configura
tion should be used to process\nthe request.\n\nIf unspecified or no matching ve
rsion can be found, the\nlatest one will be used.", |
1152 "type": "string" | 905 "type": "string" |
1153 }, | 906 }, |
1154 "skipActivationCheck": { | 907 "skipActivationCheck": { |
1155 "description": "Indicates if service activation check should
be skipped for this request.\nDefault behavior is to perform the check and appl
y relevant quota.", | 908 "description": "Indicates if service activation check should
be skipped for this request.\nDefault behavior is to perform the check and appl
y relevant quota.", |
1156 "type": "boolean" | 909 "type": "boolean" |
1157 }, | 910 }, |
1158 "requestProjectSettings": { | 911 "requestProjectSettings": { |
1159 "description": "Requests the project settings to be returned
as part of the check response.", | 912 "description": "Requests the project settings to be returned
as part of the check response.", |
1160 "type": "boolean" | 913 "type": "boolean" |
1161 }, | 914 }, |
1162 "operation": { | 915 "operation": { |
1163 "$ref": "Operation", | 916 "$ref": "Operation", |
1164 "description": "The operation to be checked." | 917 "description": "The operation to be checked." |
1165 } | 918 } |
1166 }, | 919 }, |
1167 "type": "object" | 920 "type": "object" |
1168 }, | 921 }, |
1169 "QuotaOperation": { | 922 "QuotaOperation": { |
1170 "description": "Represents information regarding a quota operation."
, | 923 "description": "Represents information regarding a quota operation."
, |
1171 "id": "QuotaOperation", | 924 "id": "QuotaOperation", |
1172 "properties": { | 925 "properties": { |
1173 "quotaMetrics": { | |
1174 "description": "Represents information about this operation.
Each MetricValueSet\ncorresponds to a metric defined in the service configurati
on.\nThe data type used in the MetricValueSet must agree with\nthe data type spe
cified in the metric definition.\n\nWithin a single operation, it is not allowed
to have more than one\nMetricValue instances that have the same metric names an
d identical\nlabel value combinations. If a request has such duplicated MetricVa
lue\ninstances, the entire request is rejected with\nan invalid argument error."
, | |
1175 "items": { | |
1176 "$ref": "MetricValueSet" | |
1177 }, | |
1178 "type": "array" | |
1179 }, | |
1180 "labels": { | |
1181 "additionalProperties": { | |
1182 "type": "string" | |
1183 }, | |
1184 "description": "Labels describing the operation.", | |
1185 "type": "object" | |
1186 }, | |
1187 "consumerId": { | |
1188 "description": "Identity of the consumer for whom this quota
operation is being performed.\n\nThis can be in one of the following formats:\n
project:<project_id>,\n project_number:<project_number>,\n api_key:<api_key>
.", | |
1189 "type": "string" | |
1190 }, | |
1191 "operationId": { | 926 "operationId": { |
1192 "description": "Identity of the operation. This must be uniq
ue within the scope of the\nservice that generated the operation. If the service
calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls shou
ld carry the\nsame ID.\n\nUUID version 4 is recommended, though not required. In
scenarios where an\noperation is computed from existing information and an idem
potent id is\ndesirable for deduplication purpose, UUID version 5 is recommended
. See\nRFC 4122 for details.", | 927 "description": "Identity of the operation. This must be uniq
ue within the scope of the\nservice that generated the operation. If the service
calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls shou
ld carry the\nsame ID.\n\nUUID version 4 is recommended, though not required. In
scenarios where an\noperation is computed from existing information and an idem
potent id is\ndesirable for deduplication purpose, UUID version 5 is recommended
. See\nRFC 4122 for details.", |
1193 "type": "string" | 928 "type": "string" |
1194 }, | 929 }, |
1195 "quotaMode": { | 930 "quotaMode": { |
1196 "description": "Quota mode for this operation.", | 931 "description": "Quota mode for this operation.", |
1197 "enum": [ | 932 "enum": [ |
1198 "UNSPECIFIED", | 933 "UNSPECIFIED", |
1199 "NORMAL", | 934 "NORMAL", |
1200 "BEST_EFFORT", | 935 "BEST_EFFORT", |
1201 "CHECK_ONLY" | 936 "CHECK_ONLY" |
1202 ], | 937 ], |
1203 "enumDescriptions": [ | 938 "enumDescriptions": [ |
1204 "", | 939 "", |
1205 "For AllocateQuota request, allocates quota for the amou
nt specified in\nthe service configuration or specified using the quota metrics.
If the\namount is higher than the available quota, allocation error will be\nre
turned and no quota will be allocated.\nFor ReleaseQuota request, this mode is s
upported only for precise quota\nlimits. In this case, this operation releases q
uota for the amount\nspecified in the service configuration or specified using t
he quota\nmetrics. If the release can make used quota negative, release error\nw
ill be returned and no quota will be released.", | 940 "For AllocateQuota request, allocates quota for the amou
nt specified in\nthe service configuration or specified using the quota metrics.
If the\namount is higher than the available quota, allocation error will be\nre
turned and no quota will be allocated.\nFor ReleaseQuota request, this mode is s
upported only for precise quota\nlimits. In this case, this operation releases q
uota for the amount\nspecified in the service configuration or specified using t
he quota\nmetrics. If the release can make used quota negative, release error\nw
ill be returned and no quota will be released.", |
1206 "For AllocateQuota request, this mode is supported only
for imprecise\nquota limits. In this case, the operation allocates quota for the
amount\nspecified in the service configuration or specified using the quota\nme
trics. If the amount is higher than the available quota, request does\nnot fail
but all available quota will be allocated.\nFor ReleaseQuota request, this mode
is supported for both precise quota\nlimits and imprecise quota limits. In this
case, this operation releases\nquota for the amount specified in the service con
figuration or specified\nusing the quota metrics. If the release can make used q
uota\nnegative, request does not fail but only the used quota will be\nreleased.
After the ReleaseQuota request completes, the used quota\nwill be 0, and never
goes to negative.", | 941 "For AllocateQuota request, this mode is supported only
for imprecise\nquota limits. In this case, the operation allocates quota for the
amount\nspecified in the service configuration or specified using the quota\nme
trics. If the amount is higher than the available quota, request does\nnot fail
but all available quota will be allocated.\nFor ReleaseQuota request, this mode
is supported for both precise quota\nlimits and imprecise quota limits. In this
case, this operation releases\nquota for the amount specified in the service con
figuration or specified\nusing the quota metrics. If the release can make used q
uota\nnegative, request does not fail but only the used quota will be\nreleased.
After the ReleaseQuota request completes, the used quota\nwill be 0, and never
goes to negative.", |
1207 "For AllocateQuota request, only checks if there is enou
gh quota\navailable and does not change the available quota. No lock is placed o
n\nthe available quota either. Not supported for ReleaseQuota request." | 942 "For AllocateQuota request, only checks if there is enou
gh quota\navailable and does not change the available quota. No lock is placed o
n\nthe available quota either. Not supported for ReleaseQuota request." |
1208 ], | 943 ], |
1209 "type": "string" | 944 "type": "string" |
1210 }, | 945 }, |
1211 "methodName": { | 946 "methodName": { |
1212 "description": "Fully qualified name of the API method for w
hich this quota operation is\nrequested. This name is used for matching quota ru
les or metric rules and\nbilling status rules defined in service configuration.
This field is not\nrequired if the quota operation is performed on non-API resou
rces.\n\nExample of an RPC method name:\n google.example.library.v1.LibrarySe
rvice.CreateShelf", | 947 "description": "Fully qualified name of the API method for w
hich this quota operation is\nrequested. This name is used for matching quota ru
les or metric rules and\nbilling status rules defined in service configuration.
This field is not\nrequired if the quota operation is performed on non-API resou
rces.\n\nExample of an RPC method name:\n google.example.library.v1.LibrarySe
rvice.CreateShelf", |
1213 "type": "string" | 948 "type": "string" |
| 949 }, |
| 950 "quotaMetrics": { |
| 951 "description": "Represents information about this operation.
Each MetricValueSet\ncorresponds to a metric defined in the service configurati
on.\nThe data type used in the MetricValueSet must agree with\nthe data type spe
cified in the metric definition.\n\nWithin a single operation, it is not allowed
to have more than one\nMetricValue instances that have the same metric names an
d identical\nlabel value combinations. If a request has such duplicated MetricVa
lue\ninstances, the entire request is rejected with\nan invalid argument error."
, |
| 952 "items": { |
| 953 "$ref": "MetricValueSet" |
| 954 }, |
| 955 "type": "array" |
| 956 }, |
| 957 "labels": { |
| 958 "additionalProperties": { |
| 959 "type": "string" |
| 960 }, |
| 961 "description": "Labels describing the operation.", |
| 962 "type": "object" |
| 963 }, |
| 964 "consumerId": { |
| 965 "description": "Identity of the consumer for whom this quota
operation is being performed.\n\nThis can be in one of the following formats:\n
project:<project_id>,\n project_number:<project_number>,\n api_key:<api_key>
.", |
| 966 "type": "string" |
1214 } | 967 } |
1215 }, | 968 }, |
1216 "type": "object" | 969 "type": "object" |
1217 }, | 970 }, |
1218 "EndReconciliationRequest": { | 971 "EndReconciliationRequest": { |
1219 "id": "EndReconciliationRequest", | 972 "id": "EndReconciliationRequest", |
1220 "properties": { | 973 "properties": { |
1221 "serviceConfigId": { | 974 "serviceConfigId": { |
1222 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", | 975 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
1223 "type": "string" | 976 "type": "string" |
(...skipping 16 matching lines...) Expand all Loading... |
1240 "$ref": "QuotaInfo", | 993 "$ref": "QuotaInfo", |
1241 "description": "Quota usage info when processing the `Operat
ion`." | 994 "description": "Quota usage info when processing the `Operat
ion`." |
1242 } | 995 } |
1243 }, | 996 }, |
1244 "type": "object" | 997 "type": "object" |
1245 }, | 998 }, |
1246 "Operation": { | 999 "Operation": { |
1247 "description": "Represents information regarding an operation.", | 1000 "description": "Represents information regarding an operation.", |
1248 "id": "Operation", | 1001 "id": "Operation", |
1249 "properties": { | 1002 "properties": { |
| 1003 "endTime": { |
| 1004 "description": "End time of the operation.\nRequired when th
e operation is used in ServiceController.Report,\nbut optional when the operatio
n is used in ServiceController.Check.", |
| 1005 "format": "google-datetime", |
| 1006 "type": "string" |
| 1007 }, |
| 1008 "operationName": { |
| 1009 "description": "Fully qualified name of the operation. Reser
ved for future use.", |
| 1010 "type": "string" |
| 1011 }, |
| 1012 "startTime": { |
| 1013 "description": "Required. Start time of the operation.", |
| 1014 "format": "google-datetime", |
| 1015 "type": "string" |
| 1016 }, |
| 1017 "importance": { |
| 1018 "description": "DO NOT USE. This is an experimental field.", |
| 1019 "enum": [ |
| 1020 "LOW", |
| 1021 "HIGH", |
| 1022 "DEBUG" |
| 1023 ], |
| 1024 "enumDescriptions": [ |
| 1025 "The API implementation may cache and aggregate the data
.\nThe data may be lost when rare and unexpected system failures occur.", |
| 1026 "The API implementation doesn't cache and aggregate the
data.\nIf the method returns successfully, it's guaranteed that the data has\nbe
en persisted in durable storage.", |
| 1027 "In addition to the behavior described in HIGH, DEBUG en
ables\nadditional validation logic that is only useful during the onboarding\npr
ocess. This is only available to Google internal services and\nthe service must
be whitelisted by chemist-dev@google.com in order\nto use this level." |
| 1028 ], |
| 1029 "type": "string" |
| 1030 }, |
| 1031 "resourceContainer": { |
| 1032 "description": "The resource name of the parent of a resourc
e in the resource hierarchy.\n\nThis can be in one of the following formats:\n
- “projects/<project-id or project-number>”\n - “folders/<folder-id>”\n
- “organizations/<organization-id>”", |
| 1033 "type": "string" |
| 1034 }, |
1250 "labels": { | 1035 "labels": { |
1251 "additionalProperties": { | 1036 "additionalProperties": { |
1252 "type": "string" | 1037 "type": "string" |
1253 }, | 1038 }, |
1254 "description": "Labels describing the operation. Only the fo
llowing labels are allowed:\n\n- Labels describing monitored resources as define
d in\n the service configuration.\n- Default labels of metric values. When spec
ified, labels defined in the\n metric value override these default.\n- The foll
owing labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/loca
tion` describing the location where the\n operation happened,\n - `serv
icecontrol.googleapis.com/user_agent` describing the user agent\n of the A
PI request,\n - `servicecontrol.googleapis.com/service_agent` describing the
service\n used to handle the API request (e.g. ESP),\n - `servicecontro
l.googleapis.com/platform` describing the platform\n where the API is serv
ed (e.g. GAE, GCE, GKE).", | 1039 "description": "Labels describing the operation. Only the fo
llowing labels are allowed:\n\n- Labels describing monitored resources as define
d in\n the service configuration.\n- Default labels of metric values. When spec
ified, labels defined in the\n metric value override these default.\n- The foll
owing labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/loca
tion` describing the location where the\n operation happened,\n - `serv
icecontrol.googleapis.com/user_agent` describing the user agent\n of the A
PI request,\n - `servicecontrol.googleapis.com/service_agent` describing the
service\n used to handle the API request (e.g. ESP),\n - `servicecontro
l.googleapis.com/platform` describing the platform\n where the API is serv
ed (e.g. GAE, GCE, GKE).", |
1255 "type": "object" | 1040 "type": "object" |
1256 }, | 1041 }, |
1257 "logEntries": { | 1042 "logEntries": { |
1258 "description": "Represents information to be logged.", | 1043 "description": "Represents information to be logged.", |
1259 "items": { | 1044 "items": { |
(...skipping 19 matching lines...) Expand all Loading... |
1279 "$ref": "QuotaProperties", | 1064 "$ref": "QuotaProperties", |
1280 "description": "Represents the properties needed for quota c
heck. Applicable only if this\noperation is for a quota check request." | 1065 "description": "Represents the properties needed for quota c
heck. Applicable only if this\noperation is for a quota check request." |
1281 }, | 1066 }, |
1282 "consumerId": { | 1067 "consumerId": { |
1283 "description": "Identity of the consumer who is using the se
rvice.\nThis field should be filled in for the operations initiated by a\nconsum
er, but not for service-initiated operations that are\nnot related to a specific
consumer.\n\nThis can be in one of the following formats:\n project:<project_i
d>,\n project_number:<project_number>,\n api_key:<api_key>.", | 1068 "description": "Identity of the consumer who is using the se
rvice.\nThis field should be filled in for the operations initiated by a\nconsum
er, but not for service-initiated operations that are\nnot related to a specific
consumer.\n\nThis can be in one of the following formats:\n project:<project_i
d>,\n project_number:<project_number>,\n api_key:<api_key>.", |
1284 "type": "string" | 1069 "type": "string" |
1285 }, | 1070 }, |
1286 "operationId": { | 1071 "operationId": { |
1287 "description": "Identity of the operation. This must be uniq
ue within the scope of the\nservice that generated the operation. If the service
calls\nCheck() and Report() on the same operation, the two calls should carry\n
the same id.\n\nUUID version 4 is recommended, though not required.\nIn scenario
s where an operation is computed from existing information\nand an idempotent id
is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC
4122 for details.", | 1072 "description": "Identity of the operation. This must be uniq
ue within the scope of the\nservice that generated the operation. If the service
calls\nCheck() and Report() on the same operation, the two calls should carry\n
the same id.\n\nUUID version 4 is recommended, though not required.\nIn scenario
s where an operation is computed from existing information\nand an idempotent id
is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC
4122 for details.", |
1288 "type": "string" | 1073 "type": "string" |
1289 }, | |
1290 "endTime": { | |
1291 "description": "End time of the operation.\nRequired when th
e operation is used in ServiceController.Report,\nbut optional when the operatio
n is used in ServiceController.Check.", | |
1292 "format": "google-datetime", | |
1293 "type": "string" | |
1294 }, | |
1295 "operationName": { | |
1296 "description": "Fully qualified name of the operation. Reser
ved for future use.", | |
1297 "type": "string" | |
1298 }, | |
1299 "startTime": { | |
1300 "description": "Required. Start time of the operation.", | |
1301 "format": "google-datetime", | |
1302 "type": "string" | |
1303 }, | |
1304 "importance": { | |
1305 "description": "DO NOT USE. This is an experimental field.", | |
1306 "enum": [ | |
1307 "LOW", | |
1308 "HIGH", | |
1309 "DEBUG" | |
1310 ], | |
1311 "enumDescriptions": [ | |
1312 "The API implementation may cache and aggregate the data
.\nThe data may be lost when rare and unexpected system failures occur.", | |
1313 "The API implementation doesn't cache and aggregate the
data.\nIf the method returns successfully, it's guaranteed that the data has\nbe
en persisted in durable storage.", | |
1314 "In addition to the behavior described in HIGH, DEBUG en
ables\nadditional validation logic that is only useful during the onboarding\npr
ocess. This is only available to Google internal services and\nthe service must
be whitelisted by chemist-dev@google.com in order\nto use this level." | |
1315 ], | |
1316 "type": "string" | |
1317 }, | |
1318 "resourceContainer": { | |
1319 "description": "The resource name of the parent of a resourc
e in the resource hierarchy.\n\nThis can be in one of the following formats:\n
- “projects/<project-id or project-number>”\n - “folders/<folder-id>”\n
- “organizations/<organization-id>”", | |
1320 "type": "string" | |
1321 } | 1074 } |
1322 }, | 1075 }, |
1323 "type": "object" | 1076 "type": "object" |
1324 }, | 1077 }, |
1325 "ReportResponse": { | 1078 "ReportResponse": { |
1326 "description": "Response message for the Report method.", | 1079 "description": "Response message for the Report method.", |
1327 "id": "ReportResponse", | 1080 "id": "ReportResponse", |
1328 "properties": { | 1081 "properties": { |
1329 "reportErrors": { | 1082 "reportErrors": { |
1330 "description": "Partial failures, one for each `Operation` i
n the request that failed\nprocessing. There are three possible combinations of
the RPC status:\n\n1. The combination of a successful RPC status and an empty `r
eport_errors`\n list indicates a complete success where all `Operations` in th
e\n request are processed successfully.\n2. The combination of a successful RP
C status and a non-empty\n `report_errors` list indicates a partial success wh
ere some\n `Operations` in the request succeeded. Each\n `Operation` that fa
iled processing has a corresponding item\n in this list.\n3. A failed RPC stat
us indicates a general non-deterministic failure.\n When this happens, it's im
possible to know which of the\n 'Operations' in the request succeeded or faile
d.", | 1083 "description": "Partial failures, one for each `Operation` i
n the request that failed\nprocessing. There are three possible combinations of
the RPC status:\n\n1. The combination of a successful RPC status and an empty `r
eport_errors`\n list indicates a complete success where all `Operations` in th
e\n request are processed successfully.\n2. The combination of a successful RP
C status and a non-empty\n `report_errors` list indicates a partial success wh
ere some\n `Operations` in the request succeeded. Each\n `Operation` that fa
iled processing has a corresponding item\n in this list.\n3. A failed RPC stat
us indicates a general non-deterministic failure.\n When this happens, it's im
possible to know which of the\n 'Operations' in the request succeeded or faile
d.", |
1331 "items": { | 1084 "items": { |
1332 "$ref": "ReportError" | 1085 "$ref": "ReportError" |
1333 }, | 1086 }, |
1334 "type": "array" | 1087 "type": "array" |
1335 }, | 1088 }, |
1336 "reportInfos": { | 1089 "reportInfos": { |
1337 "description": "Quota usage for each quota release `Operatio
n` request.\n\nFully or partially failed quota release request may or may not be
present\nin `report_quota_info`. For example, a failed quota release request wi
ll\nhave the current quota usage info when precise quota library returns the\nin
fo. A deadline exceeded quota request will not have quota usage info.\n\nIf ther
e is no quota release request, report_quota_info will be empty.\n", | 1090 "description": "Quota usage for each quota release `Operatio
n` request.\n\nFully or partially failed quota release request may or may not be
present\nin `report_quota_info`. For example, a failed quota release request wi
ll\nhave the current quota usage info when precise quota library returns the\nin
fo. A deadline exceeded quota request will not have quota usage info.\n\nIf ther
e is no quota release request, report_quota_info will be empty.\n", |
1338 "items": { | 1091 "items": { |
1339 "$ref": "ReportInfo" | 1092 "$ref": "ReportInfo" |
1340 }, | 1093 }, |
1341 "type": "array" | 1094 "type": "array" |
1342 }, | 1095 }, |
1343 "serviceConfigId": { | 1096 "serviceConfigId": { |
1344 "description": "The actual config id used to process the req
uest.", | 1097 "description": "The actual config id used to process the req
uest.", |
1345 "type": "string" | 1098 "type": "string" |
1346 } | 1099 } |
1347 }, | 1100 }, |
1348 "type": "object" | 1101 "type": "object" |
| 1102 }, |
| 1103 "CheckResponse": { |
| 1104 "description": "Response message for the Check method.", |
| 1105 "id": "CheckResponse", |
| 1106 "properties": { |
| 1107 "checkInfo": { |
| 1108 "$ref": "CheckInfo", |
| 1109 "description": "Feedback data returned from the server durin
g processing a Check request." |
| 1110 }, |
| 1111 "checkErrors": { |
| 1112 "description": "Indicate the decision of the check.\n\nIf no
check errors are present, the service should process the operation.\nOtherwise
the service should use the list of errors to determine the\nappropriate action."
, |
| 1113 "items": { |
| 1114 "$ref": "CheckError" |
| 1115 }, |
| 1116 "type": "array" |
| 1117 }, |
| 1118 "operationId": { |
| 1119 "description": "The same operation_id value used in the Chec
kRequest.\nUsed for logging and diagnostics purposes.", |
| 1120 "type": "string" |
| 1121 }, |
| 1122 "serviceConfigId": { |
| 1123 "description": "The actual config id used to process the req
uest.", |
| 1124 "type": "string" |
| 1125 }, |
| 1126 "quotaInfo": { |
| 1127 "$ref": "QuotaInfo", |
| 1128 "description": "Quota information for the check request asso
ciated with this response.\n" |
| 1129 } |
| 1130 }, |
| 1131 "type": "object" |
| 1132 }, |
| 1133 "Status": { |
| 1134 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
| 1135 "id": "Status", |
| 1136 "properties": { |
| 1137 "details": { |
| 1138 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 1139 "items": { |
| 1140 "additionalProperties": { |
| 1141 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1142 "type": "any" |
| 1143 }, |
| 1144 "type": "object" |
| 1145 }, |
| 1146 "type": "array" |
| 1147 }, |
| 1148 "code": { |
| 1149 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1150 "format": "int32", |
| 1151 "type": "integer" |
| 1152 }, |
| 1153 "message": { |
| 1154 "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.", |
| 1155 "type": "string" |
| 1156 } |
| 1157 }, |
| 1158 "type": "object" |
| 1159 }, |
| 1160 "ReportRequest": { |
| 1161 "description": "Request message for the Report method.", |
| 1162 "id": "ReportRequest", |
| 1163 "properties": { |
| 1164 "serviceConfigId": { |
| 1165 "description": "Specifies which version of service config sh
ould be used to process the\nrequest.\n\nIf unspecified or no matching version c
an be found, the\nlatest one will be used.", |
| 1166 "type": "string" |
| 1167 }, |
| 1168 "operations": { |
| 1169 "description": "Operations to be reported.\n\nTypically the
service should report one operation per request.\nPutting multiple operations in
to a single request is allowed, but should\nbe used only when multiple operation
s are natually available at the time\nof the report.\n\nIf multiple operations a
re in a single request, the total request size\nshould be no larger than 1MB. Se
e ReportResponse.report_errors for\npartial failure behavior.", |
| 1170 "items": { |
| 1171 "$ref": "Operation" |
| 1172 }, |
| 1173 "type": "array" |
| 1174 } |
| 1175 }, |
| 1176 "type": "object" |
| 1177 }, |
| 1178 "AuditLog": { |
| 1179 "description": "Common audit log format for Google Cloud Platform AP
I operations.\n\n", |
| 1180 "id": "AuditLog", |
| 1181 "properties": { |
| 1182 "request": { |
| 1183 "additionalProperties": { |
| 1184 "description": "Properties of the object.", |
| 1185 "type": "any" |
| 1186 }, |
| 1187 "description": "The operation request. This may not include
all request parameters,\nsuch as those that are too large, privacy-sensitive, or
duplicated\nelsewhere in the log record.\nIt should never include user-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", |
| 1188 "type": "object" |
| 1189 }, |
| 1190 "requestMetadata": { |
| 1191 "$ref": "RequestMetadata", |
| 1192 "description": "Metadata about the operation." |
| 1193 }, |
| 1194 "serviceData": { |
| 1195 "additionalProperties": { |
| 1196 "description": "Properties of the object. Contains field
@type with type URL.", |
| 1197 "type": "any" |
| 1198 }, |
| 1199 "description": "Other service-specific data about the reques
t, response, and other\nactivities.", |
| 1200 "type": "object" |
| 1201 }, |
| 1202 "numResponseItems": { |
| 1203 "description": "The number of items returned from a List or
Query API method,\nif applicable.", |
| 1204 "format": "int64", |
| 1205 "type": "string" |
| 1206 }, |
| 1207 "status": { |
| 1208 "$ref": "Status", |
| 1209 "description": "The status of the overall operation." |
| 1210 }, |
| 1211 "authenticationInfo": { |
| 1212 "$ref": "AuthenticationInfo", |
| 1213 "description": "Authentication information." |
| 1214 }, |
| 1215 "serviceName": { |
| 1216 "description": "The name of the API service performing the o
peration. For example,\n`\"datastore.googleapis.com\"`.", |
| 1217 "type": "string" |
| 1218 }, |
| 1219 "response": { |
| 1220 "additionalProperties": { |
| 1221 "description": "Properties of the object.", |
| 1222 "type": "any" |
| 1223 }, |
| 1224 "description": "The operation response. This may not include
all response elements,\nsuch as those that are too large, privacy-sensitive, or
duplicated\nelsewhere in the log record.\nIt should never include user-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", |
| 1225 "type": "object" |
| 1226 }, |
| 1227 "methodName": { |
| 1228 "description": "The name of the service method or operation.
\nFor API calls, this should be the name of the API method.\nFor example,\n\n
\"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingServ
ice.DeleteLog\"", |
| 1229 "type": "string" |
| 1230 }, |
| 1231 "resourceName": { |
| 1232 "description": "The resource or collection that is the targe
t of the operation.\nThe name is a scheme-less URI, not including the API servic
e name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/
books/BOOK_ID\"", |
| 1233 "type": "string" |
| 1234 }, |
| 1235 "authorizationInfo": { |
| 1236 "description": "Authorization information. If there are mult
iple\nresources or permissions involved, then there is\none AuthorizationInfo el
ement for each {resource, permission} tuple.", |
| 1237 "items": { |
| 1238 "$ref": "AuthorizationInfo" |
| 1239 }, |
| 1240 "type": "array" |
| 1241 } |
| 1242 }, |
| 1243 "type": "object" |
| 1244 }, |
| 1245 "LogEntry": { |
| 1246 "description": "An individual log entry.", |
| 1247 "id": "LogEntry", |
| 1248 "properties": { |
| 1249 "labels": { |
| 1250 "additionalProperties": { |
| 1251 "type": "string" |
| 1252 }, |
| 1253 "description": "A set of user-defined (key, value) data that
provides additional\ninformation about the log entry.", |
| 1254 "type": "object" |
| 1255 }, |
| 1256 "severity": { |
| 1257 "description": "The severity of the log entry. The default v
alue is\n`LogSeverity.DEFAULT`.", |
| 1258 "enum": [ |
| 1259 "DEFAULT", |
| 1260 "DEBUG", |
| 1261 "INFO", |
| 1262 "NOTICE", |
| 1263 "WARNING", |
| 1264 "ERROR", |
| 1265 "CRITICAL", |
| 1266 "ALERT", |
| 1267 "EMERGENCY" |
| 1268 ], |
| 1269 "enumDescriptions": [ |
| 1270 "(0) The log entry has no assigned severity level.", |
| 1271 "(100) Debug or trace information.", |
| 1272 "(200) Routine information, such as ongoing status or pe
rformance.", |
| 1273 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", |
| 1274 "(400) Warning events might cause problems.", |
| 1275 "(500) Error events are likely to cause problems.", |
| 1276 "(600) Critical events cause more severe problems or out
ages.", |
| 1277 "(700) A person must take an action immediately.", |
| 1278 "(800) One or more systems are unusable." |
| 1279 ], |
| 1280 "type": "string" |
| 1281 }, |
| 1282 "insertId": { |
| 1283 "description": "A unique ID for the log entry used for dedup
lication. If omitted,\nthe implementation will generate one based on operation_i
d.", |
| 1284 "type": "string" |
| 1285 }, |
| 1286 "name": { |
| 1287 "description": "Required. The log to which this log entry be
longs. Examples: `\"syslog\"`,\n`\"book_log\"`.", |
| 1288 "type": "string" |
| 1289 }, |
| 1290 "structPayload": { |
| 1291 "additionalProperties": { |
| 1292 "description": "Properties of the object.", |
| 1293 "type": "any" |
| 1294 }, |
| 1295 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", |
| 1296 "type": "object" |
| 1297 }, |
| 1298 "textPayload": { |
| 1299 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", |
| 1300 "type": "string" |
| 1301 }, |
| 1302 "protoPayload": { |
| 1303 "additionalProperties": { |
| 1304 "description": "Properties of the object. Contains field
@type with type URL.", |
| 1305 "type": "any" |
| 1306 }, |
| 1307 "description": "The log entry payload, represented as a prot
ocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload
`\nvalues that belong to a set of approved types.", |
| 1308 "type": "object" |
| 1309 }, |
| 1310 "timestamp": { |
| 1311 "description": "The time the event described by the log entr
y occurred. If\nomitted, defaults to operation start time.", |
| 1312 "format": "google-datetime", |
| 1313 "type": "string" |
| 1314 } |
| 1315 }, |
| 1316 "type": "object" |
| 1317 }, |
| 1318 "MetricValue": { |
| 1319 "description": "Represents a single metric value.", |
| 1320 "id": "MetricValue", |
| 1321 "properties": { |
| 1322 "boolValue": { |
| 1323 "description": "A boolean value.", |
| 1324 "type": "boolean" |
| 1325 }, |
| 1326 "endTime": { |
| 1327 "description": "The end of the time period over which this m
etric value's measurement\napplies.", |
| 1328 "format": "google-datetime", |
| 1329 "type": "string" |
| 1330 }, |
| 1331 "startTime": { |
| 1332 "description": "The start of the time period over which this
metric value's measurement\napplies. The time period has different semantics fo
r different metric\ntypes (cumulative, delta, and gauge). See the metric definit
ion\ndocumentation in the service configuration for details.", |
| 1333 "format": "google-datetime", |
| 1334 "type": "string" |
| 1335 }, |
| 1336 "moneyValue": { |
| 1337 "$ref": "Money", |
| 1338 "description": "A money value." |
| 1339 }, |
| 1340 "labels": { |
| 1341 "additionalProperties": { |
| 1342 "type": "string" |
| 1343 }, |
| 1344 "description": "The labels describing the metric value.\nSee
comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r
elationship.", |
| 1345 "type": "object" |
| 1346 }, |
| 1347 "stringValue": { |
| 1348 "description": "A text string value.", |
| 1349 "type": "string" |
| 1350 }, |
| 1351 "doubleValue": { |
| 1352 "description": "A double precision floating point value.", |
| 1353 "format": "double", |
| 1354 "type": "number" |
| 1355 }, |
| 1356 "int64Value": { |
| 1357 "description": "A signed 64-bit integer value.", |
| 1358 "format": "int64", |
| 1359 "type": "string" |
| 1360 }, |
| 1361 "distributionValue": { |
| 1362 "$ref": "Distribution", |
| 1363 "description": "A distribution value." |
| 1364 } |
| 1365 }, |
| 1366 "type": "object" |
1349 } | 1367 } |
1350 }, | 1368 }, |
1351 "servicePath": "", | 1369 "servicePath": "", |
1352 "title": "Google Service Control API", | 1370 "title": "Google Service Control API", |
1353 "version": "v1" | 1371 "version": "v1" |
1354 } | 1372 } |
OLD | NEW |