Google BigQuery Storage V1 Client - Class AvroSerializationOptions (2.3.0)

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.

↳ picos_timestamp_precision int

Optional. Set timestamp precision option. If not set, the default precision is microseconds.

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPicosTimestampPrecision

Optional. Set timestamp precision option. If not set, the default precision is microseconds.

Returns
Type Description
int Enum of type PicosTimestampPrecision.

setPicosTimestampPrecision

Optional. Set timestamp precision option. If not set, the default precision is microseconds.

Parameter
Name Description
var int

Enum of type PicosTimestampPrecision.

Returns
Type Description
$this