Skip to content

prefect.orion.schemas.actions

Reduced schemas for accepting API actions.

BlockDocumentCreate pydantic-model

Data used by the Orion API to create a block document.

Source code in prefect/orion/schemas/actions.py
class BlockDocumentCreate(ActionBaseModel):
    """Data used by the Orion API to create a block document."""

    name: Optional[str] = FieldFrom(schemas.core.BlockDocument)
    data: dict = FieldFrom(schemas.core.BlockDocument)
    block_schema_id: UUID = FieldFrom(schemas.core.BlockDocument)
    block_type_id: UUID = FieldFrom(schemas.core.BlockDocument)
    is_anonymous: bool = FieldFrom(schemas.core.BlockDocument)

    _validate_name_format = validator("name", allow_reuse=True)(
        validate_block_document_name
    )

    @root_validator
    def validate_name_is_present_if_not_anonymous(cls, values):
        # TODO: We should find an elegant way to reuse this logic from the origin model
        if not values.get("is_anonymous") and not values.get("name"):
            raise ValueError("Names must be provided for block documents.")
        return values

block_schema_id pydantic-field

Type: UUID

A block schema ID

block_type_id pydantic-field

Type: UUID

A block type ID

data pydantic-field

Type: dict

The block document's data

is_anonymous pydantic-field

Type: bool

Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)

name pydantic-field

Type: str

The block document's name. Not required for anonymous block documents.

BlockDocumentReferenceCreate pydantic-model

Data used to create block document reference.

Source code in prefect/orion/schemas/actions.py
class BlockDocumentReferenceCreate(ActionBaseModel):
    """Data used to create block document reference."""

    id: UUID = FieldFrom(schemas.core.BlockDocumentReference)
    parent_block_document_id: UUID = FieldFrom(schemas.core.BlockDocumentReference)
    reference_block_document_id: UUID = FieldFrom(schemas.core.BlockDocumentReference)
    name: str = FieldFrom(schemas.core.BlockDocumentReference)

name pydantic-field

Type: str

The name that the reference is nested under

parent_block_document_id pydantic-field

Type: UUID

ID of block document the reference is nested within

reference_block_document_id pydantic-field

Type: UUID

ID of the nested block document

BlockDocumentUpdate pydantic-model

Data used by the Orion API to update a block document.

Source code in prefect/orion/schemas/actions.py
class BlockDocumentUpdate(ActionBaseModel):
    """Data used by the Orion API to update a block document."""

    data: dict = FieldFrom(schemas.core.BlockDocument)

data pydantic-field

Type: dict

The block document's data

BlockSchemaCreate pydantic-model

Data used by the Orion API to create a block schema.

Source code in prefect/orion/schemas/actions.py
class BlockSchemaCreate(ActionBaseModel):
    """Data used by the Orion API to create a block schema."""

    fields: dict = FieldFrom(schemas.core.BlockSchema)
    block_type_id: Optional[UUID] = FieldFrom(schemas.core.BlockSchema)
    capabilities: List[str] = FieldFrom(schemas.core.BlockSchema)
    version: str = FieldFrom(schemas.core.BlockSchema)

block_type_id pydantic-field

Type: UUID

A block type ID

capabilities pydantic-field

Type: List[str]

A list of Block capabilities

fields pydantic-field

Type: dict

The block schema's field schema

version pydantic-field

Type: str

Human readable identifier for the block schema

BlockTypeCreate pydantic-model

Data used by the Orion API to create a block type.

Source code in prefect/orion/schemas/actions.py
class BlockTypeCreate(ActionBaseModel):
    """Data used by the Orion API to create a block type."""

    name: str = FieldFrom(schemas.core.BlockType)
    slug: str = FieldFrom(schemas.core.BlockType)
    logo_url: Optional[schemas.core.HttpUrl] = FieldFrom(schemas.core.BlockType)
    documentation_url: Optional[schemas.core.HttpUrl] = FieldFrom(
        schemas.core.BlockType
    )
    description: Optional[str] = FieldFrom(schemas.core.BlockType)
    code_example: Optional[str] = FieldFrom(schemas.core.BlockType)

    # validators
    _validate_slug_format = validator("slug", allow_reuse=True)(
        validate_block_type_slug
    )

