Class Storage.CreateReadSessionRequest (2.15.0)

Version 2.15.0

• 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 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Storage.CreateReadSessionRequest

Implements

Storage.CreateReadSessionRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FORMAT_FIELD_NUMBER

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()

Returns

Type	Description
Storage.CreateReadSessionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Storage.CreateReadSessionRequest.Builder newBuilder()

Returns

Type	Description
Storage.CreateReadSessionRequest.Builder

newBuilder(Storage.CreateReadSessionRequest prototype)

public static Storage.CreateReadSessionRequest.Builder newBuilder(Storage.CreateReadSessionRequest prototype)

Parameter

Name	Description
prototype	Storage.CreateReadSessionRequest

Returns

Type	Description
Storage.CreateReadSessionRequest.Builder

parseDelimitedFrom(InputStream input)

public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Storage.CreateReadSessionRequest parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Storage.CreateReadSessionRequest parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Storage.CreateReadSessionRequest parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Storage.CreateReadSessionRequest parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Storage.CreateReadSessionRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Storage.CreateReadSessionRequest> parser()

Returns

Type	Description
Parser<CreateReadSessionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Storage.CreateReadSessionRequest getDefaultInstanceForType()

Returns

Type	Description
Storage.CreateReadSessionRequest

getFormat()

public 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 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 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()

Returns

Type	Description
Parser<CreateReadSessionRequest>

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Storage.CreateReadSessionRequest.Builder newBuilderForType()

Returns

Type	Description
Storage.CreateReadSessionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Storage.CreateReadSessionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Storage.CreateReadSessionRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Storage.CreateReadSessionRequest.Builder toBuilder()

Returns

Type	Description
Storage.CreateReadSessionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException