Class BigQueryRead.BigQueryReadClient (2.4.0)

Version 2.4.0

• 3.17.0 (latest)
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

public class BigQueryReadClient : ClientBase<BigQueryRead.BigQueryReadClient>

Client for BigQueryRead

Inheritance

Object > ClientBase > ClientBase<BigQueryRead.BigQueryReadClient> > BigQueryRead.BigQueryReadClient

Inherited Members

ClientBase<BigQueryRead.BigQueryReadClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

BigQueryReadClient()

protected BigQueryReadClient()

Protected parameterless constructor to allow creation of test doubles.

BigQueryReadClient(CallInvoker)

public BigQueryReadClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

BigQueryReadClient(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public BigQueryReadClient(Channel channel)

Creates a new client using a channel.

Parameter
Name	Description
channel	Grpc.Core.Channel The channel to use to make remote calls.

BigQueryReadClient(ChannelBase)

public BigQueryReadClient(ChannelBase channel)

Creates a new client for BigQueryRead

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

BigQueryReadClient(ClientBase.ClientBaseConfiguration)

protected BigQueryReadClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateReadSession(CreateReadSessionRequest, CallOptions)

public virtual ReadSession CreateReadSession(CreateReadSessionRequest request, CallOptions options)

Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned.

A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read.

Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.

Read sessions automatically expire 24 hours after they are created and do not require manual clean-up by the caller.

Parameters
Name	Description
request	CreateReadSessionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ReadSession	The response received from the server.

CreateReadSession(CreateReadSessionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ReadSession CreateReadSession(CreateReadSessionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned.

A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read.

Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.

Read sessions automatically expire 24 hours after they are created and do not require manual clean-up by the caller.

Parameters
Name	Description
request	CreateReadSessionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
ReadSession	The response received from the server.

CreateReadSessionAsync(CreateReadSessionRequest, CallOptions)

public virtual AsyncUnaryCall<ReadSession> CreateReadSessionAsync(CreateReadSessionRequest request, CallOptions options)

Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned.

A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read.

Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.

Read sessions automatically expire 24 hours after they are created and do not require manual clean-up by the caller.

Parameters
Name	Description
request	CreateReadSessionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ReadSession>	The call object.

CreateReadSessionAsync(CreateReadSessionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ReadSession> CreateReadSessionAsync(CreateReadSessionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned.

A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read.

Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.

Read sessions automatically expire 24 hours after they are created and do not require manual clean-up by the caller.

Parameters
Name	Description
request	CreateReadSessionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<ReadSession>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override BigQueryRead.BigQueryReadClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
BigQueryRead.BigQueryReadClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.BigQuery.Storage.V1.BigQueryRead.BigQueryReadClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReadRows(ReadRowsRequest, CallOptions)

public virtual AsyncServerStreamingCall<ReadRowsResponse> ReadRows(ReadRowsRequest request, CallOptions options)

Reads rows from the stream in the format prescribed by the ReadSession. Each response contains one or more table rows, up to a maximum of 100 MiB per response; read requests which attempt to read individual rows larger than 100 MiB will fail.

Each request also returns a set of stream statistics reflecting the current state of the stream.

Parameters
Name	Description
request	ReadRowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCall<ReadRowsResponse>	The call object.

ReadRows(ReadRowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncServerStreamingCall<ReadRowsResponse> ReadRows(ReadRowsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Reads rows from the stream in the format prescribed by the ReadSession. Each response contains one or more table rows, up to a maximum of 100 MiB per response; read requests which attempt to read individual rows larger than 100 MiB will fail.

Each request also returns a set of stream statistics reflecting the current state of the stream.

Parameters
Name	Description
request	ReadRowsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncServerStreamingCall<ReadRowsResponse>	The call object.

SplitReadStream(SplitReadStreamRequest, CallOptions)

public virtual SplitReadStreamResponse SplitReadStream(SplitReadStreamRequest request, CallOptions options)

Splits a given ReadStream into two ReadStream objects. These ReadStream objects are referred to as the primary and the residual streams of the split. The original ReadStream can still be read from in the same manner as before. Both of the returned ReadStream objects can also be read from, and the rows returned by both child streams will be the same as the rows read from the original stream.

Moreover, the two child streams will be allocated back-to-back in the original ReadStream. Concretely, it is guaranteed that for streams original, primary, and residual, that original[0-j] = primary[0-j] and original[j-n] = residual[0-m] once the streams have been read to completion.

Parameters
Name	Description
request	SplitReadStreamRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SplitReadStreamResponse	The response received from the server.

SplitReadStream(SplitReadStreamRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SplitReadStreamResponse SplitReadStream(SplitReadStreamRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Splits a given ReadStream into two ReadStream objects. These ReadStream objects are referred to as the primary and the residual streams of the split. The original ReadStream can still be read from in the same manner as before. Both of the returned ReadStream objects can also be read from, and the rows returned by both child streams will be the same as the rows read from the original stream.

Moreover, the two child streams will be allocated back-to-back in the original ReadStream. Concretely, it is guaranteed that for streams original, primary, and residual, that original[0-j] = primary[0-j] and original[j-n] = residual[0-m] once the streams have been read to completion.

Parameters
Name	Description
request	SplitReadStreamRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
SplitReadStreamResponse	The response received from the server.

SplitReadStreamAsync(SplitReadStreamRequest, CallOptions)

public virtual AsyncUnaryCall<SplitReadStreamResponse> SplitReadStreamAsync(SplitReadStreamRequest request, CallOptions options)

Splits a given ReadStream into two ReadStream objects. These ReadStream objects are referred to as the primary and the residual streams of the split. The original ReadStream can still be read from in the same manner as before. Both of the returned ReadStream objects can also be read from, and the rows returned by both child streams will be the same as the rows read from the original stream.

Moreover, the two child streams will be allocated back-to-back in the original ReadStream. Concretely, it is guaranteed that for streams original, primary, and residual, that original[0-j] = primary[0-j] and original[j-n] = residual[0-m] once the streams have been read to completion.

Parameters
Name	Description
request	SplitReadStreamRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<SplitReadStreamResponse>	The call object.

SplitReadStreamAsync(SplitReadStreamRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SplitReadStreamResponse> SplitReadStreamAsync(SplitReadStreamRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Splits a given ReadStream into two ReadStream objects. These ReadStream objects are referred to as the primary and the residual streams of the split. The original ReadStream can still be read from in the same manner as before. Both of the returned ReadStream objects can also be read from, and the rows returned by both child streams will be the same as the rows read from the original stream.

Moreover, the two child streams will be allocated back-to-back in the original ReadStream. Concretely, it is guaranteed that for streams original, primary, and residual, that original[0-j] = primary[0-j] and original[j-n] = residual[0-m] once the streams have been read to completion.

Parameters
Name	Description
request	SplitReadStreamRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<SplitReadStreamResponse>	The call object.