Common Config

View as Markdown

Catch-all per-catalog config — settings that don't belong to any one resource family. Singleton. Name format: catalogs/{catalog}/commonConfig.

Get the common config for a catalogGET /api/2.0/lakewatch/{name=catalogs/*/commonConfig}Update the common config for a catalogPATCH /api/2.0/lakewatch/{name=catalogs/*/commonConfig}

CommonConfig object

Catch-all per-catalog config — settings that don't belong to any one resource family. Singleton. Name format: catalogs/{catalog}/commonConfig.

namestringBetaIDImmutable

versionint64BetaOutput only

Monotonic version, bumped on each update. Informational; use etag for optimistic concurrency.

update_timestringBetaOutput only

updated_byobjectBetaOutput only

Show child attributesHide child attributes

idstringBeta

User / service-principal ID.

principal_typestringBeta

Whether this principal is a regular user, service principal, or system principal.

Values:

• REGULAR_USER
• SERVICE_PRINCIPAL
• SYSTEM_USER

emailstringBeta

Email (regular users only).

display_namestringBeta

Display name (user or SP name).

etagstringBetaOutput only

Opaque entity tag for optimistic concurrency. Returned on every read; pass it back as the Update request's etag to make the update conditional on the resource being unchanged.

custom_presets_pathstringBeta

UC volume path holding user-authored custom presets, e.g. /Volumes/{catalog}/{schema}/{volume}. User-provided with no default: when unset, custom presets are unavailable and only built-in presets apply.

custom_content_pack_pathstringBeta

UC volume path holding user-authored custom content packs, e.g. /Volumes/{catalog}/{schema}/{volume}. User-provided with no default: when unset, custom content packs are unavailable (referencing one is rejected) and only built-in content packs apply.

per_resource_permissions_enabledbooleanBeta

Whether users may grant permissions on individual resources rather than only at the Folder level.

View as Markdown

The CommonConfig object

{
  "name": "string",
  "version": 0,
  "update_time": "string",
  "updated_by": {
    "id": "string",
    "principal_type": "REGULAR_USER",
    "email": "string",
    "display_name": "string"
  },
  "etag": "string",
  "custom_presets_path": "string",
  "custom_content_pack_path": "string",
  "per_resource_permissions_enabled": true
}

Get the common config for a catalog Beta

GET /api/2.0/lakewatch/{name=catalogs/*/commonConfig}

Returns the common Lakewatch configuration for a catalog.

API scopes: lakewatch

Parameters

namestringRequiredpath

Response

Returns the CommonConfig object.

View as Markdown

Response

{
  "name": "string",
  "version": 0,
  "update_time": "string",
  "updated_by": {
    "id": "string",
    "principal_type": "REGULAR_USER",
    "email": "string",
    "display_name": "string"
  },
  "etag": "string",
  "custom_presets_path": "string",
  "custom_content_pack_path": "string",
  "per_resource_permissions_enabled": true
}

Update the common config for a catalog Beta

PATCH /api/2.0/lakewatch/{name=catalogs/*/commonConfig}

Updates the common Lakewatch configuration for a catalog.

API scopes: lakewatch

Parameters

namestringRequiredIDImmutablepath

update_maskstringRequiredquery

etagstringquery

Optimistic-concurrency precondition: if set and it does not match the resource's current etag, the update is rejected as a conflict (HTTP 409).

Request body

custom_presets_pathstring

UC volume path holding user-authored custom presets, e.g. /Volumes/{catalog}/{schema}/{volume}. User-provided with no default: when unset, custom presets are unavailable and only built-in presets apply.

custom_content_pack_pathstring

UC volume path holding user-authored custom content packs, e.g. /Volumes/{catalog}/{schema}/{volume}. User-provided with no default: when unset, custom content packs are unavailable (referencing one is rejected) and only built-in content packs apply.

per_resource_permissions_enabledboolean

Whether users may grant permissions on individual resources rather than only at the Folder level.

Response

Returns the CommonConfig object.

View as Markdown

Request

{
  "custom_presets_path": "string",
  "custom_content_pack_path": "string",
  "per_resource_permissions_enabled": true
}

Response

{
  "name": "string",
  "version": 0,
  "update_time": "string",
  "updated_by": {
    "id": "string",
    "principal_type": "REGULAR_USER",
    "email": "string",
    "display_name": "string"
  },
  "etag": "string",
  "custom_presets_path": "string",
  "custom_content_pack_path": "string",
  "per_resource_permissions_enabled": true
}