Class ReadSession.TableReadOptions (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

Static Fields

ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER

public static final int ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

AVRO_SERIALIZATION_OPTIONS_FIELD_NUMBER

public static final int AVRO_SERIALIZATION_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_RESTRICTION_FIELD_NUMBER

public static final int ROW_RESTRICTION_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_PERCENTAGE_FIELD_NUMBER

public static final int SAMPLE_PERCENTAGE_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_FIELDS_FIELD_NUMBER

public static final int SELECTED_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadSession.TableReadOptions getDefaultInstance()
Returns
TypeDescription
ReadSession.TableReadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadSession.TableReadOptions.Builder newBuilder()
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

newBuilder(ReadSession.TableReadOptions prototype)

public static ReadSession.TableReadOptions.Builder newBuilder(ReadSession.TableReadOptions prototype)
Parameter
NameDescription
prototypeReadSession.TableReadOptions
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

parseDelimitedFrom(InputStream input)

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadSession.TableReadOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadSession.TableReadOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadSession.TableReadOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadSession.TableReadOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadSession.TableReadOptions> parser()
Returns
TypeDescription
Parser<TableReadOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
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
TypeDescription
ArrowSerializationOptionsOrBuilder

getAvroSerializationOptions()

public AvroSerializationOptions getAvroSerializationOptions()

Optional. Options specific to the Apache Avro output format

.google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AvroSerializationOptions

The avroSerializationOptions.

getAvroSerializationOptionsOrBuilder()

public AvroSerializationOptionsOrBuilder getAvroSerializationOptionsOrBuilder()

Optional. Options specific to the Apache Avro output format

.google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AvroSerializationOptionsOrBuilder

getDefaultInstanceForType()

public ReadSession.TableReadOptions getDefaultInstanceForType()
Returns
TypeDescription
ReadSession.TableReadOptions

getOutputFormatSerializationOptionsCase()

public ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase getOutputFormatSerializationOptionsCase()
Returns
TypeDescription
ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase

getParserForType()

public Parser<ReadSession.TableReadOptions> getParserForType()
Returns
TypeDescription
Parser<TableReadOptions>
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
TypeDescription
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
TypeDescription
ByteString

The bytes for rowRestriction.

getSamplePercentage()

public double getSamplePercentage()

Optional. Specifies a table sampling percentage. Specifically, the query planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The sampling percentage is applied at the data block granularity. It will randomly choose for each data block whether to read the rows in that data block. For more details, see https://cloud.google.com/bigquery/docs/table-sampling)

optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
double

The samplePercentage.

getSelectedFields(int index)

public String getSelectedFields(int index)

Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.

Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.

As an example, consider a table with the following schema:

{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }

Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 string_field2 }

Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 }

The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.

repeated string selected_fields = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The selectedFields at the given index.

getSelectedFieldsBytes(int index)

public ByteString getSelectedFieldsBytes(int index)

Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.

Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.

As an example, consider a table with the following schema:

{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }

Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 string_field2 }

Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 }

The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.

repeated string selected_fields = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the selectedFields at the given index.

getSelectedFieldsCount()

public int getSelectedFieldsCount()

Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.

Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.

As an example, consider a table with the following schema:

{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }

Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 string_field2 }

Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 }

The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.

repeated string selected_fields = 1;

Returns
TypeDescription
int

The count of selectedFields.

getSelectedFieldsList()

public ProtocolStringList getSelectedFieldsList()

Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.

Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.

As an example, consider a table with the following schema:

{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }

Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 string_field2 }

Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 }

The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.

repeated string selected_fields = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the selectedFields.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

Whether the arrowSerializationOptions field is set.

hasAvroSerializationOptions()

public boolean hasAvroSerializationOptions()

Optional. Options specific to the Apache Avro output format

.google.cloud.bigquery.storage.v1.AvroSerializationOptions avro_serialization_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the avroSerializationOptions field is set.

hasSamplePercentage()

public boolean hasSamplePercentage()

Optional. Specifies a table sampling percentage. Specifically, the query planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The sampling percentage is applied at the data block granularity. It will randomly choose for each data block whether to read the rows in that data block. For more details, see https://cloud.google.com/bigquery/docs/table-sampling)

optional double sample_percentage = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the samplePercentage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadSession.TableReadOptions.Builder newBuilderForType()
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadSession.TableReadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadSession.TableReadOptions.Builder toBuilder()
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException