prefect.server.schemas.actions

Reduced schemas for accepting API actions.

Functions

validate_base_job_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L884" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_base_job_template(v: dict[str, Any]) -> dict[str, Any]

Classes

ActionBaseModel ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L63" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

FlowCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L67" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a flow.

FlowUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a flow.

DeploymentScheduleCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

validate_max_scheduled_runs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L135" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_max_scheduled_runs(cls, v: PositiveInteger | None) -> PositiveInteger | None

DeploymentScheduleUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L143" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

validate_max_scheduled_runs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L169" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_max_scheduled_runs(cls, v: PositiveInteger | None) -> PositiveInteger | None

DeploymentCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L177" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a deployment.

Methods:

check_valid_configuration ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L255" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

check_valid_configuration(self, base_job_template: dict[str, Any]) -> None

Check that the combination of base_job_template defaults and job_variables conforms to the specified schema.

NOTE: This method does not hydrate block references in default values within the base job template to validate them. Failing to do this can cause user-facing errors. Instead of this method, use validate_job_variables_for_deployment function from prefect_cloud.orion.api.validation.

remove_old_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L281" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]

DeploymentUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L310" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a deployment.

Methods:

check_valid_configuration ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L377" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

check_valid_configuration(self, base_job_template: dict[str, Any]) -> None

Check that the combination of base_job_template defaults and job_variables conforms to the schema specified in the base_job_template.

NOTE: This method does not hydrate block references in default values within the base job template to validate them. Failing to do this can cause user-facing errors. Instead of this method, use validate_job_variables_for_deployment function from prefect_cloud.orion.api.validation.

remove_old_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L315" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]

FlowRunUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L416" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a flow run.

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L431" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

StateCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L435" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a new state.

Methods:

default_name_from_type ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L456" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

default_name_from_type(self)

If a name is not provided, use the type

default_scheduled_start_time ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L466" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

default_scheduled_start_time(self)

TaskRunCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L476" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a task run

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L548" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

validate_cache_key ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L553" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_cache_key(cls, cache_key: str | None) -> str | None

TaskRunUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L557" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a task run

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L566" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

FlowRunCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L570" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a flow run.

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L645" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

DeploymentFlowRunCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L649" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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

Methods:

set_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L704" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_name(cls, name: str) -> str

SavedSearchCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L708" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a saved search.

ConcurrencyLimitCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L717" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a concurrency limit.

ConcurrencyLimitV2Create ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L726" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a v2 concurrency limit.

ConcurrencyLimitV2Update ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L746" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a v2 concurrency limit.

BlockTypeCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L757" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a block type.

BlockTypeUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L778" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a block type.

Methods:

updatable_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L787" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

updatable_fields(cls) -> set[str]

BlockSchemaCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L791" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a block schema.

BlockDocumentCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L809" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a block document.

Methods:

validate_name_is_present_if_not_anonymous ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L834" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]

BlockDocumentUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L840" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a block document.

BlockDocumentReferenceCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L852" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used to create block document reference.

Methods:

validate_parent_and_ref_are_different ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L869" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_parent_and_ref_are_different(cls, values)

LogCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L873" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a log.

WorkPoolCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L915" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a work pool.

WorkPoolUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L944" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a work pool.

WorkQueueCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L960" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a work queue.

WorkQueueUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L989" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a work queue.

ArtifactCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1010" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create an artifact.

Methods:

from_result ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1050" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

from_result(cls, data: Any | dict[str, Any]) -> 'ArtifactCreate'

ArtifactUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1068" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update an artifact.

VariableCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1078" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to create a Variable.

VariableUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/actions.py#L1094" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used by the Prefect REST API to update a Variable.