Class Storage.CreateReadSessionRequest.Builder (2.47.0)

public static final class Storage.CreateReadSessionRequest.Builder extends GeneratedMessageV3.Builder<Storage.CreateReadSessionRequest.Builder> implements Storage.CreateReadSessionRequestOrBuilder

Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.

Protobuf type google.cloud.bigquery.storage.v1beta1.CreateReadSessionRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Storage.CreateReadSessionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

build()

public Storage.CreateReadSessionRequest build()
Returns
TypeDescription
Storage.CreateReadSessionRequest

buildPartial()

public Storage.CreateReadSessionRequest buildPartial()
Returns
TypeDescription
Storage.CreateReadSessionRequest

clear()

public Storage.CreateReadSessionRequest.Builder clear()
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Storage.CreateReadSessionRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

clearFormat()

public Storage.CreateReadSessionRequest.Builder clearFormat()

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

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

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Storage.CreateReadSessionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

clearParent()

public Storage.CreateReadSessionRequest.Builder clearParent()

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
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

clearReadOptions()

public Storage.CreateReadSessionRequest.Builder clearReadOptions()

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

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

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

clearRequestedStreams()

public Storage.CreateReadSessionRequest.Builder clearRequestedStreams()

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
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

clearShardingStrategy()

public Storage.CreateReadSessionRequest.Builder clearShardingStrategy()

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
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

clearTableModifiers()

public Storage.CreateReadSessionRequest.Builder clearTableModifiers()

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

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

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

clearTableReference()

public Storage.CreateReadSessionRequest.Builder clearTableReference()

Required. Reference to the table to read.

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

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

clone()

public Storage.CreateReadSessionRequest.Builder clone()
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

getDefaultInstanceForType()

public Storage.CreateReadSessionRequest getDefaultInstanceForType()
Returns
TypeDescription
Storage.CreateReadSessionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFormat()

public Storage.DataFormat getFormat()

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

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

Returns
TypeDescription
Storage.DataFormat

The format.

getFormatValue()

public int getFormatValue()

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

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

Returns
TypeDescription
int

The enum numeric value on the wire for format.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

getReadOptions()

public ReadOptions.TableReadOptions getReadOptions()

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

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

Returns
TypeDescription
ReadOptions.TableReadOptions

The readOptions.

getReadOptionsBuilder()

public ReadOptions.TableReadOptions.Builder getReadOptionsBuilder()

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

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

Returns
TypeDescription
ReadOptions.TableReadOptions.Builder

getReadOptionsOrBuilder()

public ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()

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

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

Returns
TypeDescription
ReadOptions.TableReadOptionsOrBuilder

getRequestedStreams()

public 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
TypeDescription
int

The requestedStreams.

getShardingStrategy()

public 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
TypeDescription
Storage.ShardingStrategy

The shardingStrategy.

getShardingStrategyValue()

public 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
TypeDescription
int

The enum numeric value on the wire for shardingStrategy.

getTableModifiers()

public TableReferenceProto.TableModifiers getTableModifiers()

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

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

Returns
TypeDescription
TableReferenceProto.TableModifiers

The tableModifiers.

getTableModifiersBuilder()

public TableReferenceProto.TableModifiers.Builder getTableModifiersBuilder()

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

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

Returns
TypeDescription
TableReferenceProto.TableModifiers.Builder

getTableModifiersOrBuilder()

public TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()

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

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

Returns
TypeDescription
TableReferenceProto.TableModifiersOrBuilder

getTableReference()

public 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
TypeDescription
TableReferenceProto.TableReference

The tableReference.

getTableReferenceBuilder()

public TableReferenceProto.TableReference.Builder getTableReferenceBuilder()

Required. Reference to the table to read.

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

Returns
TypeDescription
TableReferenceProto.TableReference.Builder

getTableReferenceOrBuilder()

public 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
TypeDescription
TableReferenceProto.TableReferenceOrBuilder

hasReadOptions()

public boolean hasReadOptions()

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

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

Returns
TypeDescription
boolean

Whether the readOptions field is set.

hasTableModifiers()

public boolean hasTableModifiers()

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

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

Returns
TypeDescription
boolean

Whether the tableModifiers field is set.