code_example pydantic-field

Type: str

A code snippet demonstrating use of the corresponding block

description pydantic-field

Type: str

A short blurb about the corresponding block's intended use

documentation_url pydantic-field

Type: HttpUrl

Web URL for the block type's documentation

logo_url pydantic-field

Type: HttpUrl

Web URL for the block type's logo

name pydantic-field

Type: str

A block type's name

slug pydantic-field

Type: str

A block type's slug

BlockTypeUpdate pydantic-model

Data used by the Orion API to update a block type.

Source code in prefect/orion/schemas/actions.py
class BlockTypeUpdate(ActionBaseModel):
    """Data used by the Orion API to update a block type."""

    logo_url: Optional[schemas.core.HttpUrl] = FieldFrom(schemas.core.BlockType)
    documentation_url: Optional[schemas.core.HttpUrl] = FieldFrom(
        schemas.core.BlockType
    )
    description: Optional[str] = FieldFrom(schemas.core.BlockType)
    code_example: Optional[str] = FieldFrom(schemas.core.BlockType)

code_example pydantic-field

Type: str

A code snippet demonstrating use of the corresponding block

description pydantic-field

Type: str

A short blurb about the corresponding block's intended use

documentation_url pydantic-field

Type: HttpUrl

Web URL for the block type's documentation

logo_url pydantic-field

Type: HttpUrl

Web URL for the block type's logo

ConcurrencyLimitCreate pydantic-model

Data used by the Orion API to create a concurrency limit.

Source code in prefect/orion/schemas/actions.py
class ConcurrencyLimitCreate(ActionBaseModel):
    """Data used by the Orion API to create a concurrency limit."""

    tag: str = FieldFrom(schemas.core.ConcurrencyLimit)
    concurrency_limit: int = FieldFrom(schemas.core.ConcurrencyLimit)

concurrency_limit pydantic-field

Type: int

The concurrency limit.

tag pydantic-field

Type: str

A tag the concurrency limit is applied to.

DeploymentCreate pydantic-model

Data used by the Orion API to create a deployment.

Source code in prefect/orion/schemas/actions.py
class DeploymentCreate(ActionBaseModel):
    """Data used by the Orion API to create a deployment."""

    name: str = FieldFrom(schemas.core.Deployment)
    flow_id: UUID = FieldFrom(schemas.core.Deployment)
    is_schedule_active: bool = FieldFrom(schemas.core.Deployment)
    parameters: Dict[str, Any] = FieldFrom(schemas.core.Deployment)
    tags: List[str] = FieldFrom(schemas.core.Deployment)

    manifest_path: Optional[str] = FieldFrom(schemas.core.Deployment)
    work_queue_name: Optional[str] = FieldFrom(schemas.core.Deployment)
    storage_document_id: Optional[UUID] = FieldFrom(schemas.core.Deployment)
    infrastructure_document_id: Optional[UUID] = FieldFrom(schemas.core.Deployment)
    schedule: Optional[schemas.schedules.SCHEDULE_TYPES] = FieldFrom(
        schemas.core.Deployment
    )
    description: Optional[str] = FieldFrom(schemas.core.Deployment)
    parameter_openapi_schema: Optional[Dict[str, Any]] = FieldFrom(
        schemas.core.Deployment
    )
    path: Optional[str] = FieldFrom(schemas.core.Deployment)
    version: Optional[str] = FieldFrom(schemas.core.Deployment)
    entrypoint: Optional[str] = FieldFrom(schemas.core.Deployment)
    infra_overrides: Optional[Dict[str, Any]] = FieldFrom(schemas.core.Deployment)

description pydantic-field

Type: str

A description for the deployment.

entrypoint pydantic-field

Type: str

The path to the entrypoint for the workflow, relative to the path.

flow_id pydantic-field

Type: UUID

The flow id associated with the deployment.

infra_overrides pydantic-field

Type: Dict[str, Any]

Overrides to apply to the base infrastructure block at runtime.

infrastructure_document_id pydantic-field

Type: UUID

The block document defining infrastructure to use for flow runs.

is_schedule_active pydantic-field

Type: bool

Whether or not the deployment schedule is active.

manifest_path pydantic-field

Type: str

The path to the flow's manifest file, relative to the chosen storage.

name pydantic-field

Type: str

The name of the deployment.

parameter_openapi_schema pydantic-field

Type: Dict[str, Any]

The parameter schema of the flow, including defaults.

parameters pydantic-field

Type: Dict[str, Any]

Parameters for flow runs scheduled by the deployment.

path pydantic-field

Type: str

The path to the working directory for the workflow, relative to remote storage or an absolute path.

schedule pydantic-field

Type: Union[prefect.orion.schemas.schedules.IntervalSchedule, prefect.orion.schemas.schedules.CronSchedule, prefect.orion.schemas.schedules.RRuleSchedule]

A schedule for the deployment.

storage_document_id pydantic-field

Type: UUID

The block document defining storage used for this flow.

tags pydantic-field

Type: List[str]

A list of tags for the deployment

version pydantic-field

Type: str

An optional version for the deployment.

work_queue_name pydantic-field

Type: str

The work queue for the deployment. If no work queue is set, work will not be scheduled.

DeploymentFlowRunCreate pydantic-model

Data used by the Orion API to create a flow run from a deployment.

Source code in prefect/orion/schemas/actions.py
class DeploymentFlowRunCreate(ActionBaseModel):
    """Data used by the Orion API to create a flow run from a deployment."""

    # FlowRunCreate states must be provided as StateCreate objects
    state: Optional[StateCreate] = Field(
        default=None, description="The state of the flow run to create"
    )

    name: Optional[str] = FieldFrom(schemas.core.FlowRun)
    parameters: dict = FieldFrom(schemas.core.FlowRun)
    context: dict = FieldFrom(schemas.core.FlowRun)
    infrastructure_document_id: Optional[UUID] = FieldFrom(schemas.core.FlowRun)
    empirical_policy: schemas.core.FlowRunPolicy = FieldFrom(schemas.core.FlowRun)
    tags: List[str] = FieldFrom(schemas.core.FlowRun)
    idempotency_key: Optional[str] = FieldFrom(schemas.core.FlowRun)

context pydantic-field

Type: dict

Additional context for the flow run.

idempotency_key pydantic-field

Type: str

An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times.

infrastructure_document_id pydantic-field

Type: UUID

The block document defining infrastructure to use this flow run.

name pydantic-field

Type: str

The name of the flow run. Defaults to a random slug if not specified.

parameters pydantic-field

Type: dict

Parameters for the flow run.

state pydantic-field

Type: StateCreate

The state of the flow run to create

tags pydantic-field

Type: List[str]

A list of tags on the flow run

DeploymentUpdate pydantic-model

Data used by the Orion API to update a deployment.

