# Class JsonStreamWriter (3.29.0)

3.27.0 (latest) 3.24.0 3.23.0 3.21.0 3.20.0 3.19.1 3.18.0 3.17.3 3.16.3 3.15.3 3.14.1 3.12.0 3.11.4 3.10.3 3.9.3 3.8.0 3.6.1 3.5.2 3.4.0 3.3.1 3.2.0 3.1.0 3.0.1 2.47.0 2.45.0 2.44.1 2.43.0

    public class JsonStreamWriter implements AutoCloseable

A StreamWriter that can write JSON data (JSONObjects) to BigQuery tables. The JsonStreamWriter is
built on top of a StreamWriter, and it simply converts all JSON data to protobuf messages then
calls StreamWriter's append() method to write to BigQuery tables.

This client lib is deprecated, please use v1 instead.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> JsonStreamWriter

## Implements

[AutoCloseable](https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html)

## Inherited Members

[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Static Methods

### newBuilder(String streamOrTableName, TableSchema tableSchema) (deprecated)

    public static JsonStreamWriter.Builder newBuilder(String streamOrTableName, TableSchema tableSchema)

newBuilder that constructs a JsonStreamWriter builder with BigQuery client being initialized by
StreamWriter by default.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `streamOrTableName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the stream that must follow "projects/\[\^/\]+/datasets/\[\^/\]+/tables/\[\^/\]+/streams/\[\^/\]+" or table name "projects/\[\^/\]+/datasets/\[\^/\]+/tables/\[\^/\]+" |
| `tableSchema` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.TableSchema` The schema of the table when the stream was created, which is passed back through `WriteStream` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.JsonStreamWriter.Builder` | Builder |

### newBuilder(String streamOrTableName, TableSchema tableSchema, BigQueryWriteClient client) (deprecated)

    public static JsonStreamWriter.Builder newBuilder(String streamOrTableName, TableSchema tableSchema, BigQueryWriteClient client)

newBuilder that constructs a JsonStreamWriter builder.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `streamOrTableName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the stream that must follow "projects/\[\^/\]+/datasets/\[\^/\]+/tables/\[\^/\]+/streams/\[\^/\]+" |
| `tableSchema` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.TableSchema` The schema of the table when the stream was created, which is passed back through `WriteStream` |
| `client` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.BigQueryWriteClient` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.JsonStreamWriter.Builder` | Builder |

## Methods

### append(JSONArray jsonArr) (deprecated)

    public ApiFuture<AppendRowsResponse> append(JSONArray jsonArr)

Writes a JSONArray that contains JSONObjects to the BigQuery table by first converting the JSON
data to protobuf messages, then using StreamWriter's append() to write the data.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `jsonArr` | `org.json.JSONArray` The JSON array that contains JSONObjects to be written |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse>` | `ApiFuture<AppendRowsResponse>` returns an AppendRowsResponse message wrapped in an ApiFuture |

### append(JSONArray jsonArr, long offset) (deprecated)

    public ApiFuture<AppendRowsResponse> append(JSONArray jsonArr, long offset)

Writes a JSONArray that contains JSONObjects to the BigQuery table by first converting the JSON
data to protobuf messages, then using StreamWriter's append() to write the data.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `jsonArr` | `org.json.JSONArray` The JSON array that contains JSONObjects to be written |
| `offset` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` Offset for deduplication |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/com.google.cloud.bigquery.storage.v1beta2.AppendRowsResponse>` | `ApiFuture<AppendRowsResponse>` returns an AppendRowsResponse message wrapped in an ApiFuture |

### close() (deprecated)

    public void close()

Closes the underlying StreamWriter.

### getDescriptor() (deprecated)

    public Descriptors.Descriptor getDescriptor()

Gets current descriptor

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor.html` | Descriptor |

### getStreamName() (deprecated)

    public String getStreamName()

Gets streamName

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | String |