Google BigQuery Storage v1 API - Class BigQueryWrite.BigQueryWriteClient (3.15.0) 

public class BigQueryWrite.BigQueryWriteClient : ClientBase<BigQueryWrite.BigQueryWriteClient>

Reference documentation and code samples for the Google BigQuery Storage v1 API class BigQueryWrite.BigQueryWriteClient.

Client for BigQueryWrite

Inheritance

object > ClientBase > ClientBaseBigQueryWriteBigQueryWriteClient > BigQueryWrite.BigQueryWriteClient

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

BigQueryWriteClient()

protected BigQueryWriteClient()

Protected parameterless constructor to allow creation of test doubles.

BigQueryWriteClient(CallInvoker)

public BigQueryWriteClient(CallInvoker callInvoker)

Creates a new client for BigQueryWrite that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

BigQueryWriteClient(ChannelBase)

public BigQueryWriteClient(ChannelBase channel)

Creates a new client for BigQueryWrite

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

BigQueryWriteClient(ClientBaseConfiguration)

protected BigQueryWriteClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AppendRows(CallOptions)

public virtual AsyncDuplexStreamingCall<AppendRowsRequest, AppendRowsResponse> AppendRows(CallOptions options)

Appends data to the given stream.

If offset is specified, the offset is checked against the end of stream. The server returns OUT_OF_RANGE in AppendRowsResponse if an attempt is made to append to an offset beyond the current end of the stream or ALREADY_EXISTS if user provides an offset that has already been written to. User can retry with adjusted offset within the same RPC connection. If offset is not specified, append happens at the end of the stream.

The response contains an optional offset at which the append happened. No offset information will be returned for appends to a default stream.

Responses are received in the same order in which requests are sent. There will be one response for each successful inserted request. Responses may optionally embed error information if the originating AppendRequest was not successfully processed.

The specifics of when successfully appended data is made visible to the table are governed by the type of stream:

  • For COMMITTED streams (which includes the default stream), data is visible immediately upon successful append.

  • For BUFFERED streams, data is made visible via a subsequent FlushRows rpc which advances a cursor to a newer offset in the stream.

  • For PENDING streams, data is not made visible until the stream itself is finalized (via the FinalizeWriteStream rpc), and the stream is explicitly committed via the BatchCommitWriteStreams rpc.

Parameter
Name Description
options CallOptions

The options for the call.
Returns
Type Description
AsyncDuplexStreamingCallAppendRowsRequestAppendRowsResponse

The call object.

