Package com.google.cloud.bigquery.storage.v1

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	Description
ArrowSerializationOptions	getArrowSerializationOptions()	Optional.
ArrowSerializationOptionsOrBuilder	getArrowSerializationOptionsOrBuilder()	Optional.
AvroSerializationOptions	getAvroSerializationOptions()	Optional.
AvroSerializationOptionsOrBuilder	getAvroSerializationOptionsOrBuilder()	Optional.
ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase	getOutputFormatSerializationOptionsCase()
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.
double	getSamplePercentage()	Optional.
String	getSelectedFields(int index)	Optional.
com.google.protobuf.ByteString	getSelectedFieldsBytes(int index)	Optional.
int	getSelectedFieldsCount()	Optional.
List<String>	getSelectedFieldsList()	Optional.
boolean	hasArrowSerializationOptions()	Optional.
boolean	hasAvroSerializationOptions()	Optional.
boolean	hasSamplePercentage()	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getSelectedFieldsList

List<String> 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:

A list containing the selectedFields.

getSelectedFieldsCount

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:

The count of selectedFields.

getSelectedFields

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;

Parameters:

index - The index of the element to return.

Returns:

The selectedFields at the given index.

getSelectedFieldsBytes

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

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.v1.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.v1.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.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

hasAvroSerializationOptions

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:

Whether the avroSerializationOptions field is set.

getAvroSerializationOptions

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:

The avroSerializationOptions.

getAvroSerializationOptionsOrBuilder

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

hasSamplePercentage

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:

Whether the samplePercentage field is set.

getSamplePercentage

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:

The samplePercentage.

getOutputFormatSerializationOptionsCase

ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase getOutputFormatSerializationOptionsCase()