Class ReadSession.TableReadOptions (2.9.1)

Version 2.9.1

• 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 ReadSession.TableReadOptions extends GeneratedMessageV3 implements ReadSession.TableReadOptionsOrBuilder

Options dictating how we read a table.

Protobuf type google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReadSession.TableReadOptions

Implements

ReadSession.TableReadOptionsOrBuilder

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

ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER

public static final int ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER

Field Value

Type	Description
int

ROW_RESTRICTION_FIELD_NUMBER

public static final int ROW_RESTRICTION_FIELD_NUMBER

Field Value

Type	Description
int

SELECTED_FIELDS_FIELD_NUMBER

public static final int SELECTED_FIELDS_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static ReadSession.TableReadOptions getDefaultInstance()

Returns

Type	Description
ReadSession.TableReadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static ReadSession.TableReadOptions.Builder newBuilder()

Returns

Type	Description
ReadSession.TableReadOptions.Builder

newBuilder(ReadSession.TableReadOptions prototype)

public static ReadSession.TableReadOptions.Builder newBuilder(ReadSession.TableReadOptions prototype)

Parameter

Name	Description
prototype	ReadSession.TableReadOptions

Returns

Type	Description
ReadSession.TableReadOptions.Builder

parseDelimitedFrom(InputStream input)

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static ReadSession.TableReadOptions parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadSession.TableReadOptions parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadSession.TableReadOptions parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static ReadSession.TableReadOptions parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadSession.TableReadOptions

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ReadSession.TableReadOptions> parser()

Returns

Type	Description
Parser<TableReadOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getArrowSerializationOptions()

public ArrowSerializationOptions getArrowSerializationOptions()

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ArrowSerializationOptions	The arrowSerializationOptions.

getArrowSerializationOptionsOrBuilder()

public ArrowSerializationOptionsOrBuilder getArrowSerializationOptionsOrBuilder()

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ArrowSerializationOptionsOrBuilder

getDefaultInstanceForType()

public ReadSession.TableReadOptions getDefaultInstanceForType()

Returns

Type	Description
ReadSession.TableReadOptions

getOutputFormatSerializationOptionsCase()

public ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase getOutputFormatSerializationOptionsCase()

Returns

Type	Description
ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase

getParserForType()

public Parser<ReadSession.TableReadOptions> getParserForType()

Returns

Type	Description
Parser<TableReadOptions>

Overrides

GeneratedMessageV3.getParserForType()

getRowRestriction()

public String getRowRestriction()

SQL text filtering statement, similar to a WHERE clause in a query. Aggregates are not supported. Examples: "int_field > 5" "date_field = CAST('2014-9-27' as DATE)" "nullable_field is not NULL" "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))" "numeric_field BETWEEN 1.0 AND 5.0" Restricted to a maximum length for 1 MB.

string row_restriction = 2;

Returns

Type	Description
String	The rowRestriction.

getRowRestrictionBytes()

public ByteString getRowRestrictionBytes()

SQL text filtering statement, similar to a WHERE clause in a query. Aggregates are not supported. Examples: "int_field > 5" "date_field = CAST('2014-9-27' as DATE)" "nullable_field is not NULL" "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))" "numeric_field BETWEEN 1.0 AND 5.0" Restricted to a maximum length for 1 MB.

string row_restriction = 2;

Returns

Type	Description
ByteString	The bytes for rowRestriction.

getSelectedFields(int index)

public String getSelectedFields(int index)

Names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.

repeated string selected_fields = 1;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The selectedFields at the given index.

getSelectedFieldsBytes(int index)

public ByteString getSelectedFieldsBytes(int index)

Names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.

repeated string selected_fields = 1;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the selectedFields at the given index.

getSelectedFieldsCount()

public int getSelectedFieldsCount()

Names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.

repeated string selected_fields = 1;

Returns

Type	Description
int	The count of selectedFields.

getSelectedFieldsList()

public ProtocolStringList getSelectedFieldsList()

Names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.

repeated string selected_fields = 1;

Returns

Type	Description
ProtocolStringList	A list containing the selectedFields.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasArrowSerializationOptions()

public boolean hasArrowSerializationOptions()

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the arrowSerializationOptions 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 ReadSession.TableReadOptions.Builder newBuilderForType()

Returns

Type	Description
ReadSession.TableReadOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadSession.TableReadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
ReadSession.TableReadOptions.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 ReadSession.TableReadOptions.Builder toBuilder()

Returns

Type	Description
ReadSession.TableReadOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException