prefect.client.schemas.actions

Classes

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

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

FlowCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L78" 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/client/schemas/actions.py#L93" 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/client/schemas/actions.py#L116" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

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

from_schedule(cls, schedule: Schedule) -> 'DeploymentScheduleCreate'

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

validate_active(cls, v: Any, handler: Callable[[Any], Any]) -> bool

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

validate_max_scheduled_runs(cls, v: Optional[int]) -> Optional[int]

DeploymentScheduleUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L197" 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/client/schemas/actions.py#L224" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_max_scheduled_runs(cls, v: Optional[int]) -> Optional[int]

DeploymentCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L230" 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/client/schemas/actions.py#L310" 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.

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

convert_to_strings(cls, values: Optional[Union[str, list[str]]]) -> Union[str, list[str]]

remove_old_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L235" 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/client/schemas/actions.py#L330" 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/client/schemas/actions.py#L388" 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.

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

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

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

Methods:

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

validate_branch_length(cls, v: str) -> str

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

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

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

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

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

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

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

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

DeploymentFlowRunCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L525" 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:

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

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

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

serialize_parameters(self, value: dict[str, Any]) -> dict[str, Any]

Serialize datetime types as ISO strings instead of timestamps.

PrefectBaseModel has ser_json_timedelta='float' to serialize timedeltas as floats, but this also causes datetime/date/time to serialize as timestamps. This serializer overrides that behavior for datetime types while preserving float serialization for timedeltas.

SavedSearchCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L591" 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/client/schemas/actions.py#L600" 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/client/schemas/actions.py#L609" 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/client/schemas/actions.py#L629" 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/client/schemas/actions.py#L640" 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/client/schemas/actions.py#L661" 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/client/schemas/actions.py#L670" 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/client/schemas/actions.py#L674" 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/client/schemas/actions.py#L691" 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/client/schemas/actions.py#L715" 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/client/schemas/actions.py#L721" 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/client/schemas/actions.py#L736" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Data used to create block document reference.

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

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

Methods:

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

model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]

The worker_id field is only included in logs sent to Prefect Cloud. If it's unset, we should not include it in the log payload.

WorkPoolCreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L773" 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/client/schemas/actions.py#L800" 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/client/schemas/actions.py#L813" 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/client/schemas/actions.py#L842" 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/client/schemas/actions.py#L865" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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

ArtifactUpdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L877" 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/client/schemas/actions.py#L885" 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/client/schemas/actions.py#L897" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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

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

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

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

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