com.google.cloud.bigquery.storage.v1beta1

Interface Storage.CreateReadSessionRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Storage.CreateReadSessionRequest, Storage.CreateReadSessionRequest.Builder

Enclosing class:

Storage

public static interface Storage.CreateReadSessionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Storage.DataFormat	getFormat() Data output format.
int	getFormatValue() Data output format.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
ReadOptions.TableReadOptions	getReadOptions() Read options for this session (e.g.
ReadOptions.TableReadOptionsOrBuilder	getReadOptionsOrBuilder() Read options for this session (e.g.
int	getRequestedStreams() Initial number of streams.
Storage.ShardingStrategy	getShardingStrategy() The strategy to use for distributing data among multiple streams.
int	getShardingStrategyValue() The strategy to use for distributing data among multiple streams.
TableReferenceProto.TableModifiers	getTableModifiers() Any modifiers to the Table (e.g.
TableReferenceProto.TableModifiersOrBuilder	getTableModifiersOrBuilder() Any modifiers to the Table (e.g.
TableReferenceProto.TableReference	getTableReference() Required.
TableReferenceProto.TableReferenceOrBuilder	getTableReferenceOrBuilder() Required.
boolean	hasReadOptions() Read options for this session (e.g.
boolean	hasTableModifiers() Any modifiers to the Table (e.g.
boolean	hasTableReference() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasTableReference

boolean hasTableReference()

 Required. Reference to the table to read.
 

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

Returns:

Whether the tableReference field is set.

getTableReference

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:

The tableReference.

getTableReferenceOrBuilder

TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()

 Required. Reference to the table to read.
 

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

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

hasTableModifiers

boolean hasTableModifiers()

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

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

Returns:

Whether the tableModifiers field is set.

getTableModifiers

TableReferenceProto.TableModifiers getTableModifiers()

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

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

Returns:

The tableModifiers.

getTableModifiersOrBuilder

TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()

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

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

getRequestedStreams

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:

The requestedStreams.

hasReadOptions

boolean hasReadOptions()

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

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

Returns:

Whether the readOptions field is set.

getReadOptions

ReadOptions.TableReadOptions getReadOptions()

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

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

Returns:

The readOptions.

getReadOptionsOrBuilder

ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()

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

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

getFormatValue

int getFormatValue()

 Data output format. Currently default to Avro.
 

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

Returns:

The enum numeric value on the wire for format.

getFormat

Storage.DataFormat getFormat()

 Data output format. Currently default to Avro.
 

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

Returns:

The format.

getShardingStrategyValue

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:

The enum numeric value on the wire for shardingStrategy.

getShardingStrategy

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:

The shardingStrategy.