|
179 | 179 | "resources": { |
180 | 180 | "federations": { |
181 | 181 | "methods": { |
| 182 | + "create": { |
| 183 | + "description": "Creates a metastore federation in a project and location.", |
| 184 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations", |
| 185 | + "httpMethod": "POST", |
| 186 | + "id": "metastore.projects.locations.federations.create", |
| 187 | + "parameterOrder": [ |
| 188 | + "parent" |
| 189 | + ], |
| 190 | + "parameters": { |
| 191 | + "federationId": { |
| 192 | + "description": "Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", |
| 193 | + "location": "query", |
| 194 | + "type": "string" |
| 195 | + }, |
| 196 | + "parent": { |
| 197 | + "description": "Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.", |
| 198 | + "location": "path", |
| 199 | + "pattern": "^projects/[^/]+/locations/[^/]+$", |
| 200 | + "required": true, |
| 201 | + "type": "string" |
| 202 | + }, |
| 203 | + "requestId": { |
| 204 | + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", |
| 205 | + "location": "query", |
| 206 | + "type": "string" |
| 207 | + } |
| 208 | + }, |
| 209 | + "path": "v1alpha/{+parent}/federations", |
| 210 | + "request": { |
| 211 | + "$ref": "Federation" |
| 212 | + }, |
| 213 | + "response": { |
| 214 | + "$ref": "Operation" |
| 215 | + }, |
| 216 | + "scopes": [ |
| 217 | + "https://www.googleapis.com/auth/cloud-platform" |
| 218 | + ] |
| 219 | + }, |
| 220 | + "delete": { |
| 221 | + "description": "Deletes a single federation.", |
| 222 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", |
| 223 | + "httpMethod": "DELETE", |
| 224 | + "id": "metastore.projects.locations.federations.delete", |
| 225 | + "parameterOrder": [ |
| 226 | + "name" |
| 227 | + ], |
| 228 | + "parameters": { |
| 229 | + "name": { |
| 230 | + "description": "Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.", |
| 231 | + "location": "path", |
| 232 | + "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", |
| 233 | + "required": true, |
| 234 | + "type": "string" |
| 235 | + }, |
| 236 | + "requestId": { |
| 237 | + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", |
| 238 | + "location": "query", |
| 239 | + "type": "string" |
| 240 | + } |
| 241 | + }, |
| 242 | + "path": "v1alpha/{+name}", |
| 243 | + "response": { |
| 244 | + "$ref": "Operation" |
| 245 | + }, |
| 246 | + "scopes": [ |
| 247 | + "https://www.googleapis.com/auth/cloud-platform" |
| 248 | + ] |
| 249 | + }, |
| 250 | + "get": { |
| 251 | + "description": "Gets the details of a single federation.", |
| 252 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", |
| 253 | + "httpMethod": "GET", |
| 254 | + "id": "metastore.projects.locations.federations.get", |
| 255 | + "parameterOrder": [ |
| 256 | + "name" |
| 257 | + ], |
| 258 | + "parameters": { |
| 259 | + "name": { |
| 260 | + "description": "Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.", |
| 261 | + "location": "path", |
| 262 | + "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", |
| 263 | + "required": true, |
| 264 | + "type": "string" |
| 265 | + } |
| 266 | + }, |
| 267 | + "path": "v1alpha/{+name}", |
| 268 | + "response": { |
| 269 | + "$ref": "Federation" |
| 270 | + }, |
| 271 | + "scopes": [ |
| 272 | + "https://www.googleapis.com/auth/cloud-platform" |
| 273 | + ] |
| 274 | + }, |
182 | 275 | "getIamPolicy": { |
183 | 276 | "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", |
184 | 277 | "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy", |
|
210 | 303 | "https://www.googleapis.com/auth/cloud-platform" |
211 | 304 | ] |
212 | 305 | }, |
| 306 | + "list": { |
| 307 | + "description": "Lists federations in a project and location.", |
| 308 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations", |
| 309 | + "httpMethod": "GET", |
| 310 | + "id": "metastore.projects.locations.federations.list", |
| 311 | + "parameterOrder": [ |
| 312 | + "parent" |
| 313 | + ], |
| 314 | + "parameters": { |
| 315 | + "filter": { |
| 316 | + "description": "Optional. The filter to apply to list results.", |
| 317 | + "location": "query", |
| 318 | + "type": "string" |
| 319 | + }, |
| 320 | + "orderBy": { |
| 321 | + "description": "Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.", |
| 322 | + "location": "query", |
| 323 | + "type": "string" |
| 324 | + }, |
| 325 | + "pageSize": { |
| 326 | + "description": "Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.", |
| 327 | + "format": "int32", |
| 328 | + "location": "query", |
| 329 | + "type": "integer" |
| 330 | + }, |
| 331 | + "pageToken": { |
| 332 | + "description": "Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to ListFederationServices must match the call that provided the page token.", |
| 333 | + "location": "query", |
| 334 | + "type": "string" |
| 335 | + }, |
| 336 | + "parent": { |
| 337 | + "description": "Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.", |
| 338 | + "location": "path", |
| 339 | + "pattern": "^projects/[^/]+/locations/[^/]+$", |
| 340 | + "required": true, |
| 341 | + "type": "string" |
| 342 | + } |
| 343 | + }, |
| 344 | + "path": "v1alpha/{+parent}/federations", |
| 345 | + "response": { |
| 346 | + "$ref": "ListFederationsResponse" |
| 347 | + }, |
| 348 | + "scopes": [ |
| 349 | + "https://www.googleapis.com/auth/cloud-platform" |
| 350 | + ] |
| 351 | + }, |
| 352 | + "patch": { |
| 353 | + "description": "Updates the fields of a federation.", |
| 354 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}", |
| 355 | + "httpMethod": "PATCH", |
| 356 | + "id": "metastore.projects.locations.federations.patch", |
| 357 | + "parameterOrder": [ |
| 358 | + "name" |
| 359 | + ], |
| 360 | + "parameters": { |
| 361 | + "name": { |
| 362 | + "description": "Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.", |
| 363 | + "location": "path", |
| 364 | + "pattern": "^projects/[^/]+/locations/[^/]+/federations/[^/]+$", |
| 365 | + "required": true, |
| 366 | + "type": "string" |
| 367 | + }, |
| 368 | + "requestId": { |
| 369 | + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", |
| 370 | + "location": "query", |
| 371 | + "type": "string" |
| 372 | + }, |
| 373 | + "updateMask": { |
| 374 | + "description": "Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", |
| 375 | + "format": "google-fieldmask", |
| 376 | + "location": "query", |
| 377 | + "type": "string" |
| 378 | + } |
| 379 | + }, |
| 380 | + "path": "v1alpha/{+name}", |
| 381 | + "request": { |
| 382 | + "$ref": "Federation" |
| 383 | + }, |
| 384 | + "response": { |
| 385 | + "$ref": "Operation" |
| 386 | + }, |
| 387 | + "scopes": [ |
| 388 | + "https://www.googleapis.com/auth/cloud-platform" |
| 389 | + ] |
| 390 | + }, |
213 | 391 | "setIamPolicy": { |
214 | 392 | "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", |
215 | 393 | "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy", |
|
1289 | 1467 | } |
1290 | 1468 | } |
1291 | 1469 | }, |
1292 | | - "revision": "20220602", |
| 1470 | + "revision": "20220615", |
1293 | 1471 | "rootUrl": "https://metastore.googleapis.com/", |
1294 | 1472 | "schemas": { |
1295 | 1473 | "AuditConfig": { |
|
1363 | 1541 | }, |
1364 | 1542 | "type": "object" |
1365 | 1543 | }, |
| 1544 | + "BackendMetastore": { |
| 1545 | + "description": "Represents a backend metastore for the federation.", |
| 1546 | + "id": "BackendMetastore", |
| 1547 | + "properties": { |
| 1548 | + "metastoreType": { |
| 1549 | + "description": "The type of the backend metastore.", |
| 1550 | + "enum": [ |
| 1551 | + "METASTORE_TYPE_UNSPECIFIED", |
| 1552 | + "DATAPROC_METASTORE" |
| 1553 | + ], |
| 1554 | + "enumDescriptions": [ |
| 1555 | + "The metastore type is not set.", |
| 1556 | + "The backend metastore is Dataproc Metastore." |
| 1557 | + ], |
| 1558 | + "type": "string" |
| 1559 | + }, |
| 1560 | + "name": { |
| 1561 | + "description": "The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{project_id}/locations/{location}/lakes/{lake_id} BigQuery: projects/{project_id} Dataproc Metastore: projects/{project_id}/locations/{location}/services/{service_id}", |
| 1562 | + "type": "string" |
| 1563 | + } |
| 1564 | + }, |
| 1565 | + "type": "object" |
| 1566 | + }, |
1366 | 1567 | "Backup": { |
1367 | 1568 | "description": "The details of a backup resource.", |
1368 | 1569 | "id": "Backup", |
|
1597 | 1798 | }, |
1598 | 1799 | "type": "object" |
1599 | 1800 | }, |
| 1801 | + "Federation": { |
| 1802 | + "description": "Represents a federation of multiple backend metastores.", |
| 1803 | + "id": "Federation", |
| 1804 | + "properties": { |
| 1805 | + "backendMetastores": { |
| 1806 | + "additionalProperties": { |
| 1807 | + "$ref": "BackendMetastore" |
| 1808 | + }, |
| 1809 | + "description": "A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key is an integer that represents the order in which BackendMetastores should be evaluated to resolve database names at query time. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.", |
| 1810 | + "type": "object" |
| 1811 | + }, |
| 1812 | + "createTime": { |
| 1813 | + "description": "Output only. The time when the metastore federation was created.", |
| 1814 | + "format": "google-datetime", |
| 1815 | + "readOnly": true, |
| 1816 | + "type": "string" |
| 1817 | + }, |
| 1818 | + "endpointUri": { |
| 1819 | + "description": "Output only. The federation endpoint.", |
| 1820 | + "readOnly": true, |
| 1821 | + "type": "string" |
| 1822 | + }, |
| 1823 | + "labels": { |
| 1824 | + "additionalProperties": { |
| 1825 | + "type": "string" |
| 1826 | + }, |
| 1827 | + "description": "User-defined labels for the metastore federation.", |
| 1828 | + "type": "object" |
| 1829 | + }, |
| 1830 | + "name": { |
| 1831 | + "description": "Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.", |
| 1832 | + "type": "string" |
| 1833 | + }, |
| 1834 | + "state": { |
| 1835 | + "description": "Output only. The current state of the federation.", |
| 1836 | + "enum": [ |
| 1837 | + "STATE_UNSPECIFIED", |
| 1838 | + "CREATING", |
| 1839 | + "ACTIVE", |
| 1840 | + "UPDATING", |
| 1841 | + "DELETING", |
| 1842 | + "ERROR" |
| 1843 | + ], |
| 1844 | + "enumDescriptions": [ |
| 1845 | + "The state of the metastore federation is unknown.", |
| 1846 | + "The metastore federation is in the process of being created.", |
| 1847 | + "The metastore federation is running and ready to serve queries.", |
| 1848 | + "The metastore federation is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", |
| 1849 | + "The metastore federation is undergoing deletion. It cannot be used.", |
| 1850 | + "The metastore federation has encountered an error and cannot be used. The metastore federation should be deleted." |
| 1851 | + ], |
| 1852 | + "readOnly": true, |
| 1853 | + "type": "string" |
| 1854 | + }, |
| 1855 | + "stateMessage": { |
| 1856 | + "description": "Output only. Additional information about the current state of the metastore federation, if available.", |
| 1857 | + "readOnly": true, |
| 1858 | + "type": "string" |
| 1859 | + }, |
| 1860 | + "uid": { |
| 1861 | + "description": "Output only. The globally unique resource identifier of the metastore federation.", |
| 1862 | + "readOnly": true, |
| 1863 | + "type": "string" |
| 1864 | + }, |
| 1865 | + "updateTime": { |
| 1866 | + "description": "Output only. The time when the metastore federation was last updated.", |
| 1867 | + "format": "google-datetime", |
| 1868 | + "readOnly": true, |
| 1869 | + "type": "string" |
| 1870 | + }, |
| 1871 | + "version": { |
| 1872 | + "description": "Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.", |
| 1873 | + "type": "string" |
| 1874 | + } |
| 1875 | + }, |
| 1876 | + "type": "object" |
| 1877 | + }, |
1600 | 1878 | "HiveMetastoreConfig": { |
1601 | 1879 | "description": "Specifies configuration information specific to running Hive metastore software as the metastore service.", |
1602 | 1880 | "id": "HiveMetastoreConfig", |
|
1710 | 1988 | }, |
1711 | 1989 | "type": "object" |
1712 | 1990 | }, |
| 1991 | + "ListFederationsResponse": { |
| 1992 | + "description": "Response message for ListFederations", |
| 1993 | + "id": "ListFederationsResponse", |
| 1994 | + "properties": { |
| 1995 | + "federations": { |
| 1996 | + "description": "The services in the specified location.", |
| 1997 | + "items": { |
| 1998 | + "$ref": "Federation" |
| 1999 | + }, |
| 2000 | + "type": "array" |
| 2001 | + }, |
| 2002 | + "nextPageToken": { |
| 2003 | + "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", |
| 2004 | + "type": "string" |
| 2005 | + }, |
| 2006 | + "unreachable": { |
| 2007 | + "description": "Locations that could not be reached.", |
| 2008 | + "items": { |
| 2009 | + "type": "string" |
| 2010 | + }, |
| 2011 | + "type": "array" |
| 2012 | + } |
| 2013 | + }, |
| 2014 | + "type": "object" |
| 2015 | + }, |
1713 | 2016 | "ListLocationsResponse": { |
1714 | 2017 | "description": "The response message for Locations.ListLocations.", |
1715 | 2018 | "id": "ListLocationsResponse", |
|
0 commit comments