Module `adcp.types.generated_poc.a2ui.bound_value`

Classes

class A2UiBoundValue (root: RootModelRootType = PydanticUndefined, **data)

Expand source code

class A2UiBoundValue(
    RootModel[
        A2UiBoundValue1 | A2UiBoundValue2 | A2UiBoundValue3 | A2UiBoundValue4 | A2UiBoundValue5
    ]
):
    root: Annotated[
        A2UiBoundValue1 | A2UiBoundValue2 | A2UiBoundValue3 | A2UiBoundValue4 | A2UiBoundValue5,
        Field(
            description='A value that can be a literal or bound to a path in the data model',
            title='A2UI Bound Value',
        ),
    ]

    def __getattr__(self, name: str) -> Any:
        """Proxy attribute access to the wrapped type."""
        if name.startswith('_'):
            raise AttributeError(name)
        return getattr(self.root, name)

Usage Documentation

RootModel and Custom Root Types

A Pydantic BaseModel for the root object of the model.

Attributes

root: The root object of the model.
__pydantic_root_model__: Whether the model is a RootModel.
__pydantic_private__: Private fields in the model.
__pydantic_extra__: Extra fields in the model.

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

pydantic.root_model.RootModel[Union[A2UiBoundValue1, A2UiBoundValue2, A2UiBoundValue3, A2UiBoundValue4, A2UiBoundValue5]]
pydantic.root_model.RootModel
pydantic.main.BaseModel
typing.Generic

Class variables

var model_config
var root : A2UiBoundValue1 | A2UiBoundValue2 | A2UiBoundValue3 | A2UiBoundValue4 | A2UiBoundValue5

class A2UiBoundValue1 (**data: Any)

Expand source code

class A2UiBoundValue1(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    literalString: Annotated[str, Field(description='Static string value')]

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

AdCPBaseModel
pydantic.main.BaseModel

Class variables

var literalString : str
var model_config

Inherited members

AdCPBaseModel:
- model_dump
- model_dump_json
- model_summary

class A2UiBoundValue2 (**data: Any)

Expand source code

class A2UiBoundValue2(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    literalNumber: Annotated[float, Field(description='Static number value')]

Base model for AdCP types with spec-compliant serialization.

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

AdCPBaseModel
pydantic.main.BaseModel

Class variables

var literalNumber : float
var model_config

Inherited members

AdCPBaseModel:
- model_dump
- model_dump_json
- model_summary

class A2UiBoundValue3 (**data: Any)

Expand source code

class A2UiBoundValue3(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    literalBoolean: Annotated[bool, Field(description='Static boolean value')]

Base model for AdCP types with spec-compliant serialization.

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

AdCPBaseModel
pydantic.main.BaseModel

Class variables

var literalBoolean : bool
var model_config

Inherited members

AdCPBaseModel:
- model_dump
- model_dump_json
- model_summary

class A2UiBoundValue4 (**data: Any)

Expand source code

class A2UiBoundValue4(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    path: Annotated[
        str,
        Field(description="JSON pointer path to value in data model (e.g., '/products/0/title')"),
    ]

Base model for AdCP types with spec-compliant serialization.

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

AdCPBaseModel
pydantic.main.BaseModel

Class variables

var model_config
var path : str

Inherited members

AdCPBaseModel:
- model_dump
- model_dump_json
- model_summary

class A2UiBoundValue5 (**data: Any)

Expand source code

class A2UiBoundValue5(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    literalString: str
    path: str

Base model for AdCP types with spec-compliant serialization.

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

AdCPBaseModel
pydantic.main.BaseModel

Class variables

var literalString : str
var model_config
var path : str

Inherited members

AdCPBaseModel:
- model_dump
- model_dump_json
- model_summary