- Recurso: IcebergCatalog
- CredentialMode
- CatalogType
- Réplica
- Estado
- RestrictedLocationsConfig
- EncryptionConfig
- FederatedCatalogOptions
- IdentityFederationOrganizationServiceAccount
- UnityCatalogInfo
- GlueCatalogInfo
- SnowflakeCatalogInfo
- WorkdayCatalogInfo
- IdentityMode
- UserIdentityFederationOidcClaims
- UserIdentityFederationOidc
- RefreshOptions
- RefreshSchedule
- RefreshScope
- RefreshStatus
- CrossCloudCacheOptions
- Métodos
Recurso: IcebergCatalog
La información del catálogo de REST de Iceberg.
| Representación JSON |
|---|
{ "name": string, "credential-mode": enum ( |
| Campos | |
|---|---|
name |
Es el identificador. El nombre del catálogo, |
credential-mode |
Es opcional. Es el modo de credencial del catálogo. |
biglake-service-account |
Solo salida. La cuenta de servicio que se usa para la venta de credenciales, solo de salida. Puede estar vacío si nunca se habilita la venta de credenciales para el catálogo. En el caso de los catálogos federados, la cuenta de servicio siempre se aprovisionará y se usará para acceder al catálogo remoto y actualizar los metadatos en segundo plano. Si |
biglake-service-account-id |
Solo salida. Es el ID único de la cuenta de servicio. Se usa para situaciones de federación. |
catalog-type |
Obligatorio. Es el tipo de catálogo. Es obligatorio para catalogs.create. El tipo de catálogo es inmutable, excepto en el caso de la conversión de CATALOG_TYPE_GCS_BUCKET a CATALOG_TYPE_BIGLAKE. |
default-location |
Es opcional. Es la ubicación de almacenamiento predeterminada del catálogo, p.ej., En el caso de los catálogos de BigLake, se debe proporcionar este campo y debe apuntar a un bucket de Google Cloud Storage o a una ruta de acceso dentro de ese bucket. Esta ruta de acceso sirve como directorio base para construir la ruta de acceso completa a los directorios de datos y metadatos de una tabla cuando no se especifica una ubicación a nivel del espacio de nombres o de la tabla. La ruta de acceso completa se forma agregando los identificadores de espacio de nombres y tabla a la ubicación predeterminada. |
storage-regions[] |
Solo salida. Las regiones de Google Cloud del bucket de la ubicación predeterminada, p.ej., |
create-time |
Solo salida. Indica cuándo se creó el catálogo. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
update-time |
Solo salida. Cuándo se actualizó el catálogo por última vez. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
replicas[] |
Solo salida. Son las réplicas de los metadatos del catálogo. |
description |
Es opcional. Es una descripción del catálogo proporcionada por el usuario. La descripción debe ser una cadena UTF-8 con una longitud máxima de 1,024 caracteres. |
restricted-locations-config |
Es opcional. Configuración de ubicaciones restringidas. Actualmente, este campo solo se usa para los catálogos de BigLake. Si no se establece este campo o si |
federated-catalog-options |
Es opcional. Opciones de configuración para los catálogos federados. |
cross-cloud-cache-options |
Es opcional. Opciones de configuración para el almacenamiento en caché multinube de archivos de datos y metadatos. |
encryption-config |
Es opcional. Configuración de encriptación personalizada (p. ej., claves de Cloud KMS) |
CredentialMode
Es el modo de credenciales que se usa para el catálogo.
| Enums | |
|---|---|
CREDENTIAL_MODE_UNSPECIFIED |
Es el valor predeterminado o no establecido. Este valor no se usa. |
CREDENTIAL_MODE_END_USER |
Modo de credenciales del usuario final, predeterminado. El usuario que se autentica debe tener acceso a los recursos del catálogo y a los objetos de Google Cloud Storage subyacentes. |
CREDENTIAL_MODE_VENDED_CREDENTIALS |
Es el modo de venta de credenciales. El usuario que se autentica solo necesita acceso a los recursos del catálogo, y el sistema le proporcionará al emisor credenciales con permisos reducidos para acceder a los objetos de Google Cloud Storage. Todas las operaciones de tabla en este modo requieren que el encabezado Consulta https://docs.cloud.google.com/lakehouse/docs/credential-vending para obtener más detalles. |
CatalogType
Determina el tipo de catálogo.
| Enums | |
|---|---|
CATALOG_TYPE_UNSPECIFIED |
Es el valor predeterminado o no establecido. Este valor no se usa. |
CATALOG_TYPE_GCS_BUCKET |
Es el tipo de catálogo del bucket de Google Cloud Storage. |
CATALOG_TYPE_BIGLAKE |
Es el tipo de catálogo de BigLake. |
CATALOG_TYPE_FEDERATED |
Es el tipo de catálogo federado. |
CATALOG_TYPE_ALLOYDB_AGENT_MODE |
Catálogo para consultar tablas de AlloyDB en modo agente. |
Réplica
Es la réplica del catálogo.
| Representación JSON |
|---|
{
"region": string,
"state": enum ( |
| Campos | |
|---|---|
region |
Solo salida. La región de la réplica. Por ejemplo, "us-east1". |
state |
Solo salida. Es el estado actual de la réplica. |
Estado
Si el catálogo se replica en varias regiones, este enum describe el estado actual de la réplica.
| Enums | |
|---|---|
STATE_UNKNOWN |
Es el valor predeterminado o no establecido. Este valor no se usa. |
STATE_PRIMARY |
La réplica es la instancia principal que admite operaciones de escritura. |
STATE_PRIMARY_IN_PROGRESS |
La réplica se asignó recientemente como principal, pero aún no se puede escribir en todos los espacios de nombres. |
STATE_SECONDARY |
La réplica es una réplica secundaria de solo lectura. |
RestrictedLocationsConfig
Es la configuración de las restricciones de ubicación.
| Representación JSON |
|---|
{ "restricted-locations": [ string ] } |
| Campos | |
|---|---|
restricted-locations[] |
Es opcional. Son las ubicaciones y los buckets de Google Cloud Storage adicionales (p.ej., Si |
EncryptionConfig
Configuración de encriptación personalizada (p. ej., claves de Cloud KMS)
| Representación JSON |
|---|
{ "kms-key-name": string } |
| Campos | |
|---|---|
kms-key-name |
Es opcional. Es el nombre de la clave de Cloud KMS que se usa para encriptar los datos almacenados en caché que se recuperan del catálogo. Formato: |
FederatedCatalogOptions
Son las opciones de configuración de un catálogo federado.
| Representación JSON |
|---|
{ "identity-mode": enum ( |
| Campos | |
|---|---|
identity-mode |
Es opcional. Es el modo de identidad del catálogo federado. |
refresh-options |
Es opcional. Actualiza la configuración. |
refresh-status |
Solo salida. Es el estado de las operaciones de actualización de metadatos en segundo plano. |
| La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
identity-federation-organization-service-account |
Solo salida. Es la cuenta de servicio a nivel de la organización que se usa para la federación de identidades. |
| Fin de los campos mutuamente excluyentes. | |
| Información específica del catálogo de REST de Iceberg remoto. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
unity-catalog-info |
Es opcional. Información específica de Databricks Unity Catalog. |
glue-catalog-info |
Es opcional. Información específica de AWS Glue Data Catalog. |
snowflake-catalog-info |
Es opcional. Información específica del catálogo de Snowflake Horizon. |
workday-catalog-info |
Es opcional. Información específica de Workday Data Lake. |
| Fin de los campos mutuamente excluyentes. | |
secret-name |
Es opcional. Es el nombre del recurso del Secret en Secret Manager, en el formato El ID del proyecto debe coincidir con el proyecto del catálogo, y la ubicación debe coincidir con la ubicación del catálogo. Si no se especifica la versión, se usará la última versión. Este campo no se usa cuando se configuran |
service-directory-name |
Es opcional. El nombre del recurso del Directorio de servicios que se usa para enrutar el tráfico de la capa de transporte con el catálogo remoto (p. ej., acceso a archivos de datos en buckets de almacenamiento) a través de una conexión de red privada. Formato: Las consultas de BigQuery lo usan para resolver extremos privados para recuperar archivos de datos (p.ej., datos de Iceberg en S3 o Azure Data Lake Storage) a través de una conexión de red privada, como Cross‑Cloud Interconnect. |
metadata-service-directory-name |
Es opcional. El nombre del recurso del Directorio de servicios que se usa para enrutar el tráfico de la capa de metadatos con el catálogo remoto a través de una conexión de red privada. Formato: Se usa para recuperar metadatos del catálogo (como parámetros de configuración, espacios de nombres y tablas de Iceberg) a través de una conexión de red privada, como Cross‑Cloud Interconnect. También se usa para recuperar tokens de OAuth cuando no se establece |
user-identity-federation-oidc-claims |
Solo salida. Obsoleto: Usa Son las reclamaciones de OIDC emitidas en el token de ID para la federación de identidades de usuarios. |
user-identity-federation-oidc |
Solo salida. Es la configuración de OIDC para la federación de identidades de usuarios. |
IdentityFederationOrganizationServiceAccount
La cuenta de servicio a nivel de la organización que se usa para la federación de identidades, solo de salida. Puede estar vacío si nunca se habilita la federación de identidades para el catálogo.
| Representación JSON |
|---|
{ "service-account": string, "service-account-unique-id": string } |
| Campos | |
|---|---|
service-account |
Solo salida. Es el correo electrónico de la cuenta de servicio a nivel de la organización. |
service-account-unique-id |
Solo salida. Es el ID único de la cuenta de servicio a nivel de la organización. |
UnityCatalogInfo
Información específica de Databricks Unity Catalog. El extremo del catálogo de REST de Iceberg tiene el siguiente formato: https://<instanceName>/api/2.1/unity-catalog/iceberg-rest/v1/config?warehouse=<catalogName>.
| Representación JSON |
|---|
{ "instance-name": string, "catalog-name": string, "service-principal-application-id": string } |
| Campos | |
|---|---|
instance-name |
Obligatorio. Inmutable. Es el nombre de la instancia del espacio de trabajo de Databricks. Por ejemplo, para la URL del espacio de trabajo de Databricks |
catalog-name |
Obligatorio. Inmutable. Es el nombre del catálogo en Databricks Unity Catalog. |
service-principal-application-id |
Es opcional. Es el ID de aplicación de la entidad de servicio de Databricks que se usa para acceder a Databricks Unity Catalog en el flujo de autenticación de OIDC. |
GlueCatalogInfo
Información específica de AWS Glue Data Catalog. El extremo del catálogo de REST de Iceberg tiene el siguiente formato: https://glue.<awsRegion>.amazonaws.com/iceberg/v1/config?warehouse=<warehouse>.
| Representación JSON |
|---|
{ "warehouse": string, "aws-region": string, "aws-role-arn": string } |
| Campos | |
|---|---|
warehouse |
Obligatorio. Inmutable. Es la ubicación del almacén en AWS Glue Data Catalog. Para el catálogo de cuentas predeterminado, usa el ID de cuenta de AWS de 12 dígitos (por ejemplo, |
aws-region |
Obligatorio. Inmutable. La región de AWS del Data Catalog de AWS Glue (por ejemplo, |
aws-role-arn |
Obligatorio. Es el nombre de recurso de Amazon (ARN) del rol de IAM de AWS que asume el catálogo federado para acceder al AWS Glue Data Catalog. |
SnowflakeCatalogInfo
Información específica del catálogo de Snowflake Horizon. El extremo del catálogo de REST de Iceberg tiene el siguiente formato: https://<accountIdentifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<warehouse>.
| Representación JSON |
|---|
{ "account-identifier": string, "warehouse": string, "snowflake-role": string } |
| Campos | |
|---|---|
account-identifier |
Obligatorio. Inmutable. Es el identificador de la cuenta en Snowflake. Por ejemplo, para la URL de implementación de Snowflake El identificador de la cuenta puede contener letras, dígitos y guiones bajos, con segmentos separados por guiones ( |
warehouse |
Obligatorio. Inmutable. Es el nombre de la base de datos en el catálogo de Snowflake Horizon. |
snowflake-role |
Es opcional. Es el rol de Snowflake que se usa para definir el alcance del acceso al catálogo de Snowflake Horizon en el flujo de autenticación de la federación de identidades para cargas de trabajo (OIDC). |
WorkdayCatalogInfo
Información específica de Workday Data Lake. El extremo del catálogo de REST de Iceberg tiene el siguiente formato: https://<baseUrl>/datalake/api/catalog/v1/config?warehouse=workday.
| Representación JSON |
|---|
{ "base-url": string, "tenant": string, "api-client-client-id": string } |
| Campos | |
|---|---|
base-url |
Obligatorio. Inmutable. Es la URL base de la instancia de Workday. Por ejemplo, |
tenant |
Obligatorio. Inmutable. Es el nombre del usuario de Workday. |
api-client-client-id |
Es opcional. Es el ID de cliente del cliente de API de Workday que se usa para acceder a Workday Data Lake en el flujo de autenticación de OIDC. |
IdentityMode
Es el modo de identidad que usa el catálogo para las consultas.
| Enums | |
|---|---|
IDENTITY_MODE_UNSPECIFIED |
Es el valor predeterminado o no establecido. Este valor se trata de la misma manera que IDENTITY_MODE_SERVICE_IDENTITY. |
IDENTITY_MODE_SERVICE_IDENTITY |
Las consultas se ejecutan con la cuenta de servicio en google.cloud.biglake.v1main.IcebergCatalog.biglake_service_account. |
IDENTITY_MODE_USER_IDENTITY_FEDERATION |
Las consultas se ejecutan con la identidad del usuario final y se propagan al catálogo remoto. La federación de identidades debe configurarse en el catálogo remoto. Consulta https://docs.cloud.google.com/lakehouse/docs/about-cross-cloud-data-access#identity-mode para obtener más detalles. |
UserIdentityFederationOidcClaims
Son las reclamaciones de OIDC que se emiten en el token de ID cuando se habilita IDENTITY_MODE_USER_IDENTITY_FEDERATION.
Estos valores identifican al proveedor de identidad (emisor) y al destinatario previsto (público) del token. Para habilitar la federación de identidades de usuario, los usuarios deben configurar su catálogo remoto para que confíe en esta entidad emisora y espere a este público.
| Representación JSON |
|---|
{ "issuer-url": string, "audience": string } |
| Campos | |
|---|---|
issuer-url |
Solo salida. Es la URL del emisor del proveedor de identidad. |
audience |
Solo salida. Es el público que este catálogo espera en el token. |
UserIdentityFederationOidc
Es la configuración de OIDC que se usa cuando se habilita IDENTITY_MODE_USER_IDENTITY_FEDERATION.
Para habilitar la federación de identidades de usuario, los usuarios deben configurar su catálogo remoto para que confíe en los tokens con estos parámetros.
| Representación JSON |
|---|
{ "issuer-url": string, "audience": string, "jwks-url": string } |
| Campos | |
|---|---|
issuer-url |
Solo salida. Es la URL del emisor del proveedor de identidad. |
audience |
Solo salida. Es el público que este catálogo espera en el token. |
jwks-url |
Solo salida. Es la URL del conjunto de claves web JSON (JWKS) que entrega las claves públicas que se usan para verificar el token. Solo se establece para los catálogos federados de Snowflake Horizon, en los que se usa como |
RefreshOptions
Actualiza la configuración.
| Representación JSON |
|---|
{ "refresh-schedule": { object ( |
| Campos | |
|---|---|
refresh-schedule |
Es opcional. El programa define si se debe programar la actualización de metadatos y cuándo. |
refresh-scope |
Es opcional. Actualiza los parámetros de configuración del permiso. |
RefreshSchedule
El programa define si se debe programar la actualización de metadatos y cuándo.
| Representación JSON |
|---|
{ "refresh-interval": string } |
| Campos | |
|---|---|
refresh-interval |
Es opcional. Es el intervalo para actualizar los metadatos del catálogo remoto. Si no se establece o si el valor es <= 0, se inhabilitará la actualización de metadatos en segundo plano. Si se actualiza este campo para un catálogo federado existente, la actualización de metadatos en segundo plano anterior debe completarse antes de que se aplique el nuevo intervalo de actualización. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
RefreshScope
El alcance define un subconjunto de espacios de nombres que se actualizarán.
| Representación JSON |
|---|
{ "namespace-filters": [ string ] } |
| Campos | |
|---|---|
namespace-filters[] |
Es opcional. Son filtros para determinar qué espacios de nombres se incluyen en el proceso de actualización. - Una lista vacía significa que se incluyen todos los espacios de nombres. - "[namespaces]" significa que se deben incluir los espacios de nombres especificados. ['ns1', 'ns2'] : Descubre solo los espacios de nombres 'ns1' y 'ns2'. |
RefreshStatus
Estado de la actualización de metadatos en segundo plano del catálogo remoto.
| Representación JSON |
|---|
{
"start-time": string,
"end-time": string,
"status": {
object ( |
| Campos | |
|---|---|
start-time |
Solo salida. Cuando se inicia la actualización del catálogo, incluidas las actualizaciones en curso. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
end-time |
Solo salida. Cuando finalice la actualización del catálogo, se anulará la configuración de las actualizaciones en curso. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
status |
Solo salida. Es el estado de la última operación de actualización de metadatos en segundo plano, que no se establece para las actualizaciones en curso. |
CrossCloudCacheOptions
Opciones de configuración para el almacenamiento en caché multinube de archivos de datos y metadatos.
| Representación JSON |
|---|
{ "enabled": boolean } |
| Campos | |
|---|---|
enabled |
Es opcional. Especifica si está habilitado el almacenamiento en caché multinube de archivos de datos y metadatos. Esto solo afecta a las consultas que se realizan a través de BigQuery. Si este valor es Si este valor es |
Métodos |
|
|---|---|
|
Crea el catálogo de REST de Iceberg. |
|
Borra el catálogo de REST de Iceberg. |
|
Conmutar por error el catálogo a una nueva región de réplica principal |
|
Devuelve las opciones de configuración del catálogo de REST de Iceberg. |
|
Enumera los catálogos de REST de Iceberg. |
|
Actualiza las opciones de configuración del catálogo de REST de Iceberg. |