Class SchemaAwareStreamWriter.Builder<T> (3.11.0)

public static final class SchemaAwareStreamWriter.Builder<T>

Inheritance

java.lang.Object > SchemaAwareStreamWriter.Builder<T>

Type Parameter

Name Description
T

Methods

build()

public SchemaAwareStreamWriter<T> build()

Builds SchemaAwareStreamWriter

Returns
Type Description
SchemaAwareStreamWriter<T>

SchemaAwareStreamWriter

Exceptions
Type Description
DescriptorValidationException
IllegalArgumentException
IOException
InterruptedException

getStreamName()

public String getStreamName()

Stream name on the builder.

Returns
Type Description
String

Builder

setChannelProvider(TransportChannelProvider channelProvider)

public SchemaAwareStreamWriter.Builder<T> setChannelProvider(TransportChannelProvider channelProvider)

Setter for the underlying StreamWriter's TransportChannelProvider.

Parameter
Name Description
channelProvider TransportChannelProvider
Returns
Type Description
Builder<T>

Builder

setCompressorName(String compressorName)

public SchemaAwareStreamWriter.Builder<T> setCompressorName(String compressorName)

Sets the compression to use for the calls. The compressor must be of type gzip.

Parameter
Name Description
compressorName String
Returns
Type Description
Builder<T>

Builder

setCredentialsProvider(CredentialsProvider credentialsProvider)

public SchemaAwareStreamWriter.Builder<T> setCredentialsProvider(CredentialsProvider credentialsProvider)

Setter for the underlying StreamWriter's CredentialsProvider.

Parameter
Name Description
credentialsProvider CredentialsProvider
Returns
Type Description
Builder<T>

Builder

setDefaultMissingValueInterpretation(AppendRowsRequest.MissingValueInterpretation defaultMissingValueInterpretation)

public SchemaAwareStreamWriter.Builder setDefaultMissingValueInterpretation(AppendRowsRequest.MissingValueInterpretation defaultMissingValueInterpretation)

Sets the default missing value interpretation value if the column is not presented in the missing_value_interpretations map.

Parameter
Name Description
defaultMissingValueInterpretation AppendRowsRequest.MissingValueInterpretation
Returns
Type Description
SchemaAwareStreamWriter.Builder<T>

setEnableConnectionPool(boolean enableConnectionPool)

public SchemaAwareStreamWriter.Builder<T> setEnableConnectionPool(boolean enableConnectionPool)

Enable multiplexing for this writer. In multiplexing mode tables will share the same connection if possible until the connection is overwhelmed. This feature is still under development, please contact write api team before using.

Parameter
Name Description
enableConnectionPool boolean
Returns
Type Description
Builder<T>

Builder

setEnableLatencyProfiler(boolean enableLatencyProfiler)

public SchemaAwareStreamWriter.Builder setEnableLatencyProfiler(boolean enableLatencyProfiler)

Enable a latency profiler that would periodically generate a detailed latency report for the top latency requests. This is currently an experimental API.

Parameter
Name Description
enableLatencyProfiler boolean
Returns
Type Description
SchemaAwareStreamWriter.Builder<T>

setEnableOpenTelemetry(boolean enableOpenTelemetry)

public SchemaAwareStreamWriter.Builder setEnableOpenTelemetry(boolean enableOpenTelemetry)

Enable generation of metrics for OpenTelemetry.

Parameter
Name Description
enableOpenTelemetry boolean
Returns
Type Description
SchemaAwareStreamWriter.Builder<T>

setEndpoint(String endpoint)

public SchemaAwareStreamWriter.Builder<T> setEndpoint(String endpoint)

Setter for the underlying StreamWriter's Endpoint.

Parameter
Name Description
endpoint String
Returns
Type Description
Builder<T>

Builder

setExecutorProvider(ExecutorProvider executorProvider)

public SchemaAwareStreamWriter.Builder<T> setExecutorProvider(ExecutorProvider executorProvider)

Setter for the underlying StreamWriter's ExecutorProvider.

Parameter
Name Description
executorProvider ExecutorProvider
Returns
Type Description
Builder<T>

setFlowControlSettings(FlowControlSettings flowControlSettings)

public SchemaAwareStreamWriter.Builder<T> setFlowControlSettings(FlowControlSettings flowControlSettings)

Setter for the underlying StreamWriter's FlowControlSettings.

Parameter
Name Description
flowControlSettings FlowControlSettings
Returns
Type Description
Builder<T>

Builder

setIgnoreUnknownFields(boolean ignoreUnknownFields)

public SchemaAwareStreamWriter.Builder<T> setIgnoreUnknownFields(boolean ignoreUnknownFields)

Setter for a ignoreUnknownFields, if true, unknown fields to BigQuery will be ignored instead of error out. 1

Parameter
Name Description
ignoreUnknownFields boolean
Returns
Type Description
Builder<T>

Builder

setLocation(String location)

public SchemaAwareStreamWriter.Builder<T> setLocation(String location)

Location of the table this stream writer is targeting. Connection pools are shared by location.

Parameter
Name Description
location String
Returns
Type Description
Builder<T>

Builder

setMissingValueInterpretationMap(Map<String,AppendRowsRequest.MissingValueInterpretation> missingValueInterpretationMap)

public SchemaAwareStreamWriter.Builder setMissingValueInterpretationMap(Map<String,AppendRowsRequest.MissingValueInterpretation> missingValueInterpretationMap)

Sets the missing value interpretation map for the SchemaAwareStreamWriter. The input missingValueInterpretationMap is used for all append requests unless otherwise changed.

Parameter
Name Description
missingValueInterpretationMap Map<String,MissingValueInterpretation>

the missing value interpretation map used by the SchemaAwareStreamWriter.

Returns
Type Description
SchemaAwareStreamWriter.Builder<T>

Builder

setRetrySettings(RetrySettings retrySettings)

public SchemaAwareStreamWriter.Builder setRetrySettings(RetrySettings retrySettings)

Sets the RetrySettings to use for in-stream error retry.

Parameter
Name Description
retrySettings RetrySettings
Returns
Type Description
SchemaAwareStreamWriter.Builder<T>

Builder

setTraceId(String traceId)

public SchemaAwareStreamWriter.Builder<T> setTraceId(String traceId)

Setter for a traceId to help identify traffic origin.

Parameter
Name Description
traceId String
Returns
Type Description
Builder<T>

Builder