Reference documentation and code samples for the Google BigQuery Storage V1 Client class AvroSerializationOptions.
Contains options specific to Avro Serialization.
Generated from protobuf message google.cloud.bigquery.storage.v1.AvroSerializationOptions
Namespace
Google \ Cloud \ BigQuery \ Storage \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ enable_display_name_attribute
bool
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.
getEnableDisplayNameAttribute
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
Type
Description
bool
setEnableDisplayNameAttribute
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-04 UTC."],[],[],null,["# Google BigQuery Storage V1 Client - Class AvroSerializationOptions (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroSerializationOptions)\n- [2.1.4](/php/docs/reference/cloud-bigquery-storage/2.1.4/V1.AvroSerializationOptions)\n- [2.0.0](/php/docs/reference/cloud-bigquery-storage/2.0.0/V1.AvroSerializationOptions)\n- [1.10.4](/php/docs/reference/cloud-bigquery-storage/1.10.4/V1.AvroSerializationOptions)\n- [1.9.0](/php/docs/reference/cloud-bigquery-storage/1.9.0/V1.AvroSerializationOptions)\n- [1.8.0](/php/docs/reference/cloud-bigquery-storage/1.8.0/V1.AvroSerializationOptions)\n- [1.7.1](/php/docs/reference/cloud-bigquery-storage/1.7.1/V1.AvroSerializationOptions)\n- [1.6.0](/php/docs/reference/cloud-bigquery-storage/1.6.0/V1.AvroSerializationOptions)\n- [1.5.0](/php/docs/reference/cloud-bigquery-storage/1.5.0/V1.AvroSerializationOptions)\n- [1.4.1](/php/docs/reference/cloud-bigquery-storage/1.4.1/V1.AvroSerializationOptions)\n- [1.3.2](/php/docs/reference/cloud-bigquery-storage/1.3.2/V1.AvroSerializationOptions)\n- [1.2.12](/php/docs/reference/cloud-bigquery-storage/1.2.12/V1.AvroSerializationOptions) \nReference documentation and code samples for the Google BigQuery Storage V1 Client class AvroSerializationOptions.\n\nContains options specific to Avro Serialization.\n\nGenerated from protobuf message `google.cloud.bigquery.storage.v1.AvroSerializationOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Storage \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEnableDisplayNameAttribute\n\nEnable displayName attribute in Avro schema.\n\nThe Avro specification requires field names to be alphanumeric. By\ndefault, 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\nformat, the CreateReadSession call will fail.\nSetting this field to true, populates avro field names with a placeholder\nvalue and populates a \"displayName\" attribute for every avro field with the\noriginal column name.\n\n### setEnableDisplayNameAttribute\n\nEnable displayName attribute in Avro schema.\n\nThe Avro specification requires field names to be alphanumeric. By\ndefault, 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\nformat, the CreateReadSession call will fail.\nSetting this field to true, populates avro field names with a placeholder\nvalue and populates a \"displayName\" attribute for every avro field with the\noriginal column name."]]
