Class ArrowSchema (3.0.1)

public final class ArrowSchema extends GeneratedMessageV3 implements ArrowSchemaOrBuilder

Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc

See code samples on how this message can be deserialized.

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

Static Fields

SERIALIZED_SCHEMA_FIELD_NUMBER

public static final int SERIALIZED_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ArrowSchema getDefaultInstance()
Returns
TypeDescription
ArrowSchema

getDescriptor()

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

newBuilder()

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

newBuilder(ArrowSchema prototype)

public static ArrowSchema.Builder newBuilder(ArrowSchema prototype)
Parameter
NameDescription
prototypeArrowSchema
Returns
TypeDescription
ArrowSchema.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ArrowSchema getDefaultInstanceForType()
Returns
TypeDescription
ArrowSchema

getParserForType()

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

getSerializedSchema()

public ByteString getSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
TypeDescription
ByteString

The serializedSchema.

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 ArrowSchema.Builder newBuilderForType()
Returns
TypeDescription
ArrowSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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