Class ArrowSchema (3.6.0)

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
Type Description
int

Static Methods

getDefaultInstance()

public static ArrowSchema getDefaultInstance()
Returns
Type Description
ArrowSchema

getDescriptor()

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

newBuilder()

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

newBuilder(ArrowSchema prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ArrowSchema getDefaultInstanceForType()
Returns
Type Description
ArrowSchema

getParserForType()

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

getSerializedSchema()

public ByteString getSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
Type Description
ByteString

The serializedSchema.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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