Interface ReadSession.TableReadOptionsOrBuilder (3.2.0)

public static interface ReadSession.TableReadOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArrowSerializationOptions()

public abstract 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];

Returns
TypeDescription
ArrowSerializationOptions

The arrowSerializationOptions.

getArrowSerializationOptionsOrBuilder()

public abstract 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];

Returns
TypeDescription
ArrowSerializationOptionsOrBuilder

getRowRestriction()

public abstract 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 abstract 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.

getSelectedFields(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The selectedFields at the given index.

getSelectedFieldsBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the selectedFields at the given index.

getSelectedFieldsCount()

public abstract 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
TypeDescription
int

The count of selectedFields.

getSelectedFieldsList()

public abstract List<String> 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
TypeDescription
List<String>

A list containing the selectedFields.

hasArrowSerializationOptions()

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

Whether the arrowSerializationOptions field is set.