Class StreamWriter.Builder (2.26.0)

public static final class StreamWriter.Builder

A builder of StreamWriters.

Inheritance

java.lang.Object > StreamWriter.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public StreamWriter build()

Builds the StreamWriterV2.

Returns

Type	Description
StreamWriter

Exceptions

Type	Description
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

Name	Description
channelProvider	`TransportChannelProvider`

Returns

Type	Description
StreamWriter.Builder

setCredentialsProvider(CredentialsProvider credentialsProvider)

public StreamWriter.Builder setCredentialsProvider(CredentialsProvider credentialsProvider)

CredentialsProvider to use to create Credentials to authenticate calls.

Parameter

Name	Description
credentialsProvider	`CredentialsProvider`

Returns

Type	Description
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. This feature is still under development, please contact write api team before using.

Parameter

Name	Description
enableConnectionPool	`boolean`

Returns

Type	Description
StreamWriter.Builder	Builder

setEndpoint(String endpoint)

public StreamWriter.Builder setEndpoint(String endpoint)

Gives the ability to override the gRPC endpoint.

Parameter

Name	Description
endpoint	`String`

Returns

Type	Description
StreamWriter.Builder

setExecutorProvider(ExecutorProvider executorProvider)

public StreamWriter.Builder setExecutorProvider(ExecutorProvider executorProvider)

ExecutorProvider to use to create Executor to run background jobs.

Parameter

Name	Description
executorProvider	`ExecutorProvider`

Returns

Type	Description
StreamWriter.Builder

setLimitExceededBehavior(FlowController.LimitExceededBehavior limitExceededBehavior)

public StreamWriter.Builder setLimitExceededBehavior(FlowController.LimitExceededBehavior limitExceededBehavior)

Sets the limit exceeded behavior.

Parameter

Name	Description
limitExceededBehavior	`LimitExceededBehavior`

Returns

Type	Description
StreamWriter.Builder

Exceptions

Type	Description
io.grpc.StatusRuntimeException

setLocation(String location)

public StreamWriter.Builder setLocation(String location)

Location of the table this stream writer is targeting.

Parameter

Name	Description
location	`String`

Returns

Type	Description
StreamWriter.Builder

setMaxInflightBytes(long value)

public StreamWriter.Builder setMaxInflightBytes(long value)

Parameter

Name	Description
value	`long`

Returns

Type	Description
StreamWriter.Builder

setMaxInflightRequests(long value)

public StreamWriter.Builder setMaxInflightRequests(long value)

Parameter

Name	Description
value	`long`

Returns

Type	Description
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

Name	Description
traceId	`String`

Returns

Type	Description
StreamWriter.Builder

setWriterSchema(ProtoSchema writerSchema)

public StreamWriter.Builder setWriterSchema(ProtoSchema writerSchema)

Sets the proto schema of the rows.

Parameter

Name	Description
writerSchema	`ProtoSchema`

Returns

Type	Description
StreamWriter.Builder