Type Alias RunScriptByPathData

RunScriptByPathData: {
    cacheTtl?: string;
    invisibleToOwner?: boolean;
    jobId?: string;
    parentJob?: string;
    path: string;
    requestBody: ScriptArgs;
    scheduledFor?: string;
    scheduledInSecs?: number;
    tag?: string;
    workspace: string;
}

Type declaration

  • OptionalcacheTtl?: string

    Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl

  • OptionalinvisibleToOwner?: boolean

    make the run invisible to the the script owner (default false)

  • OptionaljobId?: string

    The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)

  • OptionalparentJob?: string

    The parent job that is at the origin and responsible for the execution of this script if any

  • path: string
  • requestBody: ScriptArgs

    script args

  • OptionalscheduledFor?: string

    when to schedule this job (leave empty for immediate run)

  • OptionalscheduledInSecs?: number

    schedule the script to execute in the number of seconds starting now

  • Optionaltag?: string

    Override the tag to use

  • workspace: string

Settings

Member Visibility