controller.utilities.configuration.CoreEnvModel.model_dump_json

CoreEnvModel.model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)

Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#modelmodel_dump_json

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

• indent (int | None, default: None) – Indentation to use in the JSON output. If None is passed, the output will be compact.

• include (Union[Set[int], Set[str], Dict[int, Any], Dict[str, Any], None], default: None) – Field(s) to include in the JSON output.

• exclude (Union[Set[int], Set[str], Dict[int, Any], Dict[str, Any], None], default: None) – Field(s) to exclude from the JSON output.

• context (dict[str, Any] | None, default: None) – Additional context to pass to the serializer.

• by_alias (bool, default: False) – Whether to serialize using field aliases.

• exclude_unset (bool, default: False) – Whether to exclude fields that have not been explicitly set.

• exclude_defaults (bool, default: False) – Whether to exclude fields that are set to their default value.

• exclude_none (bool, default: False) – Whether to exclude fields that have a value of None.

• round_trip (bool, default: False) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].

• warnings (Union[bool, Literal['none', 'warn', 'error']], default: True) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

• serialize_as_any (bool, default: False) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

str

Returns:

A JSON string representation of the model.