Source code in prefect/orion/schemas/actions.py
class DeploymentUpdate(ActionBaseModel):
    """Data used by the Orion API to update a deployment."""

    version: Optional[str] = FieldFrom(schemas.core.Deployment)
    schedule: Optional[schemas.schedules.SCHEDULE_TYPES] = FieldFrom(
        schemas.core.Deployment
    )
    description: Optional[str] = FieldFrom(schemas.core.Deployment)
    is_schedule_active: bool = FieldFrom(schemas.core.Deployment)
    parameters: Dict[str, Any] = FieldFrom(schemas.core.Deployment)
    tags: List[str] = FieldFrom(schemas.core.Deployment)
    work_queue_name: Optional[str] = FieldFrom(schemas.core.Deployment)
    path: Optional[str] = FieldFrom(schemas.core.Deployment)
    infra_overrides: Optional[Dict[str, Any]] = FieldFrom(schemas.core.Deployment)
    entrypoint: Optional[str] = FieldFrom(schemas.core.Deployment)
    manifest_path: Optional[str] = FieldFrom(schemas.core.Deployment)
    storage_document_id: Optional[UUID] = FieldFrom(schemas.core.Deployment)
    infrastructure_document_id: Optional[UUID] = FieldFrom(schemas.core.Deployment)

description pydantic-field

Type: str

A description for the deployment.

entrypoint pydantic-field

Type: str

The path to the entrypoint for the workflow, relative to the path.

infra_overrides pydantic-field

Type: Dict[str, Any]

Overrides to apply to the base infrastructure block at runtime.

infrastructure_document_id pydantic-field

Type: UUID

The block document defining infrastructure to use for flow runs.

is_schedule_active pydantic-field

Type: bool

Whether or not the deployment schedule is active.

manifest_path pydantic-field

Type: str

The path to the flow's manifest file, relative to the chosen storage.

parameters pydantic-field

Type: Dict[str, Any]

Parameters for flow runs scheduled by the deployment.

path pydantic-field

Type: str

The path to the working directory for the workflow, relative to remote storage or an absolute path.

schedule pydantic-field

Type: Union[prefect.orion.schemas.schedules.IntervalSchedule, prefect.orion.schemas.schedules.CronSchedule, prefect.orion.schemas.schedules.RRuleSchedule]

A schedule for the deployment.

storage_document_id pydantic-field

Type: UUID

The block document defining storage used for this flow.

tags pydantic-field

Type: List[str]

A list of tags for the deployment

version pydantic-field

Type: str

An optional version for the deployment.

work_queue_name pydantic-field

Type: str

The work queue for the deployment. If no work queue is set, work will not be scheduled.

FlowCreate pydantic-model

Data used by the Orion API to create a flow.

Source code in prefect/orion/schemas/actions.py
class FlowCreate(ActionBaseModel):
    """Data used by the Orion API to create a flow."""

    name: str = FieldFrom(schemas.core.Flow)
    tags: List[str] = FieldFrom(schemas.core.Flow)

name pydantic-field

Type: str

The name of the flow

tags pydantic-field

Type: List[str]

A list of flow tags

FlowRunCreate pydantic-model

Data used by the Orion API to create a flow run.

Source code in prefect/orion/schemas/actions.py
class FlowRunCreate(ActionBaseModel):
    """Data used by the Orion API to create a flow run."""

    # FlowRunCreate states must be provided as StateCreate objects
    state: Optional[StateCreate] = Field(
        default=None, description="The state of the flow run to create"
    )

    name: str = FieldFrom(schemas.core.FlowRun)
    flow_id: UUID = FieldFrom(schemas.core.FlowRun)
    deployment_id: Optional[UUID] = FieldFrom(schemas.core.FlowRun)
    flow_version: Optional[str] = FieldFrom(schemas.core.FlowRun)
    parameters: dict = FieldFrom(schemas.core.FlowRun)
    context: dict = FieldFrom(schemas.core.FlowRun)
    parent_task_run_id: Optional[UUID] = FieldFrom(schemas.core.FlowRun)
    infrastructure_document_id: Optional[UUID] = FieldFrom(schemas.core.FlowRun)
    empirical_policy: schemas.core.FlowRunPolicy = FieldFrom(schemas.core.FlowRun)
    tags: List[str] = FieldFrom(schemas.core.FlowRun)
    idempotency_key: Optional[str] = FieldFrom(schemas.core.FlowRun)

context pydantic-field

