Class AvroSerializationOptions.Builder (3.9.0)

public static final class AvroSerializationOptions.Builder extends GeneratedMessageV3.Builder<AvroSerializationOptions.Builder> implements AvroSerializationOptionsOrBuilder

Contains options specific to Avro Serialization.

Protobuf type google.cloud.bigquery.storage.v1.AvroSerializationOptions

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AvroSerializationOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

build()

public AvroSerializationOptions build()
Returns
Type Description
AvroSerializationOptions

buildPartial()

public AvroSerializationOptions buildPartial()
Returns
Type Description
AvroSerializationOptions

clear()

public AvroSerializationOptions.Builder clear()
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

clearEnableDisplayNameAttribute()

public AvroSerializationOptions.Builder clearEnableDisplayNameAttribute()

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.

bool enable_display_name_attribute = 1;

Returns
Type Description
AvroSerializationOptions.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AvroSerializationOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AvroSerializationOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

clone()

public AvroSerializationOptions.Builder clone()
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

getDefaultInstanceForType()

public AvroSerializationOptions getDefaultInstanceForType()
Returns
Type Description
AvroSerializationOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableDisplayNameAttribute()

public boolean 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.

bool enable_display_name_attribute = 1;

Returns
Type Description
boolean

The enableDisplayNameAttribute.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AvroSerializationOptions other)

public AvroSerializationOptions.Builder mergeFrom(AvroSerializationOptions other)
Parameter
Name Description
other AvroSerializationOptions
Returns
Type Description
AvroSerializationOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AvroSerializationOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AvroSerializationOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AvroSerializationOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

setEnableDisplayNameAttribute(boolean value)

public AvroSerializationOptions.Builder setEnableDisplayNameAttribute(boolean value)

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.

bool enable_display_name_attribute = 1;

Parameter
Name Description
value boolean

The enableDisplayNameAttribute to set.

Returns
Type Description
AvroSerializationOptions.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AvroSerializationOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AvroSerializationOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AvroSerializationOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AvroSerializationOptions.Builder
Overrides