hasTableReference()

public boolean hasTableReference()

Required. Reference to the table to read.

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

Returns
TypeDescription
boolean

Whether the tableReference field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Storage.CreateReadSessionRequest other)

public Storage.CreateReadSessionRequest.Builder mergeFrom(Storage.CreateReadSessionRequest other)
Parameter
NameDescription
otherStorage.CreateReadSessionRequest
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Storage.CreateReadSessionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Storage.CreateReadSessionRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

mergeReadOptions(ReadOptions.TableReadOptions value)

public Storage.CreateReadSessionRequest.Builder mergeReadOptions(ReadOptions.TableReadOptions value)

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

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

Parameter
NameDescription
valueReadOptions.TableReadOptions
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

mergeTableModifiers(TableReferenceProto.TableModifiers value)

public Storage.CreateReadSessionRequest.Builder mergeTableModifiers(TableReferenceProto.TableModifiers value)

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

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

Parameter
NameDescription
valueTableReferenceProto.TableModifiers
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

mergeTableReference(TableReferenceProto.TableReference value)

public Storage.CreateReadSessionRequest.Builder mergeTableReference(TableReferenceProto.TableReference value)

Required. Reference to the table to read.

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

Parameter
NameDescription
valueTableReferenceProto.TableReference
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Storage.CreateReadSessionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Storage.CreateReadSessionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

setFormat(Storage.DataFormat value)

public Storage.CreateReadSessionRequest.Builder setFormat(Storage.DataFormat value)

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

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

Parameter
NameDescription
valueStorage.DataFormat

The format to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setFormatValue(int value)

public Storage.CreateReadSessionRequest.Builder setFormatValue(int value)

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for format to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setParent(String value)

public Storage.CreateReadSessionRequest.Builder setParent(String value)

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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public Storage.CreateReadSessionRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setReadOptions(ReadOptions.TableReadOptions value)

public Storage.CreateReadSessionRequest.Builder setReadOptions(ReadOptions.TableReadOptions value)

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

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

Parameter
NameDescription
valueReadOptions.TableReadOptions
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setReadOptions(ReadOptions.TableReadOptions.Builder builderForValue)

public Storage.CreateReadSessionRequest.Builder setReadOptions(ReadOptions.TableReadOptions.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueReadOptions.TableReadOptions.Builder
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Storage.CreateReadSessionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides

setRequestedStreams(int value)

public Storage.CreateReadSessionRequest.Builder setRequestedStreams(int value)

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;

Parameter
NameDescription
valueint

The requestedStreams to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setShardingStrategy(Storage.ShardingStrategy value)

public Storage.CreateReadSessionRequest.Builder setShardingStrategy(Storage.ShardingStrategy value)

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

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

Parameter
NameDescription
valueStorage.ShardingStrategy

The shardingStrategy to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setShardingStrategyValue(int value)

public Storage.CreateReadSessionRequest.Builder setShardingStrategyValue(int value)

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

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for shardingStrategy to set.

Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

This builder for chaining.

setTableModifiers(TableReferenceProto.TableModifiers value)

public Storage.CreateReadSessionRequest.Builder setTableModifiers(TableReferenceProto.TableModifiers value)

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

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

Parameter
NameDescription
valueTableReferenceProto.TableModifiers
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setTableModifiers(TableReferenceProto.TableModifiers.Builder builderForValue)

public Storage.CreateReadSessionRequest.Builder setTableModifiers(TableReferenceProto.TableModifiers.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueTableReferenceProto.TableModifiers.Builder
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setTableReference(TableReferenceProto.TableReference value)

public Storage.CreateReadSessionRequest.Builder setTableReference(TableReferenceProto.TableReference value)

Required. Reference to the table to read.

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

Parameter
NameDescription
valueTableReferenceProto.TableReference
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setTableReference(TableReferenceProto.TableReference.Builder builderForValue)

public Storage.CreateReadSessionRequest.Builder setTableReference(TableReferenceProto.TableReference.Builder builderForValue)

Required. Reference to the table to read.

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

Parameter
NameDescription
builderForValueTableReferenceProto.TableReference.Builder
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Storage.CreateReadSessionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Storage.CreateReadSessionRequest.Builder
Overrides