SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias UpdateScriptRequest

    UpdateScriptRequest: Message<"soulfire.v1.UpdateScriptRequest"> & {
        description?: string;
        edges: ScriptEdge[];
        instanceId: string;
        name?: string;
        nodes: ScriptNode[];
        paused?: boolean;
        quotas?: ScriptQuotas;
        scriptId: string;
        updateEdges: boolean;
        updateNodes: boolean;
        updateQuotas: boolean;
    }

    Request to update an existing script.

    Type Declaration

    • Optionaldescription?: string

      Updated description for the script. If not set, the description remains unchanged.

      from field: optional string description = 4;

    • edges: ScriptEdge[]

      Updated list of edges. If provided, replaces the entire edge list. If not provided, edges remain unchanged.

      from field: repeated soulfire.v1.ScriptEdge edges = 7;

    • instanceId: string

      The instance containing the script. Format: UUID string.

      from field: string instance_id = 1;

    • Optionalname?: string

      Updated name for the script. If not set, the name remains unchanged.

      from field: optional string name = 3;

    • nodes: ScriptNode[]

      Updated list of nodes. If provided, replaces the entire node list. If not provided, nodes remain unchanged.

      from field: repeated soulfire.v1.ScriptNode nodes = 6;

    • Optionalpaused?: boolean

      Updated paused setting. If not set, the paused setting remains unchanged. If set to false and script was paused, the script will be restarted.

      from field: optional bool paused = 10;

    • Optionalquotas?: ScriptQuotas

      Updated resource quotas for this script.

      from field: soulfire.v1.ScriptQuotas quotas = 11;

    • scriptId: string

      The ID of the script to update. Format: UUID string.

      from field: string script_id = 2;

    • updateEdges: boolean

      Whether the edges field should be updated (allows setting to empty list).

      from field: bool update_edges = 9;

    • updateNodes: boolean

      Whether the nodes field should be updated (allows setting to empty list).

      from field: bool update_nodes = 8;

    • updateQuotas: boolean

      Whether the quotas field should be updated (allows clearing quotas).

      from field: bool update_quotas = 12;

    from message soulfire.v1.UpdateScriptRequest