Google BigQuery Storage v1 API - Class CreateReadSessionRequest (3.5.0)

public sealed class CreateReadSessionRequest : IMessage<CreateReadSessionRequest>, IEquatable<CreateReadSessionRequest>, IDeepCloneable<CreateReadSessionRequest>, IBufferMessage, IMessage

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

Request message for CreateReadSession.

Inheritance

Object > CreateReadSessionRequest

Implements

IMessage<CreateReadSessionRequest>, IEquatable<CreateReadSessionRequest>, IDeepCloneable<CreateReadSessionRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

CreateReadSessionRequest()

public CreateReadSessionRequest()

CreateReadSessionRequest(CreateReadSessionRequest)

public CreateReadSessionRequest(CreateReadSessionRequest other)

Parameter
Name	Description
`other`	`CreateReadSessionRequest`

Properties

MaxStreamCount

public int MaxStreamCount { get; set; }

Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000.

This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

Property Value
Type	Description
`Int32`

Parent

public string Parent { get; set; }

Required. The request project that owns the session, in the form of projects/{project_id}.

Property Value
Type	Description
`String`

ParentAsProjectName

public ProjectName ParentAsProjectName { get; set; }

ProjectName-typed view over the Parent resource name property.

Property Value
Type	Description
`ProjectName`

PreferredMinStreamCount

public int PreferredMinStreamCount { get; set; }

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).

The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

Property Value
Type	Description
`Int32`

ReadSession

public ReadSession ReadSession { get; set; }

Required. Session to be created.

Property Value
Type	Description
`ReadSession`