ComponentGuardRailConfiguration

class openapi_client.models.component_guard_rail_configuration.ComponentGuardRailConfiguration(**data)

Bases: BaseModel

Guard rail configuration for a specific component.

component_name: StrictStr

display_name: StrictStr

allowed_guard_rails: List[AllowedGuardRailWithName]

description: StrictStr

last_modified_time: Optional[StrictStr]

last_modified_by: Optional[StrictStr]

creation_time: Optional[StrictStr]

created_by: Optional[StrictStr]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

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

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of ComponentGuardRailConfiguration from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ComponentGuardRailConfiguration from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'allowed_guard_rails': FieldInfo(annotation=List[AllowedGuardRailWithName], required=True, alias='AllowedGuardRails', alias_priority=2, description='List of guard rails allowed for the component.'), 'component_name': FieldInfo(annotation=str, required=True, alias='ComponentName', alias_priority=2, description='The technical component identifier.', metadata=[Strict(strict=True)]), 'created_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CreatedBy', alias_priority=2, description='User who created the configuration.'), 'creation_time': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='CreationTime', alias_priority=2, description='Creation timestamp.'), 'description': FieldInfo(annotation=str, required=True, alias='Description', alias_priority=2, description="Description of the component's guard rail usage.", metadata=[Strict(strict=True)]), 'display_name': FieldInfo(annotation=str, required=True, alias='DisplayName', alias_priority=2, description='The human-readable component name.', metadata=[Strict(strict=True)]), 'last_modified_by': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModifiedBy', alias_priority=2, description='User who last modified the configuration.'), 'last_modified_time': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='LastModifiedTime', alias_priority=2, description='Last modification timestamp.')}

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

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• __context (Any) – The context.

Return type:

None