System Initiative

{ "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/bigquery": { "description": "View and manage your data in Google BigQuery and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "basePath": "", "baseUrl": "https://biglake.googleapis.com/", "batchPath": "batch", "canonicalName": "BigLake Service", "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.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "biglake:v1", "kind": "discovery#restDescription", "mtlsRootUrl": "https://biglake.mtls.googleapis.com/", "name": "biglake", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "alt": { "default": "json", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "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.", "location": "query", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean" }, "quotaUser": { "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.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "protocol": "rest", "resources": { "projects": { "resources": { "catalogs": { "methods": { "getIamPolicy": { "description": "Gets the IAM policy for the specified Catalog.", "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:getIamPolicy", "httpMethod": "GET", "id": "biglake.projects.catalogs.getIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" }, "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "description": "Sets the IAM policy for the specified catalog.", "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:setIamPolicy", "httpMethod": "POST", "id": "biglake.projects.catalogs.setIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "namespaces": { "methods": { "getIamPolicy": { "description": "Gets the IAM policy for the specified Catalog.", "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:getIamPolicy", "httpMethod": "GET", "id": "biglake.projects.catalogs.namespaces.getIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" }, "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "description": "Sets the IAM policy for the specified catalog.", "flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:setIamPolicy", "httpMethod": "POST", "id": "biglake.projects.catalogs.namespaces.setIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "locations": { "resources": { "catalogs": { "methods": { "create": { "description": "Creates a new catalog.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs", "httpMethod": "POST", "id": "biglake.projects.locations.catalogs.create", "parameterOrder": [ "parent" ], "parameters": { "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" }, "parent": { "description": "Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/catalogs", "request": { "$ref": "Catalog" }, "response": { "$ref": "Catalog" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes an existing catalog specified by the catalog ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}", "httpMethod": "DELETE", "id": "biglake.projects.locations.catalogs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Catalog" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the catalog specified by the resource name.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Catalog" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "List all catalogs in a specified project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.list", "parameterOrder": [ "parent" ], "parameters": { "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.", "format": "int32", "location": "query", "type": "integer" }, "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" }, "parent": { "description": "Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/catalogs", "response": { "$ref": "ListCatalogsResponse" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "databases": { "methods": { "create": { "description": "Creates a new database.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases", "httpMethod": "POST", "id": "biglake.projects.locations.catalogs.databases.create", "parameterOrder": [ "parent" ], "parameters": { "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" }, "parent": { "description": "Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/databases", "request": { "$ref": "Database" }, "response": { "$ref": "Database" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes an existing database specified by the database ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}", "httpMethod": "DELETE", "id": "biglake.projects.locations.catalogs.databases.delete", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Database" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the database specified by the resource name.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.databases.get", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Database" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "List all databases in a specified catalog.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.databases.list", "parameterOrder": [ "parent" ], "parameters": { "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.", "format": "int32", "location": "query", "type": "integer" }, "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" }, "parent": { "description": "Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/databases", "response": { "$ref": "ListDatabasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates an existing database specified by the database ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}", "httpMethod": "PATCH", "id": "biglake.projects.locations.catalogs.databases.patch", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$", "required": true, "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.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "path": "v1/{+name}", "request": { "$ref": "Database" }, "response": { "$ref": "Database" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "tables": { "methods": { "create": { "description": "Creates a new table.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables", "httpMethod": "POST", "id": "biglake.projects.locations.catalogs.databases.tables.create", "parameterOrder": [ "parent" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$", "required": true, "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" } }, "path": "v1/{+parent}/tables", "request": { "$ref": "Table" }, "response": { "$ref": "Table" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes an existing table specified by the table ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}", "httpMethod": "DELETE", "id": "biglake.projects.locations.catalogs.databases.tables.delete", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Table" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the table specified by the resource name.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.databases.tables.get", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Table" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "List all tables in a specified database.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables", "httpMethod": "GET", "id": "biglake.projects.locations.catalogs.databases.tables.list", "parameterOrder": [ "parent" ], "parameters": { "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.", "format": "int32", "location": "query", "type": "integer" }, "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" }, "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+$", "required": true, "type": "string" }, "view": { "description": "The view for the returned tables.", "enum": [ "TABLE_VIEW_UNSPECIFIED", "BASIC", "FULL" ], "enumDescriptions": [ "Default value. The API will default to the BASIC view.", "Include only table names. This is the default value.", "Include everything." ], "location": "query", "type": "string" } }, "path": "v1/{+parent}/tables", "response": { "$ref": "ListTablesResponse" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "description": "Updates an existing table specified by the table ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}", "httpMethod": "PATCH", "id": "biglake.projects.locations.catalogs.databases.tables.patch", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$", "required": true, "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.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "path": "v1/{+name}", "request": { "$ref": "Table" }, "response": { "$ref": "Table" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] }, "rename": { "description": "Renames an existing table specified by the table ID.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}:rename", "httpMethod": "POST", "id": "biglake.projects.locations.catalogs.databases.tables.rename", "parameterOrder": [ "name" ], "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}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/databases/[^/]+/tables/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:rename", "request": { "$ref": "RenameTableRequest" }, "response": { "$ref": "Table" }, "scopes": [ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } } } } } }, "revision": "20251129", "rootUrl": "https://biglake.googleapis.com/", "schemas": { "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "items": { "$ref": "AuditLogConfig" }, "type": "array" }, "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" } }, "type": "object" }, "AuditLogConfig": { "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "AuditLogConfig", "properties": { "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, "logType": { "description": "The log type that this config enables.", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "type": "string" } }, "type": "object" }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { "condition": { "$ref": "Expr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "type": "object" }, "Catalog": { "description": "Catalog is the container of databases.", "id": "Catalog", "properties": { "createTime": { "description": "Output only. The creation time of the catalog.", "format": "google-datetime", "readOnly": true, "type": "string" }, "deleteTime": { "description": "Output only. The deletion time of the catalog. Only set after the catalog is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "expireTime": { "description": "Output only. The time when this catalog is considered expired. Only set after the catalog is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}", "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. The last modification time of the catalog.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" }, "Database": { "description": "Database is the container of tables.", "id": "Database", "properties": { "createTime": { "description": "Output only. The creation time of the database.", "format": "google-datetime", "readOnly": true, "type": "string" }, "deleteTime": { "description": "Output only. The deletion time of the database. Only set after the database is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "expireTime": { "description": "Output only. The time when this database is considered expired. Only set after the database is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "hiveOptions": { "$ref": "HiveDatabaseOptions", "description": "Options of a Hive database." }, "name": { "description": "Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}", "readOnly": true, "type": "string" }, "type": { "description": "The database type.", "enum": [ "TYPE_UNSPECIFIED", "HIVE" ], "enumDescriptions": [ "The type is not specified.", "Represents a database storing tables compatible with Hive Metastore tables." ], "type": "string" }, "updateTime": { "description": "Output only. The last modification time of the database.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object" }, "HiveDatabaseOptions": { "description": "Options of a Hive database.", "id": "HiveDatabaseOptions", "properties": { "locationUri": { "description": "Cloud Storage folder URI where the database data is stored, starting with \"gs://\".", "type": "string" }, "parameters": { "additionalProperties": { "type": "string" }, "description": "Stores user supplied Hive database parameters.", "type": "object" } }, "type": "object" }, "HiveTableOptions": { "description": "Options of a Hive table.", "id": "HiveTableOptions", "properties": { "parameters": { "additionalProperties": { "type": "string" }, "description": "Stores user supplied Hive table parameters.", "type": "object" }, "storageDescriptor": { "$ref": "StorageDescriptor", "description": "Stores physical storage information of the data." }, "tableType": { "description": "Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.", "type": "string" } }, "type": "object" }, "ListCatalogsResponse": { "description": "Response message for the ListCatalogs method.", "id": "ListCatalogsResponse", "properties": { "catalogs": { "description": "The catalogs from the specified project.", "items": { "$ref": "Catalog" }, "type": "array" }, "nextPageToken": { "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.", "type": "string" } }, "type": "object" }, "ListDatabasesResponse": { "description": "Response message for the ListDatabases method.", "id": "ListDatabasesResponse", "properties": { "databases": { "description": "The databases from the specified catalog.", "items": { "$ref": "Database" }, "type": "array" }, "nextPageToken": { "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.", "type": "string" } }, "type": "object" }, "ListTablesResponse": { "description": "Response message for the ListTables method.", "id": "ListTablesResponse", "properties": { "nextPageToken": { "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.", "type": "string" }, "tables": { "description": "The tables from the specified database.", "items": { "$ref": "Table" }, "type": "array" } }, "type": "object" }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "AuditConfig" }, "type": "array" }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" }, "type": "array" }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" }, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } }, "type": "object" }, "RenameTableRequest": { "description": "Request message for the RenameTable method in MetastoreService", "id": "RenameTableRequest", "properties": { "newName": { "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}", "type": "string" } }, "type": "object" }, "SerDeInfo": { "description": "Serializer and deserializer information.", "id": "SerDeInfo", "properties": { "serializationLib": { "description": "The fully qualified Java class name of the serialization library.", "type": "string" } }, "type": "object" }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "policy": { "$ref": "Policy", "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." }, "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } }, "type": "object" }, "StorageDescriptor": { "description": "Stores physical storage information of the data.", "id": "StorageDescriptor", "properties": { "inputFormat": { "description": "The fully qualified Java class name of the input format.", "type": "string" }, "locationUri": { "description": "Cloud Storage folder URI where the table data is stored, starting with \"gs://\".", "type": "string" }, "outputFormat": { "description": "The fully qualified Java class name of the output format.", "type": "string" }, "serdeInfo": { "$ref": "SerDeInfo", "description": "Serializer and deserializer information." } }, "type": "object" }, "Table": { "description": "Represents a table.", "id": "Table", "properties": { "createTime": { "description": "Output only. The creation time of the table.", "format": "google-datetime", "readOnly": true, "type": "string" }, "deleteTime": { "description": "Output only. The deletion time of the table. Only set after the table is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "etag": { "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.", "type": "string" }, "expireTime": { "description": "Output only. The time when this table is considered expired. Only set after the table is deleted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "hiveOptions": { "$ref": "HiveTableOptions", "description": "Options of a Hive table." }, "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}", "readOnly": true, "type": "string" }, "type": { "description": "The table type.", "enum": [ "TYPE_UNSPECIFIED", "HIVE" ], "enumDescriptions": [ "The type is not specified.", "Represents a table compatible with Hive Metastore tables." ], "type": "string" }, "updateTime": { "description": "Output only. The last modification time of the table.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" } }, "servicePath": "", "title": "BigLake API", "version": "v1", "version_module": true }