Package com.google.cloud.bigquery

Class ArrowSerializationOptions

java.lang.Object

com.google.cloud.bigquery.ArrowSerializationOptions

All Implemented Interfaces:

Serializable

@BetaApi
@NullMarked
public final class ArrowSerializationOptions
extends Object
implements Serializable

[Beta] Options specific to the Apache Arrow output format.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ArrowSerializationOptions.Builder	[Beta] Builder for ArrowSerializationOptions.
static enum	ArrowSerializationOptions.CompressionCodec	[Beta] Buffer compression codec for Apache Arrow record batches.
static enum	ArrowSerializationOptions.TimestampPrecision	[Beta] Timestamp precision for Apache Arrow timestamp types.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
ArrowSerializationOptions.CompressionCodec	getBufferCompression()	[Beta] Returns the buffer compression algorithm (e.g., LZ4_FRAME, ZSTD, UNCOMPRESSED).
ArrowSerializationOptions.TimestampPrecision	getPicosTimestampPrecision()	[Beta] Returns the timestamp precision for Arrow timestamp types.
int	hashCode()
static ArrowSerializationOptions.Builder	newBuilder()	[Beta] Returns a new builder for ArrowSerializationOptions.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getBufferCompression

@BetaApi
public ArrowSerializationOptions.CompressionCodec getBufferCompression()

[Beta] Returns the buffer compression algorithm (e.g., LZ4_FRAME, ZSTD, UNCOMPRESSED). Defaults to ArrowSerializationOptions.CompressionCodec.UNCOMPRESSED.

getPicosTimestampPrecision

@BetaApi
public ArrowSerializationOptions.TimestampPrecision getPicosTimestampPrecision()

[Beta] Returns the timestamp precision for Arrow timestamp types. Defaults to TimestampPrecision#PRECISION_MICROS.

Note: Only applies when QueryResultsFormat.ARROW is enabled. For Arrow result streams, this precision setting governs binary Arrow timestamp column types and takes precedence over DataFormatOptions.TimestampFormatOptions, which applies to default QueryResultsFormat.STRUCT_ENCODING JSON results.

newBuilder

@BetaApi
public static ArrowSerializationOptions.Builder newBuilder()

[Beta] Returns a new builder for ArrowSerializationOptions.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object