Class AvroSerializationOptions (3.6.0)

public final class AvroSerializationOptions extends GeneratedMessageV3 implements AvroSerializationOptionsOrBuilder

Contains options specific to Avro Serialization.

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

Static Fields

ENABLE_DISPLAY_NAME_ATTRIBUTE_FIELD_NUMBER

public static final int ENABLE_DISPLAY_NAME_ATTRIBUTE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AvroSerializationOptions getDefaultInstance()
Returns
Type Description
AvroSerializationOptions

getDescriptor()

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

newBuilder()

public static AvroSerializationOptions.Builder newBuilder()
Returns
Type Description
AvroSerializationOptions.Builder

newBuilder(AvroSerializationOptions prototype)

public static AvroSerializationOptions.Builder newBuilder(AvroSerializationOptions prototype)
Parameter
Name Description
prototype AvroSerializationOptions
Returns
Type Description
AvroSerializationOptions.Builder

parseDelimitedFrom(InputStream input)

public static AvroSerializationOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AvroSerializationOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AvroSerializationOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AvroSerializationOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AvroSerializationOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AvroSerializationOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AvroSerializationOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AvroSerializationOptions> parser()
Returns
Type Description
Parser<AvroSerializationOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AvroSerializationOptions getDefaultInstanceForType()
Returns
Type Description
AvroSerializationOptions

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.

getParserForType()

public Parser<AvroSerializationOptions> getParserForType()
Returns
Type Description
Parser<AvroSerializationOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AvroSerializationOptions.Builder newBuilderForType()
Returns
Type Description
AvroSerializationOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AvroSerializationOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AvroSerializationOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AvroSerializationOptions.Builder toBuilder()
Returns
Type Description
AvroSerializationOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException