Class ArrowSchema.Builder (3.11.0)

public static final class ArrowSchema.Builder extends GeneratedMessageV3.Builder<ArrowSchema.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ArrowSchema build()
Returns
Type Description
ArrowSchema

buildPartial()

public ArrowSchema buildPartial()
Returns
Type Description
ArrowSchema

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSerializedSchema()

public ArrowSchema.Builder clearSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
Type Description
ArrowSchema.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ArrowSchema getDefaultInstanceForType()
Returns
Type Description
ArrowSchema

getDescriptorForType()

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

getSerializedSchema()

public ByteString getSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
Type Description
ByteString

The serializedSchema.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ArrowSchema other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSerializedSchema(ByteString value)

public ArrowSchema.Builder setSerializedSchema(ByteString value)

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Parameter
Name Description
value ByteString

The serializedSchema to set.

Returns
Type Description
ArrowSchema.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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