prefect.client.schemas.filters
Schemas that define Prefect REST API filtering operations.
Classes
Operator
Operators for combining filter criteria.
Methods:
auto
enum.auto()
to avoid requiring a second import to use AutoEnum
OperatorMixin
Base model for Prefect filters that combines criteria with a user-provided operator
FlowFilterId
Filter by Flow.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowFilterName
Filter by Flow.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowFilterTags
Filter by Flow.tags
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowFilter
Filter for flows. Only flows matching all criteria will be returned.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterId
Filter by FlowRun.id.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterName
Filter by FlowRun.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterTags
Filter by FlowRun.tags
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterDeploymentId
Filter by FlowRun.deployment_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterWorkQueueName
Filter by FlowRun.work_queue_name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterStateType
Filter by FlowRun.state_type
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterStateName
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterState
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterFlowVersion
Filter by FlowRun.flow_version
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterStartTime
Filter by FlowRun.start_time
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterExpectedStartTime
Filter by FlowRun.expected_start_time
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterNextScheduledStartTime
Filter by FlowRun.next_scheduled_start_time
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterParentFlowRunId
Filter for subflows of the given flow runs
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterParentTaskRunId
Filter by FlowRun.parent_task_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilterIdempotencyKey
Filter by FlowRun.idempotency_key.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FlowRunFilter
Filter flow runs. Only flow runs matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterFlowRunId
Filter by TaskRun.flow_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterId
Filter by TaskRun.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterName
Filter by TaskRun.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterTags
Filter by TaskRun.tags
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterStateType
Filter by TaskRun.state_type
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterStateName
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterState
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterSubFlowRuns
Filter by TaskRun.subflow_run
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilterStartTime
Filter by TaskRun.start_time
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
TaskRunFilter
Filter task runs. Only task runs matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilterId
Filter by Deployment.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilterName
Filter by Deployment.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilterWorkQueueName
Filter by Deployment.work_queue_name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilterTags
Filter by Deployment.tags
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilterConcurrencyLimit
DEPRECATED: Prefer Deployment.concurrency_limit_id
over Deployment.concurrency_limit
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
DeploymentFilter
Filter for deployments. Only deployments matching all criteria will be returned.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilterName
Filter by Log.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilterLevel
Filter by Log.level
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilterTimestamp
Filter by Log.timestamp
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilterFlowRunId
Filter by Log.flow_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilterTaskRunId
Filter by Log.task_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
LogFilter
Filter logs. Only logs matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
FilterSet
A collection of filters for common objects
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockTypeFilterName
Filter by BlockType.name
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockTypeFilterSlug
Filter by BlockType.slug
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockTypeFilter
Filter BlockTypes
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockSchemaFilterBlockTypeId
Filter by BlockSchema.block_type_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockSchemaFilterId
Filter by BlockSchema.id
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockSchemaFilterCapabilities
Filter by BlockSchema.capabilities
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockSchemaFilterVersion
Filter by BlockSchema.capabilities
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockSchemaFilter
Filter BlockSchemas
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockDocumentFilterIsAnonymous
Filter by BlockDocument.is_anonymous
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockDocumentFilterBlockTypeId
Filter by BlockDocument.block_type_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockDocumentFilterId
Filter by BlockDocument.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockDocumentFilterName
Filter by BlockDocument.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
BlockDocumentFilter
Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkQueueFilterId
Filter by WorkQueue.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkQueueFilterName
Filter by WorkQueue.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkQueueFilter
Filter work queues. Only work queues matching all criteria will be
returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkPoolFilterId
Filter by WorkPool.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkPoolFilterName
Filter by WorkPool.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkPoolFilterType
Filter by WorkPool.type
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkPoolFilter
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkerFilterWorkPoolId
Filter by Worker.worker_config_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkerFilterLastHeartbeatTime
Filter by Worker.last_heartbeat_time
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkerFilterStatus
Filter by Worker.status
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
WorkerFilter
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilterId
Filter by Artifact.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilterKey
Filter by Artifact.key
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilterFlowRunId
Filter by Artifact.flow_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilterTaskRunId
Filter by Artifact.task_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilterType
Filter by Artifact.type
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactFilter
Filter artifacts. Only artifacts matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilterLatestId
Filter by ArtifactCollection.latest_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilterKey
Filter by ArtifactCollection.key
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilterFlowRunId
Filter by ArtifactCollection.flow_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilterTaskRunId
Filter by ArtifactCollection.task_run_id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilterType
Filter by ArtifactCollection.type
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
ArtifactCollectionFilter
Filter artifact collections. Only artifact collections matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
VariableFilterId
Filter by Variable.id
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
VariableFilterName
Filter by Variable.name
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
VariableFilterTags
Filter by Variable.tags
.
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.
VariableFilter
Filter variables. Only variables matching all criteria will be returned
Methods:
model_validate_list
reset_fields
_reset_fields
set.
Returns:
- A new instance of the model with the reset fields.