StreamWriter (BigQuery Storage 2.31.0 API)

java.lang.Object
- com.google.cloud.bigquery.storage.v1.StreamWriter

All Implemented Interfaces:

AutoCloseable
```
public class StreamWriter
extends Object
implements AutoCloseable
```
A BigQuery Stream Writer that can be used to write data into BigQuery Table.
TODO: Support batching.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StreamWriter.Builder` A builder of `StreamWriter`s.
`static class`	`StreamWriter.SingleConnectionOrConnectionPool` When in single table mode, append directly to connectionWorker.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.core.ApiFuture<AppendRowsResponse>`	`append(ProtoRows rows)` Schedules the writing of rows at the end of current stream.
`com.google.api.core.ApiFuture<AppendRowsResponse>`	`append(ProtoRows rows, long offset)` Schedules the writing of rows at given offset.
`void`	`close()` Close the stream writer.
`static long`	`getApiMaxRequestBytes()` The maximum size of one request.
`long`	`getInflightWaitSeconds()` Returns the wait of a request in Client side before sending to the Server.
`String`	`getLocation()`
`ProtoSchema`	`getProtoSchema()`
`String`	`getStreamName()`
`TableSchema`	`getUpdatedSchema()` Thread-safe getter of updated TableSchema.
`String`	`getWriterId()`
`boolean`	`isClosed()`
`boolean`	`isUserClosed()`
`static StreamWriter.Builder`	`newBuilder(String streamName)` Constructs a new `StreamWriterV2.Builder` using the given stream.
`static StreamWriter.Builder`	`newBuilder(String streamName, BigQueryWriteClient client)` Constructs a new `StreamWriterV2.Builder` using the given stream and client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getApiMaxRequestBytes
```
public static long getApiMaxRequestBytes()
```
    The maximum size of one request. Defined by the API.
  - append
```
public com.google.api.core.ApiFuture<AppendRowsResponse> append(ProtoRows rows)
```
    Schedules the writing of rows at the end of current stream.
    
    Parameters:
    
    rows - the rows in serialized format to write to BigQuery.
    
    Returns:
    
    the append response wrapped in a future.
  - append
```
public com.google.api.core.ApiFuture<AppendRowsResponse> append(ProtoRows rows,
                                                                long offset)
```
    Schedules the writing of rows at given offset.
    Example of writing rows with specific offset.
```
 ApiFuture<AppendRowsResponse> future = writer.append(rows, 0);
 ApiFutures.addCallback(future, new ApiFutureCallback<AppendRowsResponse>() {
   public void onSuccess(AppendRowsResponse response) {
     if (!response.hasError()) {
       System.out.println("written with offset: " + response.getAppendResult().getOffset());
     } else {
       System.out.println("received an in stream error: " + response.getError().toString());
     }
   }

   public void onFailure(Throwable t) {
     System.out.println("failed to write: " + t);
   }
 }, MoreExecutors.directExecutor());
 
```
    Parameters:
    
    rows - the rows in serialized format to write to BigQuery.
    
    offset - the offset of the first row. Provide -1 to write at the current end of stream.
    
    Returns:
    
    the append response wrapped in a future.
  - getInflightWaitSeconds
```
public long getInflightWaitSeconds()
```
    Returns the wait of a request in Client side before sending to the Server. Request could wait in Client because it reached the client side inflight request limit (adjustable when constructing the StreamWriter). The value is the wait time for the last sent request. A constant high wait value indicates a need for more throughput, you can create a new Stream for to increase the throughput in exclusive stream case, or create a new Writer in the default stream case.
  - getWriterId
```
public String getWriterId()
```
    Returns:
    
    a unique Id for the writer.
  - getStreamName
```
public String getStreamName()
```
    Returns:
    
    name of the Stream that this writer is working on.
  - getProtoSchema
```
public ProtoSchema getProtoSchema()
```
    Returns:
    
    the passed in user schema.
  - getLocation
```
public String getLocation()
```
    Returns:
    
    the location of the destination.
  - isClosed
```
public boolean isClosed()
```
    Returns:
    
    if a stream writer can no longer be used for writing. It is due to either the StreamWriter is explicitly closed or the underlying connection is broken when connection pool is not used. Client should recreate StreamWriter in this case.
  - isUserClosed
```
public boolean isUserClosed()
```
    Returns:
    
    if user explicitly closed the writer.
  - close
```
public void close()
```
    Close the stream writer. Shut down all resources.
    
    Specified by:
    
    close in interface AutoCloseable
  - newBuilder
```
public static StreamWriter.Builder newBuilder(String streamName,
                                              BigQueryWriteClient client)
```
    Constructs a new StreamWriterV2.Builder using the given stream and client.
  - newBuilder
```
public static StreamWriter.Builder newBuilder(String streamName)
```
    Constructs a new StreamWriterV2.Builder using the given stream.
  - getUpdatedSchema
```
public TableSchema getUpdatedSchema()
```
    Thread-safe getter of updated TableSchema.
    This will return the updated schema only when the creation timestamp of this writer is older than the updated schema.

Class StreamWriter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getApiMaxRequestBytes

append

append

getInflightWaitSeconds

getWriterId

getStreamName

getProtoSchema

getLocation

isClosed

isUserClosed

close

newBuilder

newBuilder

getUpdatedSchema