Type: dict

Additional context for the flow run.

deployment_id pydantic-field

Type: UUID

The id of the deployment associated with this flow run, if available.

flow_id pydantic-field

Type: UUID

The id of the flow being run.

flow_version pydantic-field

Type: str

The version of the flow executed in this flow run.

idempotency_key pydantic-field

Type: str

An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times.

infrastructure_document_id pydantic-field

Type: UUID

The block document defining infrastructure to use this flow run.

name pydantic-field

Type: str

The name of the flow run. Defaults to a random slug if not specified.

parameters pydantic-field

Type: dict

Parameters for the flow run.

parent_task_run_id pydantic-field

Type: UUID

If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state.

state pydantic-field

Type: StateCreate

The state of the flow run to create

tags pydantic-field

Type: List[str]

A list of tags on the flow run

FlowRunNotificationPolicyCreate pydantic-model

Data used by the Orion API to create a flow run notification policy.

Source code in prefect/orion/schemas/actions.py
class FlowRunNotificationPolicyCreate(ActionBaseModel):
    """Data used by the Orion API to create a flow run notification policy."""

    is_active: bool = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    state_names: List[str] = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    tags: List[str] = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    block_document_id: UUID = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    message_template: Optional[str] = FieldFrom(schemas.core.FlowRunNotificationPolicy)

block_document_id pydantic-field

Type: UUID

The block document ID used for sending notifications

is_active pydantic-field

Type: bool

Whether the policy is currently active

message_template pydantic-field

Type: str

A templatable notification message. Use {braces} to add variables. Valid variables include: 'flow_id', 'flow_name', 'flow_run_id', 'flow_run_name', 'flow_run_notification_policy_id', 'flow_run_parameters', 'flow_run_state_message', 'flow_run_state_name', 'flow_run_state_timestamp', 'flow_run_state_type', 'flow_run_url'

state_names pydantic-field

Type: List[str]

The flow run states that trigger notifications

tags pydantic-field

Type: List[str]

The flow run tags that trigger notifications (set [] to disable)

FlowRunNotificationPolicyUpdate pydantic-model

Data used by the Orion API to update a flow run notification policy.

Source code in prefect/orion/schemas/actions.py
class FlowRunNotificationPolicyUpdate(ActionBaseModel):
    """Data used by the Orion API to update a flow run notification policy."""

    is_active: Optional[bool] = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    state_names: Optional[List[str]] = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    tags: Optional[List[str]] = FieldFrom(schemas.core.FlowRunNotificationPolicy)
    block_document_id: Optional[UUID] = FieldFrom(
        schemas.core.FlowRunNotificationPolicy
    )
    message_template: Optional[str] = FieldFrom(schemas.core.FlowRunNotificationPolicy)

block_document_id pydantic-field

Type: UUID

The block document ID used for sending notifications

is_active pydantic-field

Type: bool

Whether the policy is currently active

message_template pydantic-field

Type: str

A templatable notification message. Use {braces} to add variables. Valid variables include: 'flow_id', 'flow_name', 'flow_run_id', 'flow_run_name', 'flow_run_notification_policy_id', 'flow_run_parameters', 'flow_run_state_message', 'flow_run_state_name', 'flow_run_state_timestamp', 'flow_run_state_type', 'flow_run_url'

state_names pydantic-field

Type: List[str]

The flow run states that trigger notifications

tags pydantic-field

Type: List[str]

The flow run tags that trigger notifications (set [] to disable)

FlowRunUpdate pydantic-model

Data used by the Orion API to update a flow run.

Source code in prefect/orion/schemas/actions.py
class FlowRunUpdate(ActionBaseModel):
    """Data used by the Orion API to update a flow run."""

    name: Optional[str] = FieldFrom(schemas.core.FlowRun)
    flow_version: Optional[str] = FieldFrom(schemas.core.FlowRun)
    parameters: dict = FieldFrom(schemas.core.FlowRun)
    empirical_policy: schemas.core.FlowRunPolicy = FieldFrom(schemas.core.FlowRun)
    tags: List[str] = FieldFrom(schemas.core.FlowRun)

flow_version pydantic-field

Type: str

The version of the flow executed in this flow run.

name pydantic-field

Type: str

The name of the flow run. Defaults to a random slug if not specified.

parameters pydantic-field

Type: dict

Parameters for the flow run.

tags pydantic-field

Type: List[str]

A list of tags on the flow run

FlowUpdate pydantic-model

Data used by the Orion API to update a flow.

Source code in prefect/orion/schemas/actions.py
class FlowUpdate(ActionBaseModel):
    """Data used by the Orion API to update a flow."""

    tags: List[str] = FieldFrom(schemas.core.Flow)

tags pydantic-field

Type: List[str]

A list of flow tags

LogCreate pydantic-model

Data used by the Orion API to create a log.

Source code in prefect/orion/schemas/actions.py
class LogCreate(ActionBaseModel):
    """Data used by the Orion API to create a log."""

    name: str = FieldFrom(schemas.core.Log)
    level: int = FieldFrom(schemas.core.Log)
    message: str = FieldFrom(schemas.core.Log)
    timestamp: schemas.core.DateTimeTZ = FieldFrom(schemas.core.Log)
    flow_run_id: UUID = FieldFrom(schemas.core.Log)
    task_run_id: Optional[UUID] = FieldFrom(schemas.core.Log)

flow_run_id pydantic-field

Type: UUID

The flow run ID associated with the log.

level pydantic-field

Type: int

The log level.

message pydantic-field

Type: str

The log message.

name pydantic-field

Type: str

The logger name.

task_run_id pydantic-field

Type: UUID

The task run ID associated with the log.

timestamp pydantic-field

Type: DateTimeTZ

The log timestamp.

SavedSearchCreate pydantic-model

Data used by the Orion API to create a saved search.

Source code in prefect/orion/schemas/actions.py
class SavedSearchCreate(ActionBaseModel):
    """Data used by the Orion API to create a saved search."""

    name: str = FieldFrom(schemas.core.SavedSearch)
    filters: List[schemas.core.SavedSearchFilter] = FieldFrom(schemas.core.SavedSearch)

filters pydantic-field

Type: List[prefect.orion.schemas.core.SavedSearchFilter]

The filter set for the saved search.

name pydantic-field

Type: str

The name of the saved search.

StateCreate pydantic-model

Data used by the Orion API to create a new state.

Source code in prefect/orion/schemas/actions.py
class StateCreate(ActionBaseModel):
    """Data used by the Orion API to create a new state."""

    type: schemas.states.StateType = FieldFrom(schemas.states.State)
    name: Optional[str] = FieldFrom(schemas.states.State)
    message: Optional[str] = FieldFrom(schemas.states.State)
    data: Optional[schemas.data.DataDocument] = FieldFrom(schemas.states.State)
    state_details: schemas.states.StateDetails = FieldFrom(schemas.states.State)

    # DEPRECATED

    timestamp: Optional[schemas.core.DateTimeTZ] = Field(
        default=None,
        repr=False,
        ignored=True,
    )
    id: Optional[UUID] = Field(default=None, repr=False, ignored=True)

TaskRunCreate pydantic-model

Data used by the Orion API to create a task run

