public static final class Storage.CreateReadSessionRequest extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_OPTIONS_FIELD_NUMBER
public static final int READ_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUESTED_STREAMS_FIELD_NUMBER
public static final int REQUESTED_STREAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHARDING_STRATEGY_FIELD_NUMBER
public static final int SHARDING_STRATEGY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TABLE_MODIFIERS_FIELD_NUMBER
public static final int TABLE_MODIFIERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TABLE_REFERENCE_FIELD_NUMBER
public static final int TABLE_REFERENCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Storage.CreateReadSessionRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Storage.CreateReadSessionRequest.Builder newBuilder()
newBuilder(Storage.CreateReadSessionRequest prototype)
public static Storage.CreateReadSessionRequest.Builder newBuilder(Storage.CreateReadSessionRequest prototype)
public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input)
public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Storage.CreateReadSessionRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Storage.CreateReadSessionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Storage.CreateReadSessionRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Storage.CreateReadSessionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Storage.CreateReadSessionRequest parseFrom(CodedInputStream input)
public static Storage.CreateReadSessionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Storage.CreateReadSessionRequest parseFrom(InputStream input)
public static Storage.CreateReadSessionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Storage.CreateReadSessionRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Storage.CreateReadSessionRequest getDefaultInstanceForType()
public Storage.DataFormat getFormat()
Data output format. Currently default to Avro.
DATA_FORMAT_UNSPECIFIED not supported.
.google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;
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.
|
getParserForType()
public Parser<Storage.CreateReadSessionRequest> getParserForType()
Overrides
getReadOptions()
public ReadOptions.TableReadOptions getReadOptions()
Read options for this session (e.g. column selection, filters).
.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;
getReadOptionsOrBuilder()
public ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()
Read options for this session (e.g. column selection, filters).
.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
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;
getTableModifiersOrBuilder()
public TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()
Any modifiers to the Table (e.g. snapshot timestamp).
.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;
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];
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Storage.CreateReadSessionRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Storage.CreateReadSessionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Storage.CreateReadSessionRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
