Interface CreateReadSessionRequestOrBuilder (3.6.0)

public interface CreateReadSessionRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMaxStreamCount()

public abstract int getMaxStreamCount()

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.

int32 max_stream_count = 3;

Returns
Type Description
int

The maxStreamCount.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getPreferredMinStreamCount()

public abstract int getPreferredMinStreamCount()

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.

int32 preferred_min_stream_count = 4;

Returns
Type Description
int

The preferredMinStreamCount.

getReadSession()

public abstract ReadSession getReadSession()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReadSession

The readSession.

getReadSessionOrBuilder()

public abstract ReadSessionOrBuilder getReadSessionOrBuilder()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReadSessionOrBuilder

hasReadSession()

public abstract boolean hasReadSession()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the readSession field is set.