Source code in prefect/orion/schemas/actions.py
class TaskRunCreate(ActionBaseModel):
    """Data used by the Orion API to create a task run"""

    # TaskRunCreate states must be provided as StateCreate objects
    state: Optional[StateCreate] = Field(
        default=None, description="The state of the task run to create"
    )

    name: str = FieldFrom(schemas.core.TaskRun)
    flow_run_id: UUID = FieldFrom(schemas.core.TaskRun)
    task_key: str = FieldFrom(schemas.core.TaskRun)
    dynamic_key: str = FieldFrom(schemas.core.TaskRun)
    cache_key: Optional[str] = FieldFrom(schemas.core.TaskRun)
    cache_expiration: Optional[schemas.core.DateTimeTZ] = FieldFrom(
        schemas.core.TaskRun
    )
    task_version: Optional[str] = FieldFrom(schemas.core.TaskRun)
    empirical_policy: schemas.core.TaskRunPolicy = FieldFrom(schemas.core.TaskRun)
    tags: List[str] = FieldFrom(schemas.core.TaskRun)
    task_inputs: Dict[
        str,
        List[
            Union[
                schemas.core.TaskRunResult,
                schemas.core.Parameter,
                schemas.core.Constant,
            ]
        ],
    ] = FieldFrom(schemas.core.TaskRun)

cache_expiration pydantic-field

Type: DateTimeTZ

Specifies when the cached state should expire.

cache_key pydantic-field

Type: str

An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run.

dynamic_key pydantic-field

Type: str

A dynamic key used to differentiate between multiple runs of the same task within the same flow run.

flow_run_id pydantic-field

Type: UUID

The flow run id of the task run.

state pydantic-field

Type: StateCreate

The state of the task run to create

tags pydantic-field

Type: List[str]

A list of tags for the task run.

task_inputs pydantic-field

Type: Dict[str, List[Union[prefect.orion.schemas.core.TaskRunResult, prefect.orion.schemas.core.Parameter, prefect.orion.schemas.core.Constant]]]

Tracks the source of inputs to a task run. Used for internal bookkeeping.

task_key pydantic-field

Type: str

A unique identifier for the task being run.

task_version pydantic-field

Type: str

The version of the task being run.

WorkQueueCreate pydantic-model

Data used by the Orion API to create a work queue.

Source code in prefect/orion/schemas/actions.py
class WorkQueueCreate(ActionBaseModel):
    """Data used by the Orion API to create a work queue."""

    name: str = FieldFrom(schemas.core.WorkQueue)
    description: Optional[str] = FieldFrom(schemas.core.WorkQueue)
    is_paused: bool = FieldFrom(schemas.core.WorkQueue)
    concurrency_limit: Optional[int] = FieldFrom(schemas.core.WorkQueue)

    # DEPRECATED

    filter: Optional[schemas.core.QueueFilter] = Field(
        None,
        description="DEPRECATED: Filter criteria for the work queue.",
        deprecated=True,
    )

concurrency_limit pydantic-field

Type: int

An optional concurrency limit for the work queue.

description pydantic-field

Type: str

An optional description for the work queue.

filter pydantic-field

Type: QueueFilter

is_paused pydantic-field

Type: bool

Whether or not the work queue is paused.

name pydantic-field

Type: str

The name of the work queue.

WorkQueueUpdate pydantic-model

Data used by the Orion API to update a work queue.

Source code in prefect/orion/schemas/actions.py
class WorkQueueUpdate(ActionBaseModel):
    """Data used by the Orion API to update a work queue."""

    description: Optional[str] = FieldFrom(schemas.core.WorkQueue)
    is_paused: bool = FieldFrom(schemas.core.WorkQueue)
    concurrency_limit: Optional[int] = FieldFrom(schemas.core.WorkQueue)

    # DEPRECATED

    filter: Optional[schemas.core.QueueFilter] = Field(
        None,
        description="DEPRECATED: Filter criteria for the work queue.",
        deprecated=True,
    )
    name: Optional[str] = Field(
        default=None,
        description="DEPRECATED: The name of the work queue.",
        deprecated=True,
    )

concurrency_limit pydantic-field

Type: int

An optional concurrency limit for the work queue.

description pydantic-field

Type: str

An optional description for the work queue.

filter pydantic-field

Type: QueueFilter

is_paused pydantic-field

Type: bool

Whether or not the work queue is paused.