2023-10-25
▼ ▲ biglake.projects.locations.catalogs.create
Path: v1/{+parent}/catalogs
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
catalogId
Description: Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new catalog.
▼ ▲ biglake.projects.locations.catalogs.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes an existing catalog specified by the catalog ID.
▼ ▲ biglake.projects.locations.catalogs.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the catalog specified by the resource name.
▼ ▲ biglake.projects.locations.catalogs.list
Path: v1/{+parent}/catalogs
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
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.
Location: query
Type: integer
Format: int32
pageToken
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.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: List all catalogs in a specified project.
▼ ▲ biglake.projects.locations.catalogs.databases.create
Path: v1/{+parent}/databases
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location: path
Required: Yes
Type: string
databaseId
Description: Required. The ID to use for the database, which will become the final component of the database's resource name.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new database.
▼ ▲ biglake.projects.locations.catalogs.databases.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes an existing database specified by the database ID.
▼ ▲ biglake.projects.locations.catalogs.databases.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates an existing database specified by the database ID.
▼ ▲ biglake.projects.locations.catalogs.databases.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the database specified by the resource name.
▼ ▲ biglake.projects.locations.catalogs.databases.list
Path: v1/{+parent}/databases
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
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.
Location: query
Type: integer
Format: int32
pageToken
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.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: List all databases in a specified catalog.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.create
Path: v1/{+parent}/tables
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables
HTTP Method: POST
Parameters:
parent
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}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
tableId
Description: Required. The ID to use for the table, which will become the final component of the table's resource name.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new table.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}
HTTP Method: DELETE
Parameters:
name
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}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes an existing table specified by the table ID.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates an existing table specified by the table ID.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.rename
Path: v1/{+name}:rename
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}:rename
HTTP Method: POST
Parameters:
name
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}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Renames an existing table specified by the table ID.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}
HTTP Method: GET
Parameters:
name
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}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the table specified by the resource name.
▼ ▲ biglake.projects.locations.catalogs.databases.tables.list
Path: v1/{+parent}/tables
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables
HTTP Method: GET
Parameters:
parent
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}
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
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.
Location: query
Type: integer
Format: int32
pageToken
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.
Location: query
Type: string
view
Description: The view for the returned tables.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: parent
Scopes:
Description: List all tables in a specified database.