public static final class Storage.CreateReadSessionRequest.Builder extends GeneratedMessageV3.Builder<Storage.CreateReadSessionRequest.Builder> implements Storage.CreateReadSessionRequestOrBuilderCreates 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Storage.CreateReadSessionRequest.BuilderImplements
Storage.CreateReadSessionRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Storage.CreateReadSessionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
build()
public Storage.CreateReadSessionRequest build()| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest | |
buildPartial()
public Storage.CreateReadSessionRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest | |
clear()
public Storage.CreateReadSessionRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Storage.CreateReadSessionRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
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 | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Storage.CreateReadSessionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
clone()
public Storage.CreateReadSessionRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
getDefaultInstanceForType()
public Storage.CreateReadSessionRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean | Whether the tableReference field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Storage.CreateReadSessionRequest other)
public Storage.CreateReadSessionRequest.Builder mergeFrom(Storage.CreateReadSessionRequest other)| Parameter | |
|---|---|
| Name | Description |
other | Storage.CreateReadSessionRequest |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Storage.CreateReadSessionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Storage.CreateReadSessionRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
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 | |
|---|---|
| Name | Description |
value | ReadOptions.TableReadOptions |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TableReferenceProto.TableModifiers |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TableReferenceProto.TableReference |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Storage.CreateReadSessionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Storage.CreateReadSessionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
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 | |
|---|---|
| Name | Description |
value | Storage.DataFormatThe format to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for format to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ReadOptions.TableReadOptions |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | ReadOptions.TableReadOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Storage.CreateReadSessionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
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 | |
|---|---|
| Name | Description |
value | intThe requestedStreams to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Storage.ShardingStrategyThe shardingStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for shardingStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TableReferenceProto.TableModifiers |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | TableReferenceProto.TableModifiers.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TableReferenceProto.TableReference |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | TableReferenceProto.TableReference.Builder |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Storage.CreateReadSessionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Storage.CreateReadSessionRequest.Builder | |