Interface Storage.CreateReadSessionRequestOrBuilder (2.16.1)

Version 2.16.1

• 3.10.3 (latest)
• 3.10.2
• 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 static interface Storage.CreateReadSessionRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFormat()

public abstract Storage.DataFormat getFormat()

Data output format. Currently default to Avro.

.google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;

Returns

Type	Description
Storage.DataFormat	The format.

getFormatValue()

public abstract int getFormatValue()

Data output format. Currently default to Avro.

.google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;

Returns

Type	Description
int	The enum numeric value on the wire for format.

getParent()

public abstract String getParent()

Required. String of the form projects/{project_id} indicating the project this ReadSession is associated with. This is the project that will be billed for usage.

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

Returns

Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. String of the form projects/{project_id} indicating the project this ReadSession is associated with. This is the project that will be billed for usage.

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

Returns

Type	Description
ByteString	The bytes for parent.

getReadOptions()

public abstract ReadOptions.TableReadOptions getReadOptions()

Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Returns

Type	Description
ReadOptions.TableReadOptions	The readOptions.

getReadOptionsOrBuilder()

public abstract ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()

Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Returns

Type	Description
ReadOptions.TableReadOptionsOrBuilder

getRequestedStreams()

public abstract int getRequestedStreams()

Initial number of streams. If unset or 0, we 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 and the maximum amount of parallelism allowed by the system. Streams must be read starting from offset 0.

int32 requested_streams = 3;

Returns

Type	Description
int	The requestedStreams.

getShardingStrategy()

public abstract Storage.ShardingStrategy getShardingStrategy()

The strategy to use for distributing data among multiple streams. Currently defaults to liquid sharding.

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;

Returns

Type	Description
Storage.ShardingStrategy	The shardingStrategy.

getShardingStrategyValue()

public abstract int getShardingStrategyValue()

The strategy to use for distributing data among multiple streams. Currently defaults to liquid sharding.

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;

Returns

Type	Description
int	The enum numeric value on the wire for shardingStrategy.

getTableModifiers()

public abstract TableReferenceProto.TableModifiers getTableModifiers()

Any modifiers to the Table (e.g. snapshot timestamp).

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Returns

Type	Description
TableReferenceProto.TableModifiers	The tableModifiers.

getTableModifiersOrBuilder()

public abstract TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()

Any modifiers to the Table (e.g. snapshot timestamp).

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Returns

Type	Description
TableReferenceProto.TableModifiersOrBuilder

getTableReference()

public abstract TableReferenceProto.TableReference getTableReference()

Required. Reference to the table to read.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TableReferenceProto.TableReference	The tableReference.

getTableReferenceOrBuilder()

public abstract TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()

Required. Reference to the table to read.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TableReferenceProto.TableReferenceOrBuilder

hasReadOptions()

public abstract boolean hasReadOptions()

Read options for this session (e.g. column selection, filters).

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Returns

Type	Description
boolean	Whether the readOptions field is set.

hasTableModifiers()

public abstract boolean hasTableModifiers()

Any modifiers to the Table (e.g. snapshot timestamp).

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Returns

Type	Description
boolean	Whether the tableModifiers field is set.

hasTableReference()

public abstract boolean hasTableReference()

Required. Reference to the table to read.

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the tableReference field is set.