1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://gkehub.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "GKE Hub",
15 "description": "",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "gkehub:v2alpha",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://gkehub.mtls.googleapis.com/",
26 "name": "gkehub",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "projects": {
109 "resources": {
110 "locations": {
111 "methods": {
112 "get": {
113 "description": "Gets information about a location.",
114 "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}",
115 "httpMethod": "GET",
116 "id": "gkehub.projects.locations.get",
117 "parameterOrder": [
118 "name"
119 ],
120 "parameters": {
121 "name": {
122 "description": "Resource name for the location.",
123 "location": "path",
124 "pattern": "^projects/[^/]+/locations/[^/]+$",
125 "required": true,
126 "type": "string"
127 }
128 },
129 "path": "v2alpha/{+name}",
130 "response": {
131 "$ref": "Location"
132 },
133 "scopes": [
134 "https://www.googleapis.com/auth/cloud-platform"
135 ]
136 },
137 "list": {
138 "description": "Lists information about the supported locations for this service.",
139 "flatPath": "v2alpha/projects/{projectsId}/locations",
140 "httpMethod": "GET",
141 "id": "gkehub.projects.locations.list",
142 "parameterOrder": [
143 "name"
144 ],
145 "parameters": {
146 "filter": {
147 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
148 "location": "query",
149 "type": "string"
150 },
151 "name": {
152 "description": "The resource that owns the locations collection, if applicable.",
153 "location": "path",
154 "pattern": "^projects/[^/]+$",
155 "required": true,
156 "type": "string"
157 },
158 "pageSize": {
159 "description": "The maximum number of results to return. If not set, the service selects a default.",
160 "format": "int32",
161 "location": "query",
162 "type": "integer"
163 },
164 "pageToken": {
165 "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
166 "location": "query",
167 "type": "string"
168 }
169 },
170 "path": "v2alpha/{+name}/locations",
171 "response": {
172 "$ref": "ListLocationsResponse"
173 },
174 "scopes": [
175 "https://www.googleapis.com/auth/cloud-platform"
176 ]
177 }
178 },
179 "resources": {
180 "operations": {
181 "methods": {
182 "cancel": {
183 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
184 "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
185 "httpMethod": "POST",
186 "id": "gkehub.projects.locations.operations.cancel",
187 "parameterOrder": [
188 "name"
189 ],
190 "parameters": {
191 "name": {
192 "description": "The name of the operation resource to be cancelled.",
193 "location": "path",
194 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
195 "required": true,
196 "type": "string"
197 }
198 },
199 "path": "v2alpha/{+name}:cancel",
200 "request": {
201 "$ref": "CancelOperationRequest"
202 },
203 "response": {
204 "$ref": "Empty"
205 },
206 "scopes": [
207 "https://www.googleapis.com/auth/cloud-platform"
208 ]
209 },
210 "get": {
211 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
212 "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
213 "httpMethod": "GET",
214 "id": "gkehub.projects.locations.operations.get",
215 "parameterOrder": [
216 "name"
217 ],
218 "parameters": {
219 "name": {
220 "description": "The name of the operation resource.",
221 "location": "path",
222 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
223 "required": true,
224 "type": "string"
225 }
226 },
227 "path": "v2alpha/{+name}",
228 "response": {
229 "$ref": "Operation"
230 },
231 "scopes": [
232 "https://www.googleapis.com/auth/cloud-platform"
233 ]
234 },
235 "list": {
236 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
237 "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/operations",
238 "httpMethod": "GET",
239 "id": "gkehub.projects.locations.operations.list",
240 "parameterOrder": [
241 "name"
242 ],
243 "parameters": {
244 "filter": {
245 "description": "The standard list filter.",
246 "location": "query",
247 "type": "string"
248 },
249 "name": {
250 "description": "The name of the operation's parent resource.",
251 "location": "path",
252 "pattern": "^projects/[^/]+/locations/[^/]+$",
253 "required": true,
254 "type": "string"
255 },
256 "pageSize": {
257 "description": "The standard list page size.",
258 "format": "int32",
259 "location": "query",
260 "type": "integer"
261 },
262 "pageToken": {
263 "description": "The standard list page token.",
264 "location": "query",
265 "type": "string"
266 }
267 },
268 "path": "v2alpha/{+name}/operations",
269 "response": {
270 "$ref": "ListOperationsResponse"
271 },
272 "scopes": [
273 "https://www.googleapis.com/auth/cloud-platform"
274 ]
275 }
276 }
277 }
278 }
279 }
280 }
281 }
282 },
283 "revision": "20230804",
284 "rootUrl": "https://gkehub.googleapis.com/",
285 "schemas": {
286 "CancelOperationRequest": {
287 "description": "The request message for Operations.CancelOperation.",
288 "id": "CancelOperationRequest",
289 "properties": {},
290 "type": "object"
291 },
292 "Empty": {
293 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
294 "id": "Empty",
295 "properties": {},
296 "type": "object"
297 },
298 "GoogleRpcStatus": {
299 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
300 "id": "GoogleRpcStatus",
301 "properties": {
302 "code": {
303 "description": "The status code, which should be an enum value of google.rpc.Code.",
304 "format": "int32",
305 "type": "integer"
306 },
307 "details": {
308 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
309 "items": {
310 "additionalProperties": {
311 "description": "Properties of the object. Contains field @type with type URL.",
312 "type": "any"
313 },
314 "type": "object"
315 },
316 "type": "array"
317 },
318 "message": {
319 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
320 "type": "string"
321 }
322 },
323 "type": "object"
324 },
325 "ListLocationsResponse": {
326 "description": "The response message for Locations.ListLocations.",
327 "id": "ListLocationsResponse",
328 "properties": {
329 "locations": {
330 "description": "A list of locations that matches the specified filter in the request.",
331 "items": {
332 "$ref": "Location"
333 },
334 "type": "array"
335 },
336 "nextPageToken": {
337 "description": "The standard List next-page token.",
338 "type": "string"
339 }
340 },
341 "type": "object"
342 },
343 "ListOperationsResponse": {
344 "description": "The response message for Operations.ListOperations.",
345 "id": "ListOperationsResponse",
346 "properties": {
347 "nextPageToken": {
348 "description": "The standard List next-page token.",
349 "type": "string"
350 },
351 "operations": {
352 "description": "A list of operations that matches the specified filter in the request.",
353 "items": {
354 "$ref": "Operation"
355 },
356 "type": "array"
357 }
358 },
359 "type": "object"
360 },
361 "Location": {
362 "description": "A resource that represents a Google Cloud location.",
363 "id": "Location",
364 "properties": {
365 "displayName": {
366 "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
367 "type": "string"
368 },
369 "labels": {
370 "additionalProperties": {
371 "type": "string"
372 },
373 "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
374 "type": "object"
375 },
376 "locationId": {
377 "description": "The canonical id for this location. For example: `\"us-east1\"`.",
378 "type": "string"
379 },
380 "metadata": {
381 "additionalProperties": {
382 "description": "Properties of the object. Contains field @type with type URL.",
383 "type": "any"
384 },
385 "description": "Service-specific metadata. For example the available capacity at the given location.",
386 "type": "object"
387 },
388 "name": {
389 "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
390 "type": "string"
391 }
392 },
393 "type": "object"
394 },
395 "Operation": {
396 "description": "This resource represents a long-running operation that is the result of a network API call.",
397 "id": "Operation",
398 "properties": {
399 "done": {
400 "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
401 "type": "boolean"
402 },
403 "error": {
404 "$ref": "GoogleRpcStatus",
405 "description": "The error result of the operation in case of failure or cancellation."
406 },
407 "metadata": {
408 "additionalProperties": {
409 "description": "Properties of the object. Contains field @type with type URL.",
410 "type": "any"
411 },
412 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
413 "type": "object"
414 },
415 "name": {
416 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
417 "type": "string"
418 },
419 "response": {
420 "additionalProperties": {
421 "description": "Properties of the object. Contains field @type with type URL.",
422 "type": "any"
423 },
424 "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
425 "type": "object"
426 }
427 },
428 "type": "object"
429 }
430 },
431 "servicePath": "",
432 "title": "GKE Hub API",
433 "version": "v2alpha",
434 "version_module": true
435}View as plain text