Class LakewatchClient

Constructors

constructor

new LakewatchClient(options: ClientOptions): LakewatchClient
Parameters
- options: ClientOptions
Returns LakewatchClient
- Defined in client.ts:82

Methods

createDatasource

createDatasource(
req: CreateDatasourceRequest,
options?: CallOptions,
): Promise<Datasource>
Creates a new datasource.
Parameters
- req: CreateDatasourceRequest
- Optionaloptions: CallOptions
Returns Promise<Datasource>
- Defined in client.ts:397

createRule

createRule(req: CreateRuleRequest, options?: CallOptions): Promise<Rule>
Creates a new rule.
Parameters
- req: CreateRuleRequest
- Optionaloptions: CallOptions
Returns Promise<Rule>
- Defined in client.ts:595

deleteDatasource

deleteDatasource(
req: DeleteDatasourceRequest,
options?: CallOptions,
): Promise<void>
Deletes a datasource by its resource name.
Parameters
- req: DeleteDatasourceRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:427

deleteRule

deleteRule(req: DeleteRuleRequest, options?: CallOptions): Promise<void>
Deletes a rule by its resource name.
Parameters
- req: DeleteRuleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:625

getAlertConfig

getAlertConfig(
req: GetAlertConfigRequest,
options?: CallOptions,
): Promise<AlertConfig>
Returns the alert delivery configuration for a catalog.
Parameters
- req: GetAlertConfigRequest
- Optionaloptions: CallOptions
Returns Promise<AlertConfig>
- Defined in client.ts:98

getCommonConfig

getCommonConfig(
req: GetCommonConfigRequest,
options?: CallOptions,
): Promise<CommonConfig>
Returns the common Lakewatch configuration for a catalog.
Parameters
- req: GetCommonConfigRequest
- Optionaloptions: CallOptions
Returns Promise<CommonConfig>
- Defined in client.ts:127

getDatasource

getDatasource(
req: GetDatasourceRequest,
options?: CallOptions,
): Promise<Datasource>
Returns a single datasource by its resource name.
Parameters
- req: GetDatasourceRequest
- Optionaloptions: CallOptions
Returns Promise<Datasource>
- Defined in client.ts:450

getDatasourceConfig

getDatasourceConfig(
req: GetDatasourceConfigRequest,
options?: CallOptions,
): Promise<DatasourceConfig>
Returns the datasource ingestion configuration for a catalog.
Parameters
- req: GetDatasourceConfigRequest
- Optionaloptions: CallOptions
Returns Promise<DatasourceConfig>
- Defined in client.ts:156

getRule

getRule(req: GetRuleRequest, options?: CallOptions): Promise<Rule>
Returns a single rule by its resource name.
Parameters
- req: GetRuleRequest
- Optionaloptions: CallOptions
Returns Promise<Rule>
- Defined in client.ts:648

getRuleConfig

getRuleConfig(
req: GetRuleConfigRequest,
options?: CallOptions,
): Promise<RuleConfig>
Returns the detection-rule configuration for a catalog.
Parameters
- req: GetRuleConfigRequest
- Optionaloptions: CallOptions
Returns Promise<RuleConfig>
- Defined in client.ts:185

listDatasources

listDatasources(
req: ListDatasourcesRequest,
options?: CallOptions,
): Promise<ListDatasourcesResponse>
Lists the datasources in a Unity Catalog catalog, optionally narrowed to one schema or filtered by name. Results are paginated. Datasources that are still being created or deleted are not listed.
Parameters
- req: ListDatasourcesRequest
- Optionaloptions: CallOptions
Returns Promise<ListDatasourcesResponse>
- Defined in client.ts:483

listDatasourcesIter

listDatasourcesIter(
req: ListDatasourcesRequest,
options?: CallOptions,
): AsyncGenerator<Datasource>
Parameters
- req: ListDatasourcesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Datasource>
- Defined in client.ts:532

listRules

listRules(
req: ListRulesRequest,
options?: CallOptions,
): Promise<ListRulesResponse>
Lists rules, with optional filtering and pagination.
Parameters
- req: ListRulesRequest
- Optionaloptions: CallOptions
Returns Promise<ListRulesResponse>
- Defined in client.ts:674

listRulesIter

listRulesIter(
req: ListRulesRequest,
options?: CallOptions,
): AsyncGenerator<Rule>
Parameters
- req: ListRulesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Rule>
- Defined in client.ts:723

updateAlertConfig

updateAlertConfig(
req: UpdateAlertConfigRequest,
options?: CallOptions,
): Promise<AlertConfig>
Updates the alert delivery configuration for a catalog.
Parameters
- req: UpdateAlertConfigRequest
- Optionaloptions: CallOptions
Returns Promise<AlertConfig>
- Defined in client.ts:214

updateCommonConfig

updateCommonConfig(
req: UpdateCommonConfigRequest,
options?: CallOptions,
): Promise<CommonConfig>
Updates the common Lakewatch configuration for a catalog.
Parameters
- req: UpdateCommonConfigRequest
- Optionaloptions: CallOptions
Returns Promise<CommonConfig>
- Defined in client.ts:259

updateDatasource

updateDatasource(
req: UpdateDatasourceRequest,
options?: CallOptions,
): Promise<Datasource>
Updates an existing datasource.
Parameters
- req: UpdateDatasourceRequest
- Optionaloptions: CallOptions
Returns Promise<Datasource>
- Defined in client.ts:550

updateDatasourceConfig

updateDatasourceConfig(
req: UpdateDatasourceConfigRequest,
options?: CallOptions,
): Promise<DatasourceConfig>
Updates the datasource ingestion configuration for a catalog.
Parameters
- req: UpdateDatasourceConfigRequest
- Optionaloptions: CallOptions
Returns Promise<DatasourceConfig>
- Defined in client.ts:304

updateRule

updateRule(req: UpdateRuleRequest, options?: CallOptions): Promise<Rule>
Updates an existing rule.
Parameters
- req: UpdateRuleRequest
- Optionaloptions: CallOptions
Returns Promise<Rule>
- Defined in client.ts:741

updateRuleConfig

updateRuleConfig(
req: UpdateRuleConfigRequest,
options?: CallOptions,
): Promise<RuleConfig>
Updates the detection-rule configuration for a catalog.
Parameters
- req: UpdateRuleConfigRequest
- Optionaloptions: CallOptions
Returns Promise<RuleConfig>
- Defined in client.ts:352