Datasource Config

View as Markdown

Per-catalog datasource-related config. Singleton. Name format: catalogs/{catalog}/datasourceConfig.

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

DatasourceConfig object

Per-catalog datasource-related config. Singleton. Name format: catalogs/{catalog}/datasourceConfig.

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.

default_compute_modestringBeta

Default compute mode applied to datasource ingestion jobs when the individual datasource doesn't override it. v1 datasources.defaultComputeMode.

Values:

• DS_COMPUTE_STANDARD
• DS_COMPUTE_PERFORMANCE_OPTIMIZED

default_folderstringBeta

Schema name of the registered folder (in this catalog) that a new datasource is placed in when the request does not specify a schema. Must name a schema registered as a folder. Omit to clear. Reads return the value as supplied; the folder's current schema name is reported in effective_default_folder.

effective_default_folderstringBetaOutput only

The current schema name of the default_folder folder. Tracks UC schema renames. Unset when no default is configured, or when the folder's schema no longer exists or is not visible to the caller.

View as Markdown

The DatasourceConfig object

{
  "name": "string",
  "version": 0,
  "update_time": "string",
  "updated_by": {
    "id": "string",
    "principal_type": "REGULAR_USER",
    "email": "string",
    "display_name": "string"
  },
  "etag": "string",
  "default_compute_mode": "DS_COMPUTE_STANDARD",
  "default_folder": "string",
  "effective_default_folder": "string"
}

Get the datasource config for a catalog Beta

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

Returns the datasource ingestion configuration for a catalog.

API scopes: lakewatch

Parameters

namestringRequiredpath

Response

Returns the DatasourceConfig 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",
  "default_compute_mode": "DS_COMPUTE_STANDARD",
  "default_folder": "string",
  "effective_default_folder": "string"
}

Update the datasource config for a catalog Beta

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

Updates the datasource ingestion 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

default_compute_modestring

Default compute mode applied to datasource ingestion jobs when the individual datasource doesn't override it. v1 datasources.defaultComputeMode.

Values:

• DS_COMPUTE_STANDARD
• DS_COMPUTE_PERFORMANCE_OPTIMIZED

default_folderstring

Schema name of the registered folder (in this catalog) that a new datasource is placed in when the request does not specify a schema. Must name a schema registered as a folder. Omit to clear. Reads return the value as supplied; the folder's current schema name is reported in effective_default_folder.

Response

Returns the DatasourceConfig object.

View as Markdown

Request

{
  "default_compute_mode": "DS_COMPUTE_STANDARD",
  "default_folder": "string"
}

Response

{
  "name": "string",
  "version": 0,
  "update_time": "string",
  "updated_by": {
    "id": "string",
    "principal_type": "REGULAR_USER",
    "email": "string",
    "display_name": "string"
  },
  "etag": "string",
  "default_compute_mode": "DS_COMPUTE_STANDARD",
  "default_folder": "string",
  "effective_default_folder": "string"
}