Databricks SDK for JavaScript
    Preparing search index...

    Request to update a Genie Agent, applying only the fields named in the update mask.

    interface UpdateGenieAgentRequest {
        etag?: string;
        genieAgent?: GenieAgent;
        updateMask?: FieldMask<GenieAgent>;
    }
    Index

    Properties

    etag?: string

    Etag from a previous read. On mismatch the update fails with ABORTED (metadata changes may already be applied); get the agent and retry. May return TEMPORARILY_UNAVAILABLE.

    genieAgent?: GenieAgent

    The Genie Agent to update. Its name identifies the resource; fields named in update_mask are applied.

    updateMask?: FieldMask<GenieAgent>

    The set of fields to update. The mask is required and must name at least one field; an empty or absent mask is rejected with INVALID_PARAMETER_VALUE, as is a path that is not an updatable field.

    A field named in the mask takes the value from genie_agent, even when it is unset there: an unset description is cleared; an unset display_name, warehouse_id, or definition is rejected with INVALID_PARAMETER_VALUE; an unset parent_path is cleared without moving the Genie Agent. definition is replaced as a whole; paths within it are not supported.

    The special value * replaces the whole Genie Agent, as if every updatable field were named. It must be the only path in the mask. Prefer naming fields explicitly: with *, any field added to Genie Agent later is also replaced, so a client unaware of it may clear it.