Module adcp.types.generated_poc.property.property_error

Classes

class Code (*args, **kwds)
Expand source code
class Code(Enum):
    PROPERTY_NOT_FOUND = 'PROPERTY_NOT_FOUND'
    PROPERTY_NOT_MONITORED = 'PROPERTY_NOT_MONITORED'
    LIST_NOT_FOUND = 'LIST_NOT_FOUND'
    LIST_ACCESS_DENIED = 'LIST_ACCESS_DENIED'
    METHODOLOGY_NOT_SUPPORTED = 'METHODOLOGY_NOT_SUPPORTED'
    JURISDICTION_NOT_SUPPORTED = 'JURISDICTION_NOT_SUPPORTED'

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
<Color.RED: 1>
  • value lookup:
>>> Color(1)
<Color.RED: 1>
  • name lookup:
>>> Color['RED']
<Color.RED: 1>

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

>>> len(Color)
3
>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

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

Ancestors

  • enum.Enum

Class variables

var JURISDICTION_NOT_SUPPORTED
var LIST_ACCESS_DENIED
var LIST_NOT_FOUND
var METHODOLOGY_NOT_SUPPORTED
var PROPERTY_NOT_FOUND
var PROPERTY_NOT_MONITORED
class PropertyError (**data: Any)
Expand source code
class PropertyError(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    code: Annotated[Code, Field(description='Error code')]
    message: Annotated[str, Field(description='Human-readable error message')]
    property: Annotated[
        property_1.Property | None, Field(description='The property that caused the error')
    ] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so that unknown fields from newer spec versions are silently dropped rather than causing validation errors. Generated types whose schemas set additionalProperties: true override this with extra='allow' in their own model_config. Consumers who want strict validation can override with extra='forbid'.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var codeCode
var message : str
var model_config
var propertyProperty | None

Inherited members