Class AvroSerializationOptions (2.45.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static AvroSerializationOptions getDefaultInstance()
Returns
TypeDescription
AvroSerializationOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AvroSerializationOptions.Builder newBuilder()
Returns
TypeDescription
AvroSerializationOptions.Builder

newBuilder(AvroSerializationOptions prototype)

public static AvroSerializationOptions.Builder newBuilder(AvroSerializationOptions prototype)
Parameter
NameDescription
prototypeAvroSerializationOptions
Returns
TypeDescription
AvroSerializationOptions.Builder

parseDelimitedFrom(InputStream input)

public static AvroSerializationOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AvroSerializationOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AvroSerializationOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AvroSerializationOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AvroSerializationOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AvroSerializationOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AvroSerializationOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AvroSerializationOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AvroSerializationOptions> parser()
Returns
TypeDescription
Parser<AvroSerializationOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AvroSerializationOptions getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The enableDisplayNameAttribute.

getParserForType()

public Parser<AvroSerializationOptions> getParserForType()
Returns
TypeDescription
Parser<AvroSerializationOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AvroSerializationOptions.Builder newBuilderForType()
Returns
TypeDescription
AvroSerializationOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AvroSerializationOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AvroSerializationOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AvroSerializationOptions.Builder toBuilder()
Returns
TypeDescription
AvroSerializationOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException