Micronaut Serialization Configuration Reference

Every documented configuration property of Micronaut Serialization, with types, descriptions, and defaults.

Micronaut Serialization documentation

78 properties across 7 sections

Micronaut Serde Api Config Properties

Configuration properties for DefaultSerdeConfiguration

PropertyTypeDescriptionDefault
micronaut.serde.date-formatjava.util.Optional
micronaut.serde.time-write-shapeSerdeConfiguration$TimeShapeSTRING
micronaut.serde.numeric-time-unitSerdeConfiguration$NumericTimeUnitSECONDS
micronaut.serde.write-binary-as-arraybooleantrue
micronaut.serde.write-durations-as-stringsbooleanfalse
micronaut.serde.write-java-util-dates-with-zone-idbooleanfalse
micronaut.serde.reject-deprecated-three-letter-time-zone-idsbooleanfalse
micronaut.serde.write-date-times-as-strict-ijsonbooleanfalse
micronaut.serde.localejava.util.Optional
micronaut.serde.time-zonejava.util.Optional
micronaut.serde.included-introspection-packagesjava.util.Listio.micronaut
micronaut.serde.maximum-nesting-depthint1024
micronaut.serde.inet-address-as-numericbooleanfalse
micronaut.serde.property-naming-strategyjava.lang.String
micronaut.serde.json-view-enabledbooleanfalse
micronaut.serde.jackson-json-view-enabledbooleanfalse

Configuration properties for DefaultDeserializationConfiguration

PropertyTypeDescriptionDefault
micronaut.serde.deserialization.ignore-unknownbooleantrue
micronaut.serde.deserialization.array-size-thresholdint100
micronaut.serde.deserialization.strict-nullablebooleanfalse
micronaut.serde.deserialization.fail-on-null-for-primitivesbooleantrue
micronaut.serde.deserialization.subtypes-require-default-implbooleantrue
micronaut.serde.deserialization.accept-case-insensitive-enumsbooleanfalse
micronaut.serde.deserialization.accept-single-value-as-arraybooleanfalse
micronaut.serde.deserialization.accept-case-insensitive-propertiesbooleanfalse
micronaut.serde.deserialization.read-unknown-enum-values-as-nullbooleanfalse
micronaut.serde.deserialization.read-unknown-enum-values-using-default-valuebooleanfalse
micronaut.serde.deserialization.read-date-timestamps-as-nanosecondsbooleantrue
micronaut.serde.deserialization.adjust-dates-to-context-time-zonebooleanfalse
micronaut.serde.deserialization.require-all-creator-parametersbooleanfalse
micronaut.serde.deserialization.disable-generated-deserializerbooleanfalse
micronaut.serde.deserialization.coercion-modeCoercionModeLENIENT
micronaut.serde.deserialization.accept-float-as-intjava.lang.Boolean
micronaut.serde.deserialization.accept-string-as-numberjava.lang.Boolean
micronaut.serde.deserialization.accept-boolean-as-numberjava.lang.Boolean
micronaut.serde.deserialization.accept-number-as-booleanjava.lang.Boolean
micronaut.serde.deserialization.accept-string-as-booleanjava.lang.Boolean
micronaut.serde.deserialization.accept-scalar-as-stringjava.lang.Boolean
micronaut.serde.deserialization.unwrap-single-value-arraysjava.lang.Boolean

Configuration properties for DefaultSerializationConfiguration

PropertyTypeDescriptionDefault
micronaut.serde.serialization.inclusionSerdeConfig$SerIncludeNON_EMPTY
micronaut.serde.serialization.always-serialize-errors-as-listbooleantrue
micronaut.serde.serialization.sort-properties-alphabeticallybooleanfalse
micronaut.serde.serialization.write-date-timestamps-as-nanosecondsbooleantrue
micronaut.serde.serialization.write-dates-with-zone-idbooleantrue
micronaut.serde.serialization.write-single-elem-arrays-unwrappedbooleanfalse
micronaut.serde.serialization.write-sorted-map-entriesbooleanfalse
micronaut.serde.serialization.disable-generated-serializerbooleanfalse

Micronaut Serde Jackson Cbor Config Properties

Configuration properties for SerdeCborConfiguration

