...

Text file src/google.golang.org/api/biglake/v1/biglake-api.json

Documentation: google.golang.org/api/biglake/v1

     1{
     2  "auth": {
     3    "oauth2": {
     4      "scopes": {
     5        "https://www.googleapis.com/auth/bigquery": {
     6          "description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
     7        },
     8        "https://www.googleapis.com/auth/cloud-platform": {
     9          "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
    10        }
    11      }
    12    }
    13  },
    14  "basePath": "",
    15  "baseUrl": "https://biglake.googleapis.com/",
    16  "batchPath": "batch",
    17  "canonicalName": "BigLake Service",
    18  "description": "The BigLake API provides access to BigLake Metastore, a serverless, fully managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery.",
    19  "discoveryVersion": "v1",
    20  "documentationLink": "https://cloud.google.com/bigquery/",
    21  "fullyEncodeReservedExpansion": true,
    22  "icons": {
    23    "x16": "http://www.google.com/images/icons/product/search-16.gif",
    24    "x32": "http://www.google.com/images/icons/product/search-32.gif"
    25  },
    26  "id": "biglake:v1",
    27  "kind": "discovery#restDescription",
    28  "mtlsRootUrl": "https://biglake.mtls.googleapis.com/",
    29  "name": "biglake",
    30  "ownerDomain": "google.com",
    31  "ownerName": "Google",
    32  "parameters": {
    33    "$.xgafv": {
    34      "description": "V1 error format.",
    35      "enum": [
    36        "1",
    37        "2"
    38      ],
    39      "enumDescriptions": [
    40        "v1 error format",
    41        "v2 error format"
    42      ],
    43      "location": "query",
    44      "type": "string"
    45    },
    46    "access_token": {
    47      "description": "OAuth access token.",
    48      "location": "query",
    49      "type": "string"
    50    },
    51    "alt": {
    52      "default": "json",
    53      "description": "Data format for response.",
    54      "enum": [
    55        "json",
    56        "media",
    57        "proto"
    58      ],
    59      "enumDescriptions": [
    60        "Responses with Content-Type of application/json",
    61        "Media download with context-dependent Content-Type",
    62        "Responses with Content-Type of application/x-protobuf"
    63      ],
    64      "location": "query",
    65      "type": "string"
    66    },
    67    "callback": {
    68      "description": "JSONP",
    69      "location": "query",
    70      "type": "string"
    71    },
    72    "fields": {
    73      "description": "Selector specifying which fields to include in a partial response.",
    74      "location": "query",
    75      "type": "string"
    76    },
    77    "key": {
    78      "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.",
    79      "location": "query",
    80      "type": "string"
    81    },
    82    "oauth_token": {
    83      "description": "OAuth 2.0 token for the current user.",
    84      "location": "query",
    85      "type": "string"
    86    },
    87    "prettyPrint": {
    88      "default": "true",
    89      "description": "Returns response with indentations and line breaks.",
    90      "location": "query",
    91      "type": "boolean"
    92    },
    93    "quotaUser": {
    94      "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.",
    95      "location": "query",
    96      "type": "string"
    97    },
    98    "uploadType": {
    99      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
   100      "location": "query",
   101      "type": "string"
   102    },
   103    "upload_protocol": {
   104      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
   105      "location": "query",
   106      "type": "string"
   107    }
   108  },
   109  "protocol": "rest",
   110  "resources": {
   111    "projects": {
   112      "resources": {
   113        "locations": {
   114          "resources": {
   115            "catalogs": {
   116              "methods": {
   117                "create": {
   118                  "description": "Creates a new catalog.",
   119                  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs",
   120                  "httpMethod": "POST",
   121                  "id": "biglake.projects.locations.catalogs.create",
   122                  "parameterOrder": [
   123                    "parent"
   124                  ],
   125                  "parameters": {
   126                    "catalogId": {
   127                      "description": "Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.",
   128                      "location": "query",
   129                      "type": "string"
   130                    },
   131                    "parent": {
   132                      "description": "Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}",
   133                      "location": "path",
   134                      "pattern": "^projects/[^/]+/locations/[^/]+$",
   135                      "required": true,
   136                      "type": "string"
   137                    }
   138                  },
   139                  "path": "v1/{+parent}/catalogs",
   140                  "request": {
   141                    "$ref": "Catalog"
   142                  },
   143                  "response": {
   144                    "$ref": "Catalog"
   145                  },
   146                  "scopes": [
   147                    "https://www.googleapis.com/auth/bigquery",
   148                    "https://www.googleapis.com/auth/cloud-platform"
   149                  ]
   150                },
   151                "delete": {
   152                  "description": "Deletes an existing catalog specified by the catalog ID.",
   153                  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}",
   154                  "httpMethod": "DELETE",
   155                  "id": "biglake.projects.locations.catalogs.delete",
   156                  "parameterOrder": [
   157                    "name"
   158                  ],
   159                  "parameters": {
   160                    "name": {
   161                      "description": "Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}",
   162                      "location": "path",
   163                      "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
   164                      "required": true,
   165                      "type": "string"
   166                    }
   167                  },
   168                  "path": "v1/{+name}",
   169                  "response": {
   170                    "$ref": "Catalog"
   171                  },
   172                  "scopes": [
   173                    "https://www.googleapis.com/auth/bigquery",
   174                    "https://www.googleapis.com/auth/cloud-platform"
   175                  ]
   176                },
   177                "get": {
   178                  "description": "Gets the catalog specified by the resource name.",
   179                  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}",
   180                  "httpMethod": "GET",
   181                  "id": "biglake.projects.locations.catalogs.get",
   182                  "parameterOrder": [
   183                    "name"
   184                  ],
   185                  "parameters": {
   186                    "name": {
   187                      "description": "Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}",
   188                      "location": "path",
   189                      "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
   190                      "required": true,
   191                      "type": "string"
   192                    }
   193                  },
   194                  "path": "v1/{+name}",
   195                  "response": {
   196                    "$ref": "Catalog"
   197                  },
   198                  "scopes": [
   199                    "https://www.googleapis.com/auth/bigquery",
   200                    "https://www.googleapis.com/auth/cloud-platform"
   201                  ]
   202                },
   203                "list": {
   204                  "description": "List all catalogs in a specified project.",
   205                  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs",
   206                  "httpMethod": "GET",
   207                  "id": "biglake.projects.locations.catalogs.list",
   208                  "parameterOrder": [
   209                    "parent"
   210                  ],
   211                  "parameters": {
   212                    "pageSize": {
   213                      "description": "The maximum number of catalogs to return. The service may return fewer than this value. If unspecified, at most 50 catalogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
   214                      "format": "int32",
   215                      "location": "query",
   216                      "type": "integer"
   217                    },
   218                    "pageToken": {
   219                      "description": "A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCatalogs` must match the call that provided the page token.",
   220                      "location": "query",
   221                      "type": "string"
   222                    },
   223                    "parent": {
   224                      "description": "Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}",
   225                      "location": "path",
   226                      "pattern": "^projects/[^/]+/locations/[^/]+$",
   227                      "required": true,
   228                      "type": "string"
   229                    }
   230                  },
   231                  "path": "v1/{+parent}/catalogs",
   232                  "response": {
   233                    "$ref": "ListCatalogsResponse"
   234                  },
   235                  "scopes": [
   236                    "https://www.googleapis.com/auth/bigquery",
   237                    "https://www.googleapis.com/auth/cloud-platform"
   238                  ]
   239                }
   240              },
   241              "resources": {
   242                "databases": {
   243                  "methods": {
   244                    "create": {
   245                      "description": "Creates a new database.",
   246                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases",
   247                      "httpMethod": "POST",
   248                      "id": "biglake.projects.locations.catalogs.databases.create",
   249                      "parameterOrder": [
   250                        "parent"
   251                      ],
   252                      "parameters": {
   253                        "databaseId": {
   254                          "description": "Required. The ID to use for the database, which will become the final component of the database's resource name.",
   255                          "location": "query",
   256                          "type": "string"
   257                        },
   258                        "parent": {
   259                          "description": "Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}",
   260                          "location": "path",
   261                          "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
   262                          "required": true,
   263                          "type": "string"
   264                        }
   265                      },
   266                      "path": "v1/{+parent}/databases",
   267                      "request": {
   268                        "$ref": "Database"
   269                      },
   270                      "response": {
   271                        "$ref": "Database"
   272                      },
   273                      "scopes": [
   274                        "https://www.googleapis.com/auth/bigquery",
   275                        "https://www.googleapis.com/auth/cloud-platform"
   276                      ]
   277                    },
   278                    "delete": {
   279                      "description": "Deletes an existing database specified by the database ID.",
   280                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}",
   281                      "httpMethod": "DELETE",
   282                      "id": "biglake.projects.locations.catalogs.databases.delete",
   283                      "parameterOrder": [
   284                        "name"
   285                      ],
   286                      "parameters": {
   287                        "name": {
   288                          "description": "Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   289                          "location": "path",
   290                          "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$",
   291                          "required": true,
   292                          "type": "string"
   293                        }
   294                      },
   295                      "path": "v1/{+name}",
   296                      "response": {
   297                        "$ref": "Database"
   298                      },
   299                      "scopes": [
   300                        "https://www.googleapis.com/auth/bigquery",
   301                        "https://www.googleapis.com/auth/cloud-platform"
   302                      ]
   303                    },
   304                    "get": {
   305                      "description": "Gets the database specified by the resource name.",
   306                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}",
   307                      "httpMethod": "GET",
   308                      "id": "biglake.projects.locations.catalogs.databases.get",
   309                      "parameterOrder": [
   310                        "name"
   311                      ],
   312                      "parameters": {
   313                        "name": {
   314                          "description": "Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   315                          "location": "path",
   316                          "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$",
   317                          "required": true,
   318                          "type": "string"
   319                        }
   320                      },
   321                      "path": "v1/{+name}",
   322                      "response": {
   323                        "$ref": "Database"
   324                      },
   325                      "scopes": [
   326                        "https://www.googleapis.com/auth/bigquery",
   327                        "https://www.googleapis.com/auth/cloud-platform"
   328                      ]
   329                    },
   330                    "list": {
   331                      "description": "List all databases in a specified catalog.",
   332                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases",
   333                      "httpMethod": "GET",
   334                      "id": "biglake.projects.locations.catalogs.databases.list",
   335                      "parameterOrder": [
   336                        "parent"
   337                      ],
   338                      "parameters": {
   339                        "pageSize": {
   340                          "description": "The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 50 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
   341                          "format": "int32",
   342                          "location": "query",
   343                          "type": "integer"
   344                        },
   345                        "pageToken": {
   346                          "description": "A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token.",
   347                          "location": "query",
   348                          "type": "string"
   349                        },
   350                        "parent": {
   351                          "description": "Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}",
   352                          "location": "path",
   353                          "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
   354                          "required": true,
   355                          "type": "string"
   356                        }
   357                      },
   358                      "path": "v1/{+parent}/databases",
   359                      "response": {
   360                        "$ref": "ListDatabasesResponse"
   361                      },
   362                      "scopes": [
   363                        "https://www.googleapis.com/auth/bigquery",
   364                        "https://www.googleapis.com/auth/cloud-platform"
   365                      ]
   366                    },
   367                    "patch": {
   368                      "description": "Updates an existing database specified by the database ID.",
   369                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}",
   370                      "httpMethod": "PATCH",
   371                      "id": "biglake.projects.locations.catalogs.databases.patch",
   372                      "parameterOrder": [
   373                        "name"
   374                      ],
   375                      "parameters": {
   376                        "name": {
   377                          "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   378                          "location": "path",
   379                          "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$",
   380                          "required": true,
   381                          "type": "string"
   382                        },
   383                        "updateMask": {
   384                          "description": "The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.",
   385                          "format": "google-fieldmask",
   386                          "location": "query",
   387                          "type": "string"
   388                        }
   389                      },
   390                      "path": "v1/{+name}",
   391                      "request": {
   392                        "$ref": "Database"
   393                      },
   394                      "response": {
   395                        "$ref": "Database"
   396                      },
   397                      "scopes": [
   398                        "https://www.googleapis.com/auth/bigquery",
   399                        "https://www.googleapis.com/auth/cloud-platform"
   400                      ]
   401                    }
   402                  },
   403                  "resources": {
   404                    "tables": {
   405                      "methods": {
   406                        "create": {
   407                          "description": "Creates a new table.",
   408                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables",
   409                          "httpMethod": "POST",
   410                          "id": "biglake.projects.locations.catalogs.databases.tables.create",
   411                          "parameterOrder": [
   412                            "parent"
   413                          ],
   414                          "parameters": {
   415                            "parent": {
   416                              "description": "Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   417                              "location": "path",
   418                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$",
   419                              "required": true,
   420                              "type": "string"
   421                            },
   422                            "tableId": {
   423                              "description": "Required. The ID to use for the table, which will become the final component of the table's resource name.",
   424                              "location": "query",
   425                              "type": "string"
   426                            }
   427                          },
   428                          "path": "v1/{+parent}/tables",
   429                          "request": {
   430                            "$ref": "Table"
   431                          },
   432                          "response": {
   433                            "$ref": "Table"
   434                          },
   435                          "scopes": [
   436                            "https://www.googleapis.com/auth/bigquery",
   437                            "https://www.googleapis.com/auth/cloud-platform"
   438                          ]
   439                        },
   440                        "delete": {
   441                          "description": "Deletes an existing table specified by the table ID.",
   442                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}",
   443                          "httpMethod": "DELETE",
   444                          "id": "biglake.projects.locations.catalogs.databases.tables.delete",
   445                          "parameterOrder": [
   446                            "name"
   447                          ],
   448                          "parameters": {
   449                            "name": {
   450                              "description": "Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   451                              "location": "path",
   452                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$",
   453                              "required": true,
   454                              "type": "string"
   455                            }
   456                          },
   457                          "path": "v1/{+name}",
   458                          "response": {
   459                            "$ref": "Table"
   460                          },
   461                          "scopes": [
   462                            "https://www.googleapis.com/auth/bigquery",
   463                            "https://www.googleapis.com/auth/cloud-platform"
   464                          ]
   465                        },
   466                        "get": {
   467                          "description": "Gets the table specified by the resource name.",
   468                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}",
   469                          "httpMethod": "GET",
   470                          "id": "biglake.projects.locations.catalogs.databases.tables.get",
   471                          "parameterOrder": [
   472                            "name"
   473                          ],
   474                          "parameters": {
   475                            "name": {
   476                              "description": "Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   477                              "location": "path",
   478                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$",
   479                              "required": true,
   480                              "type": "string"
   481                            }
   482                          },
   483                          "path": "v1/{+name}",
   484                          "response": {
   485                            "$ref": "Table"
   486                          },
   487                          "scopes": [
   488                            "https://www.googleapis.com/auth/bigquery",
   489                            "https://www.googleapis.com/auth/cloud-platform"
   490                          ]
   491                        },
   492                        "list": {
   493                          "description": "List all tables in a specified database.",
   494                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables",
   495                          "httpMethod": "GET",
   496                          "id": "biglake.projects.locations.catalogs.databases.tables.list",
   497                          "parameterOrder": [
   498                            "parent"
   499                          ],
   500                          "parameters": {
   501                            "pageSize": {
   502                              "description": "The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
   503                              "format": "int32",
   504                              "location": "query",
   505                              "type": "integer"
   506                            },
   507                            "pageToken": {
   508                              "description": "A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.",
   509                              "location": "query",
   510                              "type": "string"
   511                            },
   512                            "parent": {
   513                              "description": "Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   514                              "location": "path",
   515                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$",
   516                              "required": true,
   517                              "type": "string"
   518                            },
   519                            "view": {
   520                              "description": "The view for the returned tables.",
   521                              "enum": [
   522                                "TABLE_VIEW_UNSPECIFIED",
   523                                "BASIC",
   524                                "FULL"
   525                              ],
   526                              "enumDescriptions": [
   527                                "Default value. The API will default to the BASIC view.",
   528                                "Include only table names. This is the default value.",
   529                                "Include everything."
   530                              ],
   531                              "location": "query",
   532                              "type": "string"
   533                            }
   534                          },
   535                          "path": "v1/{+parent}/tables",
   536                          "response": {
   537                            "$ref": "ListTablesResponse"
   538                          },
   539                          "scopes": [
   540                            "https://www.googleapis.com/auth/bigquery",
   541                            "https://www.googleapis.com/auth/cloud-platform"
   542                          ]
   543                        },
   544                        "patch": {
   545                          "description": "Updates an existing table specified by the table ID.",
   546                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}",
   547                          "httpMethod": "PATCH",
   548                          "id": "biglake.projects.locations.catalogs.databases.tables.patch",
   549                          "parameterOrder": [
   550                            "name"
   551                          ],
   552                          "parameters": {
   553                            "name": {
   554                              "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   555                              "location": "path",
   556                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$",
   557                              "required": true,
   558                              "type": "string"
   559                            },
   560                            "updateMask": {
   561                              "description": "The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.",
   562                              "format": "google-fieldmask",
   563                              "location": "query",
   564                              "type": "string"
   565                            }
   566                          },
   567                          "path": "v1/{+name}",
   568                          "request": {
   569                            "$ref": "Table"
   570                          },
   571                          "response": {
   572                            "$ref": "Table"
   573                          },
   574                          "scopes": [
   575                            "https://www.googleapis.com/auth/bigquery",
   576                            "https://www.googleapis.com/auth/cloud-platform"
   577                          ]
   578                        },
   579                        "rename": {
   580                          "description": "Renames an existing table specified by the table ID.",
   581                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}:rename",
   582                          "httpMethod": "POST",
   583                          "id": "biglake.projects.locations.catalogs.databases.tables.rename",
   584                          "parameterOrder": [
   585                            "name"
   586                          ],
   587                          "parameters": {
   588                            "name": {
   589                              "description": "Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   590                              "location": "path",
   591                              "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$",
   592                              "required": true,
   593                              "type": "string"
   594                            }
   595                          },
   596                          "path": "v1/{+name}:rename",
   597                          "request": {
   598                            "$ref": "RenameTableRequest"
   599                          },
   600                          "response": {
   601                            "$ref": "Table"
   602                          },
   603                          "scopes": [
   604                            "https://www.googleapis.com/auth/bigquery",
   605                            "https://www.googleapis.com/auth/cloud-platform"
   606                          ]
   607                        }
   608                      }
   609                    }
   610                  }
   611                }
   612              }
   613            }
   614          }
   615        }
   616      }
   617    }
   618  },
   619  "revision": "20231016",
   620  "rootUrl": "https://biglake.googleapis.com/",
   621  "schemas": {
   622    "Catalog": {
   623      "description": "Catalog is the container of databases.",
   624      "id": "Catalog",
   625      "properties": {
   626        "createTime": {
   627          "description": "Output only. The creation time of the catalog.",
   628          "format": "google-datetime",
   629          "readOnly": true,
   630          "type": "string"
   631        },
   632        "deleteTime": {
   633          "description": "Output only. The deletion time of the catalog. Only set after the catalog is deleted.",
   634          "format": "google-datetime",
   635          "readOnly": true,
   636          "type": "string"
   637        },
   638        "expireTime": {
   639          "description": "Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.",
   640          "format": "google-datetime",
   641          "readOnly": true,
   642          "type": "string"
   643        },
   644        "name": {
   645          "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}",
   646          "readOnly": true,
   647          "type": "string"
   648        },
   649        "updateTime": {
   650          "description": "Output only. The last modification time of the catalog.",
   651          "format": "google-datetime",
   652          "readOnly": true,
   653          "type": "string"
   654        }
   655      },
   656      "type": "object"
   657    },
   658    "Database": {
   659      "description": "Database is the container of tables.",
   660      "id": "Database",
   661      "properties": {
   662        "createTime": {
   663          "description": "Output only. The creation time of the database.",
   664          "format": "google-datetime",
   665          "readOnly": true,
   666          "type": "string"
   667        },
   668        "deleteTime": {
   669          "description": "Output only. The deletion time of the database. Only set after the database is deleted.",
   670          "format": "google-datetime",
   671          "readOnly": true,
   672          "type": "string"
   673        },
   674        "expireTime": {
   675          "description": "Output only. The time when this database is considered expired. Only set after the database is deleted.",
   676          "format": "google-datetime",
   677          "readOnly": true,
   678          "type": "string"
   679        },
   680        "hiveOptions": {
   681          "$ref": "HiveDatabaseOptions",
   682          "description": "Options of a Hive database."
   683        },
   684        "name": {
   685          "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}",
   686          "readOnly": true,
   687          "type": "string"
   688        },
   689        "type": {
   690          "description": "The database type.",
   691          "enum": [
   692            "TYPE_UNSPECIFIED",
   693            "HIVE"
   694          ],
   695          "enumDescriptions": [
   696            "The type is not specified.",
   697            "Represents a database storing tables compatible with Hive Metastore tables."
   698          ],
   699          "type": "string"
   700        },
   701        "updateTime": {
   702          "description": "Output only. The last modification time of the database.",
   703          "format": "google-datetime",
   704          "readOnly": true,
   705          "type": "string"
   706        }
   707      },
   708      "type": "object"
   709    },
   710    "HiveDatabaseOptions": {
   711      "description": "Options of a Hive database.",
   712      "id": "HiveDatabaseOptions",
   713      "properties": {
   714        "locationUri": {
   715          "description": "Cloud Storage folder URI where the database data is stored, starting with \"gs://\".",
   716          "type": "string"
   717        },
   718        "parameters": {
   719          "additionalProperties": {
   720            "type": "string"
   721          },
   722          "description": "Stores user supplied Hive database parameters.",
   723          "type": "object"
   724        }
   725      },
   726      "type": "object"
   727    },
   728    "HiveTableOptions": {
   729      "description": "Options of a Hive table.",
   730      "id": "HiveTableOptions",
   731      "properties": {
   732        "parameters": {
   733          "additionalProperties": {
   734            "type": "string"
   735          },
   736          "description": "Stores user supplied Hive table parameters.",
   737          "type": "object"
   738        },
   739        "storageDescriptor": {
   740          "$ref": "StorageDescriptor",
   741          "description": "Stores physical storage information of the data."
   742        },
   743        "tableType": {
   744          "description": "Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.",
   745          "type": "string"
   746        }
   747      },
   748      "type": "object"
   749    },
   750    "ListCatalogsResponse": {
   751      "description": "Response message for the ListCatalogs method.",
   752      "id": "ListCatalogsResponse",
   753      "properties": {
   754        "catalogs": {
   755          "description": "The catalogs from the specified project.",
   756          "items": {
   757            "$ref": "Catalog"
   758          },
   759          "type": "array"
   760        },
   761        "nextPageToken": {
   762          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
   763          "type": "string"
   764        }
   765      },
   766      "type": "object"
   767    },
   768    "ListDatabasesResponse": {
   769      "description": "Response message for the ListDatabases method.",
   770      "id": "ListDatabasesResponse",
   771      "properties": {
   772        "databases": {
   773          "description": "The databases from the specified catalog.",
   774          "items": {
   775            "$ref": "Database"
   776          },
   777          "type": "array"
   778        },
   779        "nextPageToken": {
   780          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
   781          "type": "string"
   782        }
   783      },
   784      "type": "object"
   785    },
   786    "ListTablesResponse": {
   787      "description": "Response message for the ListTables method.",
   788      "id": "ListTablesResponse",
   789      "properties": {
   790        "nextPageToken": {
   791          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
   792          "type": "string"
   793        },
   794        "tables": {
   795          "description": "The tables from the specified database.",
   796          "items": {
   797            "$ref": "Table"
   798          },
   799          "type": "array"
   800        }
   801      },
   802      "type": "object"
   803    },
   804    "RenameTableRequest": {
   805      "description": "Request message for the RenameTable method in MetastoreService",
   806      "id": "RenameTableRequest",
   807      "properties": {
   808        "newName": {
   809          "description": "Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   810          "type": "string"
   811        }
   812      },
   813      "type": "object"
   814    },
   815    "SerDeInfo": {
   816      "description": "Serializer and deserializer information.",
   817      "id": "SerDeInfo",
   818      "properties": {
   819        "serializationLib": {
   820          "description": "The fully qualified Java class name of the serialization library.",
   821          "type": "string"
   822        }
   823      },
   824      "type": "object"
   825    },
   826    "StorageDescriptor": {
   827      "description": "Stores physical storage information of the data.",
   828      "id": "StorageDescriptor",
   829      "properties": {
   830        "inputFormat": {
   831          "description": "The fully qualified Java class name of the input format.",
   832          "type": "string"
   833        },
   834        "locationUri": {
   835          "description": "Cloud Storage folder URI where the table data is stored, starting with \"gs://\".",
   836          "type": "string"
   837        },
   838        "outputFormat": {
   839          "description": "The fully qualified Java class name of the output format.",
   840          "type": "string"
   841        },
   842        "serdeInfo": {
   843          "$ref": "SerDeInfo",
   844          "description": "Serializer and deserializer information."
   845        }
   846      },
   847      "type": "object"
   848    },
   849    "Table": {
   850      "description": "Represents a table.",
   851      "id": "Table",
   852      "properties": {
   853        "createTime": {
   854          "description": "Output only. The creation time of the table.",
   855          "format": "google-datetime",
   856          "readOnly": true,
   857          "type": "string"
   858        },
   859        "deleteTime": {
   860          "description": "Output only. The deletion time of the table. Only set after the table is deleted.",
   861          "format": "google-datetime",
   862          "readOnly": true,
   863          "type": "string"
   864        },
   865        "etag": {
   866          "description": "The checksum of a table object computed by the server based on the value of other fields. It may be sent on update requests to ensure the client has an up-to-date value before proceeding. It is only checked for update table operations.",
   867          "type": "string"
   868        },
   869        "expireTime": {
   870          "description": "Output only. The time when this table is considered expired. Only set after the table is deleted.",
   871          "format": "google-datetime",
   872          "readOnly": true,
   873          "type": "string"
   874        },
   875        "hiveOptions": {
   876          "$ref": "HiveTableOptions",
   877          "description": "Options of a Hive table."
   878        },
   879        "name": {
   880          "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}",
   881          "readOnly": true,
   882          "type": "string"
   883        },
   884        "type": {
   885          "description": "The table type.",
   886          "enum": [
   887            "TYPE_UNSPECIFIED",
   888            "HIVE"
   889          ],
   890          "enumDescriptions": [
   891            "The type is not specified.",
   892            "Represents a table compatible with Hive Metastore tables."
   893          ],
   894          "type": "string"
   895        },
   896        "updateTime": {
   897          "description": "Output only. The last modification time of the table.",
   898          "format": "google-datetime",
   899          "readOnly": true,
   900          "type": "string"
   901        }
   902      },
   903      "type": "object"
   904    }
   905  },
   906  "servicePath": "",
   907  "title": "BigLake API",
   908  "version": "v1",
   909  "version_module": true
   910}

View as plain text