Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions.
Contains options specific to Avro Serialization.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#enable_display_name_attribute
defenable_display_name_attribute()->::Boolean
Returns
(::Boolean) — 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.
value (::Boolean) — 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.
Returns
(::Boolean) — 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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-bigquery-storage-v1/latest/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [1.3.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.3.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [1.2.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.2.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.1.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [1.0.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.0.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.27.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.27.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.26.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.26.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.25.2](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.25.2/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.24.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.24.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.23.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.23.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.22.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.22.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.21.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.21.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.20.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.20.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.19.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.19.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.18.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.18.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.17.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.17.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.16.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.16.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.15.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.15.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.14.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.14.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.13.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.12.0/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.11.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.11.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.10.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.10.1/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions)\n- [0.9.2](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.9.2/Google-Cloud-Bigquery-Storage-V1-AvroSerializationOptions) \nReference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions.\n\nContains options specific to Avro Serialization. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #enable_display_name_attribute\n\n def enable_display_name_attribute() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Enable displayName attribute in Avro schema.\n\n The Avro specification requires field names to be alphanumeric. By\n default, in cases when column names do not conform to these requirements\n (e.g. non-ascii unicode codepoints) and Avro is requested as an output\n format, the CreateReadSession call will fail.\n\n Setting this field to true, populates avro field names with a placeholder\n value and populates a \"displayName\" attribute for every avro field with the\n original column name.\n\n### #enable_display_name_attribute=\n\n def enable_display_name_attribute=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Enable displayName attribute in Avro schema.\n\n\n The Avro specification requires field names to be alphanumeric. By\n default, in cases when column names do not conform to these requirements\n (e.g. non-ascii unicode codepoints) and Avro is requested as an output\n format, the CreateReadSession call will fail.\n\n Setting this field to true, populates avro field names with a placeholder\n value and populates a \"displayName\" attribute for every avro field with the\noriginal column name. \n**Returns**\n\n- (::Boolean) --- Enable displayName attribute in Avro schema.\n\n The Avro specification requires field names to be alphanumeric. By\n default, in cases when column names do not conform to these requirements\n (e.g. non-ascii unicode codepoints) and Avro is requested as an output\n format, the CreateReadSession call will fail.\n\n Setting this field to true, populates avro field names with a placeholder\n value and populates a \"displayName\" attribute for every avro field with the\n original column name."]]