PropertyTypeDescription
micronaut.serde.cbor.cbor-read-featuresjava.util.MapSets CBOR read features.
micronaut.serde.cbor.cbor-write-featuresjava.util.MapSets CBOR write features.
micronaut.serde.cbor.stream-read-featuresjava.util.MapSets stream read features.
micronaut.serde.cbor.stream-write-featuresjava.util.MapSets stream write features.
micronaut.serde.cbor.write-binary-as-arraybooleanSets whether {@code byte[]} values are written as numeric arrays.

Micronaut Serde Jackson Config Properties

Configuration properties for SerdeJacksonConfiguration

PropertyTypeDescription
micronaut.serde.jackson.json-read-featuresjava.util.Map
micronaut.serde.jackson.json-write-featuresjava.util.Map
micronaut.serde.jackson.json-factory-featuresjava.util.Map
micronaut.serde.jackson.stream-write-featuresjava.util.Map
micronaut.serde.jackson.stream-read-featuresjava.util.Map
micronaut.serde.jackson.pretty-printboolean

Micronaut Serde Jsonb Config Properties

Configuration properties for JsonbConfiguration

PropertyTypeDescriptionDefault
micronaut.serde.jsonb.reflectionJsonbConfiguration$ReflectionReflection fallback mode for the context-created JSON-B bean.OFF

Micronaut Serde Properties Config Properties

Configuration properties for SerdePropertiesConfiguration

PropertyTypeDescription
micronaut.serde.format.properties.array-index-styleSerdePropertiesConfiguration$ArrayIndexStyleSets the array index style.

Micronaut Serde Stax Xml Config Properties

Configuration properties for XmlSerdeConfiguration

PropertyTypeDescription
micronaut.serde.format.xml.repairing-namespacesbooleanSets whether namespace repairing is enabled.
micronaut.serde.format.xml.automatic-empty-elementsbooleanSets whether the XML writer may use self-closing empty elements.
micronaut.serde.format.xml.maximum-input-sizelongSets the maximum XML input size.
micronaut.serde.format.xml.xml-read-featuresjava.util.MapSets the XML read feature map.

Micronaut Serde Yaml Config Properties

Configuration properties for SerdeYamlConfiguration$ReadFeatures

PropertyTypeDescription
micronaut.serde.format.yaml.read-features.boolean-as-stringsbooleanSets whether YAML boolean-like words should be parsed as strings.
micronaut.serde.format.yaml.read-features.empty-string-as-nullbooleanSets whether an empty plain YAML scalar should be parsed as {@code null}.
micronaut.serde.format.yaml.read-features.code-point-limitintSets the maximum number of code points a single YAML input may contain.

Configuration properties for SerdeYamlConfiguration$WriteFeatures

PropertyTypeDescription
micronaut.serde.format.yaml.write-features.write-styleSerdeYamlConfiguration$WriteStyleSets the write style.
micronaut.serde.format.yaml.write-features.indentintSets the indentation width.
micronaut.serde.format.yaml.write-features.explicit-startbooleanSets whether to emit an explicit document start marker.
micronaut.serde.format.yaml.write-features.explicit-endbooleanSets whether to emit an explicit document end marker.
micronaut.serde.format.yaml.write-features.minimize-quotesbooleanSets whether quotes should be omitted from strings when YAML permits it.
micronaut.serde.format.yaml.write-features.literal-block-stylebooleanSets whether multiline strings should be emitted using YAML literal block style.
micronaut.serde.format.yaml.write-features.split-linesbooleanSets whether long textual content should be split into multiple lines.
micronaut.serde.format.yaml.write-features.canonical-outputbooleanSets whether YAML should be emitted in canonical form.
micronaut.serde.format.yaml.write-features.indent-arraysbooleanSets whether sequence indicators should be indented.
micronaut.serde.format.yaml.write-features.indent-arrays-with-indicatorbooleanSets whether sequence indicators should be indented by two spaces.
micronaut.serde.format.yaml.write-features.allow-long-keysbooleanSets whether simple YAML keys may be up to 1024 characters long.
micronaut.serde.format.yaml.write-features.use-yaml-nonfinite-notationbooleanSets whether non-finite numbers should use YAML notation.