Class ReadOptions.TableReadOptions (3.9.1)

public static final class ReadOptions.TableReadOptions extends GeneratedMessageV3 implements ReadOptions.TableReadOptionsOrBuilder

Options dictating how we read a table.

Protobuf type google.cloud.bigquery.storage.v1beta1.TableReadOptions

Static Fields

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 ReadOptions.TableReadOptions getDefaultInstance()
Returns
Type Description
ReadOptions.TableReadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ReadOptions.TableReadOptions.Builder newBuilder()
Returns
Type Description
ReadOptions.TableReadOptions.Builder

newBuilder(ReadOptions.TableReadOptions prototype)

public static ReadOptions.TableReadOptions.Builder newBuilder(ReadOptions.TableReadOptions prototype)
Parameter
Name Description
prototype ReadOptions.TableReadOptions
Returns
Type Description
ReadOptions.TableReadOptions.Builder

parseDelimitedFrom(InputStream input)

public static ReadOptions.TableReadOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReadOptions.TableReadOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadOptions.TableReadOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadOptions.TableReadOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReadOptions.TableReadOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReadOptions.TableReadOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadOptions.TableReadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadOptions.TableReadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReadOptions.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

getDefaultInstanceForType()

public ReadOptions.TableReadOptions getDefaultInstanceForType()
Returns
Type Description
ReadOptions.TableReadOptions

getParserForType()

public Parser<ReadOptions.TableReadOptions> getParserForType()
Returns
Type Description
Parser<TableReadOptions>
Overrides

getRowRestriction()

public String getRowRestriction()

Optional. SQL text filtering statement, similar to a WHERE clause in a SQL 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()

Optional. SQL text filtering statement, similar to a WHERE clause in a SQL 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)

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

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

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
Type Description
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
Type Description
ProtocolStringList

A list containing the selectedFields.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReadOptions.TableReadOptions.Builder newBuilderForType()
Returns
Type Description
ReadOptions.TableReadOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadOptions.TableReadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReadOptions.TableReadOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReadOptions.TableReadOptions.Builder toBuilder()
Returns
Type Description
ReadOptions.TableReadOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException