`prefect.client.schemas.actions`

Classes

`StateCreate`

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

`FlowCreate`

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

`FlowUpdate`

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

`DeploymentScheduleCreate`

Methods:

`from_schedule`

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

`validate_active`

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

`validate_max_scheduled_runs`

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

`DeploymentScheduleUpdate`

Methods:

`validate_max_scheduled_runs`

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

`DeploymentCreate`

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

`check_valid_configuration`

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`

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

`remove_old_fields`

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

`DeploymentUpdate`

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

`check_valid_configuration`

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`

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

`DeploymentBranch`

Methods:

`validate_branch_length`

validate_branch_length(cls, v: str) -> str

`FlowRunUpdate`

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

`TaskRunCreate`

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

`TaskRunUpdate`

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

`FlowRunCreate`

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

`DeploymentFlowRunCreate`

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

`convert_parameters_to_plain_data`

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

`SavedSearchCreate`

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

`ConcurrencyLimitCreate`

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

`ConcurrencyLimitV2Create`

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

`ConcurrencyLimitV2Update`

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

`BlockTypeCreate`

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

`BlockTypeUpdate`

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

`updatable_fields`

updatable_fields(cls) -> set[str]

`BlockSchemaCreate`

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

`BlockDocumentCreate`

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

`validate_name_is_present_if_not_anonymous`

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

`BlockDocumentUpdate`

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

`BlockDocumentReferenceCreate`

Data used to create block document reference.

`LogCreate`

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

`model_dump`

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`

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

`WorkPoolUpdate`

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

`WorkQueueCreate`

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

`WorkQueueUpdate`

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

`ArtifactCreate`

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

`ArtifactUpdate`

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

`VariableCreate`

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

`VariableUpdate`

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

`GlobalConcurrencyLimitCreate`

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

`GlobalConcurrencyLimitUpdate`

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

API Reference

​prefect.client.schemas.actions

​Classes

​StateCreate

​FlowCreate

​FlowUpdate

​DeploymentScheduleCreate

​from_schedule

​validate_active

​validate_max_scheduled_runs

​DeploymentScheduleUpdate

​validate_max_scheduled_runs

​DeploymentCreate

​check_valid_configuration

​convert_to_strings

​remove_old_fields

​DeploymentUpdate

​check_valid_configuration

​remove_old_fields

​DeploymentBranch

​validate_branch_length

​FlowRunUpdate

​TaskRunCreate

​TaskRunUpdate

​FlowRunCreate

​DeploymentFlowRunCreate

​convert_parameters_to_plain_data

​SavedSearchCreate

​ConcurrencyLimitCreate

​ConcurrencyLimitV2Create

​ConcurrencyLimitV2Update

​BlockTypeCreate

​BlockTypeUpdate

​updatable_fields

​BlockSchemaCreate

​BlockDocumentCreate

​validate_name_is_present_if_not_anonymous

​BlockDocumentUpdate

​BlockDocumentReferenceCreate

​LogCreate

​model_dump

​WorkPoolCreate

​WorkPoolUpdate

​WorkQueueCreate

​WorkQueueUpdate

​ArtifactCreate

​ArtifactUpdate

​VariableCreate

​VariableUpdate

​GlobalConcurrencyLimitCreate

​GlobalConcurrencyLimitUpdate

`prefect.client.schemas.actions`

Classes

`StateCreate`

`FlowCreate`

`FlowUpdate`

`DeploymentScheduleCreate`

`from_schedule`

`validate_active`

`validate_max_scheduled_runs`

`DeploymentScheduleUpdate`

`validate_max_scheduled_runs`

`DeploymentCreate`

`check_valid_configuration`

`convert_to_strings`

`remove_old_fields`

`DeploymentUpdate`

`check_valid_configuration`

`remove_old_fields`

`DeploymentBranch`

`validate_branch_length`

`FlowRunUpdate`

`TaskRunCreate`

`TaskRunUpdate`

`FlowRunCreate`

`DeploymentFlowRunCreate`

`convert_parameters_to_plain_data`

`SavedSearchCreate`

`ConcurrencyLimitCreate`

`ConcurrencyLimitV2Create`

`ConcurrencyLimitV2Update`

`BlockTypeCreate`

`BlockTypeUpdate`

`updatable_fields`

`BlockSchemaCreate`

`BlockDocumentCreate`

`validate_name_is_present_if_not_anonymous`

`BlockDocumentUpdate`

`BlockDocumentReferenceCreate`

`LogCreate`

`model_dump`

`WorkPoolCreate`

`WorkPoolUpdate`

`WorkQueueCreate`

`WorkQueueUpdate`

`ArtifactCreate`

`ArtifactUpdate`

`VariableCreate`

`VariableUpdate`

`GlobalConcurrencyLimitCreate`

`GlobalConcurrencyLimitUpdate`