pa_api.xmlapi.types.config.zone

View Source

 1from typing import Optional
 2
 3from pydantic import AliasPath, ConfigDict, Field
 4
 5from pa_api.xmlapi.types.utils import List, String, XMLBaseModel
 6
 7
 8class ZoneNetwork(XMLBaseModel):
 9    model_config = ConfigDict(extra="allow")
10
11    name: String = Field(validation_alias="@name", default="")
12    layer3: List[String] = Field(
13        validation_alias=AliasPath("layer3", "member"),
14        default_factory=list,
15    )
16    enable_packet_buffer_protection: Optional[bool] = Field(
17        validation_alias=AliasPath("enable-packet-buffer-protection", "#text"),
18        default=None,
19    )
20
21
22class Zone(XMLBaseModel):
23    model_config = ConfigDict(extra="allow")
24
25    name: String = Field(validation_alias="@name", default="")
26    network: Optional[ZoneNetwork] = None
27    enable_user_identification: Optional[bool] = Field(
28        validation_alias=AliasPath("enable-user-identification", "#text"), default=None
29    )
30    enable_device_identification: Optional[bool] = Field(
31        validation_alias=AliasPath("enable-device-identification", "#text"),
32        default=None,
33    )

class ZoneNetwork(pa_api.xmlapi.types.utils.XMLBaseModel): View Source

 9class ZoneNetwork(XMLBaseModel):
10    model_config = ConfigDict(extra="allow")
11
12    name: String = Field(validation_alias="@name", default="")
13    layer3: List[String] = Field(
14        validation_alias=AliasPath("layer3", "member"),
15        default_factory=list,
16    )
17    enable_packet_buffer_protection: Optional[bool] = Field(
18        validation_alias=AliasPath("enable-packet-buffer-protection", "#text"),
19        default=None,
20    )

Usage docs: https://docs.pydantic.dev/2.9/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_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.

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: typing.Annotated[str, BeforeValidator(func=<function ensure_str at 0x7f0db0c89bd0>, json_schema_input_type=PydanticUndefined)]

layer3: Annotated[List[Annotated[str, BeforeValidator(func=<function ensure_str at 0x7f0db0c89bd0>, json_schema_input_type=PydanticUndefined)]], BeforeValidator(func=<function ensure_list at 0x7f0db0c89ab0>, json_schema_input_type=PydanticUndefined)]

enable_packet_buffer_protection: Optional[bool]

model_fields: ClassVar[Dict[str, pydantic.fields.FieldInfo]] = {'name': FieldInfo(annotation=str, required=False, default='', alias_priority=2, validation_alias='@name', metadata=[BeforeValidator(func=<function ensure_str>, json_schema_input_type=PydanticUndefined)]), 'layer3': FieldInfo(annotation=List[Annotated[str, BeforeValidator]], required=False, default_factory=list, alias_priority=2, validation_alias=AliasPath(path=['layer3', 'member']), metadata=[BeforeValidator(func=<function ensure_list>, json_schema_input_type=PydanticUndefined)]), 'enable_packet_buffer_protection': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, alias_priority=2, validation_alias=AliasPath(path=['enable-packet-buffer-protection', '#text']))}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

model_computed_fields: ClassVar[Dict[str, pydantic.fields.ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_post_init; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs
pa_api.xmlapi.types.utils.XMLBaseModel: from_xml

class Zone(pa_api.xmlapi.types.utils.XMLBaseModel): View Source

23class Zone(XMLBaseModel):
24    model_config = ConfigDict(extra="allow")
25
26    name: String = Field(validation_alias="@name", default="")
27    network: Optional[ZoneNetwork] = None
28    enable_user_identification: Optional[bool] = Field(
29        validation_alias=AliasPath("enable-user-identification", "#text"), default=None
30    )
31    enable_device_identification: Optional[bool] = Field(
32        validation_alias=AliasPath("enable-device-identification", "#text"),
33        default=None,
34    )

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

A base class for creating Pydantic models.

__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_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.

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: typing.Annotated[str, BeforeValidator(func=<function ensure_str at 0x7f0db0c89bd0>, json_schema_input_type=PydanticUndefined)]

network: Optional[ZoneNetwork]

enable_user_identification: Optional[bool]

enable_device_identification: Optional[bool]

model_fields: ClassVar[Dict[str, pydantic.fields.FieldInfo]] = {'name': FieldInfo(annotation=str, required=False, default='', alias_priority=2, validation_alias='@name', metadata=[BeforeValidator(func=<function ensure_str>, json_schema_input_type=PydanticUndefined)]), 'network': FieldInfo(annotation=Union[ZoneNetwork, NoneType], required=False, default=None), 'enable_user_identification': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, alias_priority=2, validation_alias=AliasPath(path=['enable-user-identification', '#text'])), 'enable_device_identification': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, alias_priority=2, validation_alias=AliasPath(path=['enable-device-identification', '#text']))}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

model_computed_fields: ClassVar[Dict[str, pydantic.fields.ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_post_init; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs
pa_api.xmlapi.types.utils.XMLBaseModel: from_xml