Send feedback
Class ReadSession.TableReadOptions (2.47.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.47.0 keyboard_arrow_down
public static final class ReadSession . TableReadOptions extends GeneratedMessageV3 implements ReadSession . TableReadOptionsOrBuilder
Options dictating how we read a table.
Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ReadSession . TableReadOptions . Builder newBuilder ()
newBuilder(ReadSession.TableReadOptions prototype)
public static ReadSession . TableReadOptions . Builder newBuilder ( ReadSession . TableReadOptions prototype )
public static ReadSession . TableReadOptions parseDelimitedFrom ( InputStream input )
public static ReadSession . TableReadOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ReadSession . TableReadOptions parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadSession . TableReadOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ReadSession . TableReadOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadSession . TableReadOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ReadSession . TableReadOptions parseFrom ( CodedInputStream input )
public static ReadSession . TableReadOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ReadSession . TableReadOptions parseFrom ( InputStream input )
public static ReadSession . TableReadOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ReadSession . TableReadOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadSession . TableReadOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ReadSession . TableReadOptions > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getArrowSerializationOptions()
public ArrowSerializationOptions getArrowSerializationOptions ()
Optional. Options specific to the Apache Arrow output format.
.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
getArrowSerializationOptionsOrBuilder()
public ArrowSerializationOptionsOrBuilder getArrowSerializationOptionsOrBuilder ()
Optional. Options specific to the Apache Arrow output format.
.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public ReadSession . TableReadOptions getDefaultInstanceForType ()
getParserForType()
public Parser<ReadSession . TableReadOptions > getParserForType ()
Overrides
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 indexint 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 indexint 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;
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
hasArrowSerializationOptions()
public boolean hasArrowSerializationOptions ()
Optional. Options specific to the Apache Arrow output format.
.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description boolean Whether the arrowSerializationOptions field is set.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ReadSession . TableReadOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadSession . TableReadOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public ReadSession . TableReadOptions . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
