client.models.ops

Module providing OperationState and Operation schemas.

Classes

OperationState	Create a collection of name/value pairs.
Operation	Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

Module Contents

class client.models.ops.OperationState(*args, **kwds)

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

  >>> Color.RED
  
  

• value lookup:

  >>> Color(1)
  
  

• name lookup:

  >>> Color['RED']
  
  

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[, , ]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Unknown = 'unknown'

Queued = 'queued'

Running = 'running'

Succeeded = 'succeeded'

Failed = 'failed'

class client.models.ops.Operation(/, **data: Any)

Bases: pydantic.BaseModel

Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

A base class for creating Pydantic models.

Attributes:

__class_vars__: The names of the class variables defined on the model. __private_attributes__: Metadata about the private attributes of the model. __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields. __pydantic_core_schema__: The core schema of the model. __pydantic_custom_init__: Whether the model has a custom __init__ function. __pydantic_decorators__: Metadata containing the decorators defined on the model.

This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to

__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models. __pydantic_post_init__: The name of the post-init method for the model, if defined. __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel]. __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model. __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra]

is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation. __pydantic_private__: Values of private attributes set on the model instance.

children: List[str] | None = None

description: str | None = None

ended_at: str | None = None

error: str | None = None

id: str | None = None

messages: List[str] | None = None

progress: float | None = None

progress_current: int | None = None

progress_total: int | None = None

queued_at: str | None = None

result: Any | None = None

started_at: str | None = None

state: OperationState | None = None

succeeded_on: List[str] | None = None

user_id: str | None = None