> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/avro/deserialize.md). # Deserialize Task version: 2.0.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | FilePath : `String` |

Gets or sets the path to the Avro file you want to deserialize.

The file must be a valid Avro format file.


Default: -
Example: C:\results\myfile.avro

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ThrowErrorOnFailure : `Boolean` |

Gets or sets a value indicating whether to throw an exception when deserialization fails.

When set to true, exceptions will be thrown on failure. When set to false, errors will be returned in the Result object.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Gets or sets a custom error message to use when deserialization fails and ThrowErrorOnFailure is false.

If empty, the original exception message will be used.


Default: -
Example: Custom error occurred during Avro deserialization

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Json : `Object` |

Gets or sets the deserialized JSON data as a dynamic object. Contains a JArray with the deserialized Avro records when successful, or error information when failed.
Example: \[{"foo": "bar", "number": 123}]

| | Success : `Boolean` |

Gets or sets a value indicating whether the deserialization operation was successful.
Example: true

| | Error : `Error` |

Gets or sets the error information when the deserialization operation fails. This property is null when the operation is successful.
Example: null

| ## Task Changelog Changelog for Task Frends.Avro.Deserialize. ### \[2.0.0] - 2025-07-25 #### Added * New Options tab with error handling parameters (ThrowErrorOnFailure, ErrorMessageOnFailure) * Success property in Result to indicate task status * Error object in Result with detailed failure info * Error class with Message and AdditionalInfo properties * Options class for task configuration * ErrorHandler helper class for standardized error handling * Improved error handling with centralized logic #### Changed * \[Breaking] Renamed AvroFilePath to FilePath for consistency with Frends naming conventions * \[Breaking] Moved FilePath from old parameter location to Input tab * Updated task structure to align with Frends development guidelines ### \[1.0.0] - 2024-05-31 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/avro/deserialize.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.