public sealed class AvroSerializationOptions : IMessage<AvroSerializationOptions>, IEquatable<AvroSerializationOptions>, IDeepCloneable<AvroSerializationOptions>, IBufferMessage, IMessage
Reference documentation and code samples for the Google BigQuery Storage v1 API class AvroSerializationOptions.
public bool EnableDisplayNameAttribute { get; set; }
Enable displayName attribute in Avro schema.
The Avro specification requires field names to be alphanumeric. By
default, in cases when column names do not conform to these requirements
(e.g. non-ascii unicode codepoints) and Avro is requested as an output
format, the CreateReadSession call will fail.
Setting this field to true, populates avro field names with a placeholder
value and populates a "displayName" attribute for every avro field with the
original column name.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page provides documentation for the \u003ccode\u003eAvroSerializationOptions\u003c/code\u003e class within the Google BigQuery Storage v1 API, specifically for version 3.14.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAvroSerializationOptions\u003c/code\u003e class contains settings related to Avro serialization, and it implements multiple interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt offers two constructors: a default constructor and another that accepts an \u003ccode\u003eAvroSerializationOptions\u003c/code\u003e object for cloning.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes a property called \u003ccode\u003eEnableDisplayNameAttribute\u003c/code\u003e, which, when set to true, allows the use of non-alphanumeric column names in Avro output by using a placeholder name and storing the original column name in the "displayName" attribute.\u003c/p\u003e\n"],["\u003cp\u003eThe page provides links to documentation for numerous other versions of the API, ranging from 3.17.0 down to 2.3.0.\u003c/p\u003e\n"]]],[],null,[]]
