Class StreamWriter.Builder (3.5.1)

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`

setCompressorName(String compressorName)

public StreamWriter.Builder setCompressorName(String compressorName)

Parameter
Name	Description
`compressorName`	`String`

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`

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
Name	Description
`defaultMissingValueInterpretation`	`AppendRowsRequest.MissingValueInterpretation`

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.

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`

setMaxRetryDuration(Duration maxRetryDuration)

public StreamWriter.Builder setMaxRetryDuration(Duration maxRetryDuration)

Parameter
Name	Description
`maxRetryDuration`	`Duration`

Returns
Type	Description
`StreamWriter.Builder`

setRetrySettings(RetrySettings retrySettings)

public StreamWriter.Builder setRetrySettings(RetrySettings retrySettings)

Enable client lib automatic retries on request level errors.

Immeidate Retry code: ABORTED, UNAVAILABLE, CANCELLED, INTERNAL, DEADLINE_EXCEEDED Backoff Retry code: RESOURCE_EXHAUSTED

Example: RetrySettings retrySettings = RetrySettings.newBuilder() .setInitialRetryDelay(Duration.ofMillis(500)) // applies to backoff retry .setRetryDelayMultiplier(1.1) // applies to backoff retry .setMaxAttempts(5) // applies to both retries .setMaxRetryDelay(Duration.ofMinutes(1)) // applies to backoff retry .build();

Parameter
Name	Description
`retrySettings`	`RetrySettings`

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`