com.google.cloud.bigquery.storage.v1beta2

Interface ReadSession.TableReadOptionsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ReadSession.TableReadOptions, ReadSession.TableReadOptions.Builder

Enclosing class:

ReadSession

public static interface ReadSession.TableReadOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ArrowSerializationOptions	getArrowSerializationOptions() Optional.
ArrowSerializationOptionsOrBuilder	getArrowSerializationOptionsOrBuilder() Optional.
String	getRowRestriction() SQL text filtering statement, similar to a WHERE clause in a query.
com.google.protobuf.ByteString	getRowRestrictionBytes() SQL text filtering statement, similar to a WHERE clause in a query.
String	getSelectedFields(int index) Names of the fields in the table that should be read.
com.google.protobuf.ByteString	getSelectedFieldsBytes(int index) Names of the fields in the table that should be read.
int	getSelectedFieldsCount() Names of the fields in the table that should be read.
List<String>	getSelectedFieldsList() Names of the fields in the table that should be read.
boolean	hasArrowSerializationOptions() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSelectedFieldsList

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:

A list containing the selectedFields.

getSelectedFieldsCount

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:

The count of selectedFields.

getSelectedFields

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;

Parameters:

index - The index of the element to return.

Returns:

The selectedFields at the given index.

getSelectedFieldsBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the selectedFields at the given index.

getRowRestriction

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:

The rowRestriction.

getRowRestrictionBytes

com.google.protobuf.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:

The bytes for rowRestriction.

hasArrowSerializationOptions

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:

Whether the arrowSerializationOptions field is set.

getArrowSerializationOptions

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:

The arrowSerializationOptions.

getArrowSerializationOptionsOrBuilder

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