Databricks SDK for JavaScript
    Preparing search index...

    Interface ListRulesRequest

    interface ListRulesRequest {
        catalogName?: string;
        filter?: string;
        pageSize?: number;
        pageToken?: string;
        schemaName?: string;
        view?: RuleView;
    }
    Index

    Properties

    catalogName? filter? pageSize? pageToken? schemaName? view?

    Properties

    catalogName?: string

    Name of the Unity Catalog catalog to list rules from. Required.

    filter?: string

    Filter expression that restricts the results, such as rule_name = "my_rule" to return only the rule with that name. The name is matched against the current UC name, which reads report in effective_rule_name.

    pageSize?: number

    Maximum number of rules to return. The server may return fewer. If unset or 0, the server picks a default page size.

    pageToken?: string

    Page token from a previous ListRules response, used to fetch the next page of results.

    schemaName?: string

    Name of a Unity Catalog schema in catalog_name. If set, only rules in this schema are returned. If unset, rules in all schemas of the catalog are returned.

    view?: RuleView

    How much of each rule to return. Defaults to RULE_VIEW_FULL. RULE_VIEW_BASIC returns only each rule's identity and Unity Catalog location.

    Settings

    Member Visibility

    On This Page

    Properties