Class ArrowSchema.Builder (2.44.1)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ArrowSchema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ArrowSchema.Builder
Overrides

build()

public ArrowSchema build()
Returns
TypeDescription
ArrowSchema

buildPartial()

public ArrowSchema buildPartial()
Returns
TypeDescription
ArrowSchema

clear()

public ArrowSchema.Builder clear()
Returns
TypeDescription
ArrowSchema.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ArrowSchema.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ArrowSchema.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ArrowSchema.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ArrowSchema.Builder
Overrides

clearSerializedSchema()

public ArrowSchema.Builder clearSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
TypeDescription
ArrowSchema.Builder

This builder for chaining.

clone()

public ArrowSchema.Builder clone()
Returns
TypeDescription
ArrowSchema.Builder
Overrides

getDefaultInstanceForType()

public ArrowSchema getDefaultInstanceForType()
Returns
TypeDescription
ArrowSchema

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getSerializedSchema()

public ByteString getSerializedSchema()

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Returns
TypeDescription
ByteString

The serializedSchema.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ArrowSchema other)

public ArrowSchema.Builder mergeFrom(ArrowSchema other)
Parameter
NameDescription
otherArrowSchema
Returns
TypeDescription
ArrowSchema.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ArrowSchema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ArrowSchema.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ArrowSchema.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ArrowSchema.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ArrowSchema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ArrowSchema.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ArrowSchema.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ArrowSchema.Builder
Overrides

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

public ArrowSchema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ArrowSchema.Builder
Overrides

setSerializedSchema(ByteString value)

public ArrowSchema.Builder setSerializedSchema(ByteString value)

IPC serialized Arrow schema.

bytes serialized_schema = 1;

Parameter
NameDescription
valueByteString

The serializedSchema to set.

Returns
TypeDescription
ArrowSchema.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ArrowSchema.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ArrowSchema.Builder
Overrides