AppendRows(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<AppendRowsRequest, AppendRowsResponse> AppendRows(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Appends data to the given stream.

If offset is specified, the offset is checked against the end of stream. The server returns OUT_OF_RANGE in AppendRowsResponse if an attempt is made to append to an offset beyond the current end of the stream or ALREADY_EXISTS if user provides an offset that has already been written to. User can retry with adjusted offset within the same RPC connection. If offset is not specified, append happens at the end of the stream.

The response contains an optional offset at which the append happened. No offset information will be returned for appends to a default stream.

Responses are received in the same order in which requests are sent. There will be one response for each successful inserted request. Responses may optionally embed error information if the originating AppendRequest was not successfully processed.

The specifics of when successfully appended data is made visible to the table are governed by the type of stream:

  • For COMMITTED streams (which includes the default stream), data is visible immediately upon successful append.

  • For BUFFERED streams, data is made visible via a subsequent FlushRows rpc which advances a cursor to a newer offset in the stream.

  • For PENDING streams, data is not made visible until the stream itself is finalized (via the FinalizeWriteStream rpc), and the stream is explicitly committed via the BatchCommitWriteStreams rpc.

Parameters
Name Description
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncDuplexStreamingCallAppendRowsRequestAppendRowsResponse

The call object.

BatchCommitWriteStreams(BatchCommitWriteStreamsRequest, CallOptions)

public virtual BatchCommitWriteStreamsResponse BatchCommitWriteStreams(BatchCommitWriteStreamsRequest request, CallOptions options)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name Description
request BatchCommitWriteStreamsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BatchCommitWriteStreamsResponse

The response received from the server.

BatchCommitWriteStreams(BatchCommitWriteStreamsRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchCommitWriteStreamsResponse BatchCommitWriteStreams(BatchCommitWriteStreamsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name Description
request BatchCommitWriteStreamsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BatchCommitWriteStreamsResponse

The response received from the server.

BatchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest, CallOptions)

public virtual AsyncUnaryCall<BatchCommitWriteStreamsResponse> BatchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest request, CallOptions options)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name Description
request BatchCommitWriteStreamsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBatchCommitWriteStreamsResponse

The call object.

BatchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchCommitWriteStreamsResponse> BatchCommitWriteStreamsAsync(BatchCommitWriteStreamsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name Description
request BatchCommitWriteStreamsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBatchCommitWriteStreamsResponse

The call object.

CreateWriteStream(CreateWriteStreamRequest, CallOptions)

public virtual WriteStream CreateWriteStream(CreateWriteStreamRequest request, CallOptions options)

Creates a write stream to the given table. Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name Description
request CreateWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
WriteStream

The response received from the server.

CreateWriteStream(CreateWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual WriteStream CreateWriteStream(CreateWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a write stream to the given table. Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name Description
request CreateWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
WriteStream

The response received from the server.

CreateWriteStreamAsync(CreateWriteStreamRequest, CallOptions)

public virtual AsyncUnaryCall<WriteStream> CreateWriteStreamAsync(CreateWriteStreamRequest request, CallOptions options)

Creates a write stream to the given table. Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name Description
request CreateWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallWriteStream

The call object.

CreateWriteStreamAsync(CreateWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<WriteStream> CreateWriteStreamAsync(CreateWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a write stream to the given table. Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name Description
request CreateWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallWriteStream

The call object.

FinalizeWriteStream(FinalizeWriteStreamRequest, CallOptions)

public virtual FinalizeWriteStreamResponse FinalizeWriteStream(FinalizeWriteStreamRequest request, CallOptions options)

Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the '_default' stream.

Parameters
Name Description
request FinalizeWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FinalizeWriteStreamResponse

The response received from the server.

FinalizeWriteStream(FinalizeWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual FinalizeWriteStreamResponse FinalizeWriteStream(FinalizeWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the '_default' stream.

Parameters
Name Description
request FinalizeWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
FinalizeWriteStreamResponse

The response received from the server.

FinalizeWriteStreamAsync(FinalizeWriteStreamRequest, CallOptions)

public virtual AsyncUnaryCall<FinalizeWriteStreamResponse> FinalizeWriteStreamAsync(FinalizeWriteStreamRequest request, CallOptions options)

Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the '_default' stream.

Parameters
Name Description
request FinalizeWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFinalizeWriteStreamResponse

The call object.

FinalizeWriteStreamAsync(FinalizeWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FinalizeWriteStreamResponse> FinalizeWriteStreamAsync(FinalizeWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the '_default' stream.

Parameters
Name Description
request FinalizeWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallFinalizeWriteStreamResponse

The call object.

FlushRows(FlushRowsRequest, CallOptions)

public virtual FlushRowsResponse FlushRows(FlushRowsRequest request, CallOptions options)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name Description
request FlushRowsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FlushRowsResponse

The response received from the server.

FlushRows(FlushRowsRequest, Metadata, DateTime?, CancellationToken)

public virtual FlushRowsResponse FlushRows(FlushRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name Description
request FlushRowsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
FlushRowsResponse

The response received from the server.

FlushRowsAsync(FlushRowsRequest, CallOptions)

public virtual AsyncUnaryCall<FlushRowsResponse> FlushRowsAsync(FlushRowsRequest request, CallOptions options)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name Description
request FlushRowsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFlushRowsResponse

The call object.

FlushRowsAsync(FlushRowsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FlushRowsResponse> FlushRowsAsync(FlushRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name Description
request FlushRowsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallFlushRowsResponse

The call object.

GetWriteStream(GetWriteStreamRequest, CallOptions)

public virtual WriteStream GetWriteStream(GetWriteStreamRequest request, CallOptions options)

Gets information about a write stream.

Parameters
Name Description
request GetWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
WriteStream

The response received from the server.

GetWriteStream(GetWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual WriteStream GetWriteStream(GetWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a write stream.

Parameters
Name Description
request GetWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
WriteStream

The response received from the server.

GetWriteStreamAsync(GetWriteStreamRequest, CallOptions)

public virtual AsyncUnaryCall<WriteStream> GetWriteStreamAsync(GetWriteStreamRequest request, CallOptions options)

Gets information about a write stream.

Parameters
Name Description
request GetWriteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallWriteStream

The call object.

GetWriteStreamAsync(GetWriteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<WriteStream> GetWriteStreamAsync(GetWriteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a write stream.

Parameters
Name Description
request GetWriteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallWriteStream

The call object.

NewInstance(ClientBaseConfiguration)

protected override BigQueryWrite.BigQueryWriteClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
BigQueryWriteBigQueryWriteClient
Overrides