Class StreamWriter.Builder (2.44.1)

public static final class StreamWriter.Builder

A builder of StreamWriters.

Inheritance

java.lang.Object > StreamWriter.Builder

Methods

build()

public StreamWriter build()

Builds the StreamWriterV2.

Returns
TypeDescription
StreamWriter
Exceptions
TypeDescription
IOException

setChannelProvider(TransportChannelProvider channelProvider)

public StreamWriter.Builder setChannelProvider(TransportChannelProvider channelProvider)

ChannelProvider to use to create Channels, which must point at Cloud BigQuery Storage API endpoint.

For performance, this client benefits from having multiple underlying connections. See com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder#setPoolSize(int).

Parameter
NameDescription
channelProviderTransportChannelProvider
Returns
TypeDescription
StreamWriter.Builder

setCompressorName(String compressorName)

public StreamWriter.Builder setCompressorName(String compressorName)
Parameter
NameDescription
compressorNameString
Returns
TypeDescription
StreamWriter.Builder

setCredentialsProvider(CredentialsProvider credentialsProvider)

public StreamWriter.Builder setCredentialsProvider(CredentialsProvider credentialsProvider)

CredentialsProvider to use to create Credentials to authenticate calls.

Parameter
NameDescription
credentialsProviderCredentialsProvider
Returns
TypeDescription
StreamWriter.Builder

setDefaultMissingValueInterpretation(AppendRowsRequest.MissingValueInterpretation defaultMissingValueInterpretation)

public StreamWriter.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
NameDescription
defaultMissingValueInterpretationAppendRowsRequest.MissingValueInterpretation
Returns
TypeDescription
StreamWriter.Builder

setEnableConnectionPool(boolean enableConnectionPool)

public StreamWriter.Builder setEnableConnectionPool(boolean enableConnectionPool)

Enable multiplexing for this writer. In multiplexing mode tables will share the same connection if possible until the connection is overwhelmed.

Parameter
NameDescription
enableConnectionPoolboolean
Returns
TypeDescription
StreamWriter.Builder

Builder

setEndpoint(String endpoint)

public StreamWriter.Builder setEndpoint(String endpoint)

Gives the ability to override the gRPC endpoint.

Parameter
NameDescription
endpointString
Returns
TypeDescription
StreamWriter.Builder

setExecutorProvider(ExecutorProvider executorProvider)

public StreamWriter.Builder setExecutorProvider(ExecutorProvider executorProvider)

ExecutorProvider to use to create Executor to run background jobs.

Parameter
NameDescription
executorProviderExecutorProvider
Returns
TypeDescription
StreamWriter.Builder

setLimitExceededBehavior(FlowController.LimitExceededBehavior limitExceededBehavior)

public StreamWriter.Builder setLimitExceededBehavior(FlowController.LimitExceededBehavior limitExceededBehavior)

Sets the limit exceeded behavior.

Parameter
NameDescription
limitExceededBehaviorLimitExceededBehavior
Returns
TypeDescription
StreamWriter.Builder
Exceptions
TypeDescription
io.grpc.StatusRuntimeException

setLocation(String location)

public StreamWriter.Builder setLocation(String location)

Location of the table this stream writer is targeting.

Parameter
NameDescription
locationString
Returns
TypeDescription
StreamWriter.Builder

setMaxInflightBytes(long value)

public StreamWriter.Builder setMaxInflightBytes(long value)
Parameter
NameDescription
valuelong
Returns
TypeDescription
StreamWriter.Builder

setMaxInflightRequests(long value)

public StreamWriter.Builder setMaxInflightRequests(long value)
Parameter
NameDescription
valuelong
Returns
TypeDescription
StreamWriter.Builder

setMaxRetryDuration(Duration maxRetryDuration)

public StreamWriter.Builder setMaxRetryDuration(Duration maxRetryDuration)
Parameter
NameDescription
maxRetryDurationDuration
Returns
TypeDescription
StreamWriter.Builder

setRetrySettings(RetrySettings retrySettings)

public StreamWriter.Builder setRetrySettings(RetrySettings retrySettings)
Parameter
NameDescription
retrySettingsRetrySettings
Returns
TypeDescription
StreamWriter.Builder

setTraceId(String traceId)

public StreamWriter.Builder setTraceId(String traceId)

Sets traceId for debuging purpose. TraceId must follow the format of CustomerDomain:DebugString, e.g. DATAFLOW:job_id_x.

Parameter
NameDescription
traceIdString
Returns
TypeDescription
StreamWriter.Builder

setWriterSchema(ProtoSchema writerSchema)

public StreamWriter.Builder setWriterSchema(ProtoSchema writerSchema)

Sets the proto schema of the rows.

Parameter
NameDescription
writerSchemaProtoSchema
Returns
TypeDescription
StreamWriter.Builder