public static interface ReadSession.TableReadOptionsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getArrowSerializationOptions()
public abstract 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 | |
|---|---|
| Type | Description |
ArrowSerializationOptions | The arrowSerializationOptions. |
getArrowSerializationOptionsOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
ArrowSerializationOptionsOrBuilder | |
getAvroSerializationOptions()
public abstract 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 | |
|---|---|
| Type | Description |
AvroSerializationOptions | The avroSerializationOptions. |
getAvroSerializationOptionsOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
AvroSerializationOptionsOrBuilder | |
getOutputFormatSerializationOptionsCase()
public abstract ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase getOutputFormatSerializationOptionsCase()| Returns | |
|---|---|
| Type | Description |
ReadSession.TableReadOptions.OutputFormatSerializationOptionsCase | |
getResponseCompressionCodec()
public abstract ReadSession.TableReadOptions.ResponseCompressionCodec getResponseCompressionCodec()Optional. Set response_compression_codec when creating a read session to enable application-level compression of ReadRows responses.
optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ReadSession.TableReadOptions.ResponseCompressionCodec | The responseCompressionCodec. |
getResponseCompressionCodecValue()
public abstract int getResponseCompressionCodecValue()Optional. Set response_compression_codec when creating a read session to enable application-level compression of ReadRows responses.
optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for responseCompressionCodec. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for rowRestriction. |
getSamplePercentage()
public abstract 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 | |
|---|---|
| Type | Description |
double | The samplePercentage. |
getSelectedFields(int index)
public abstract 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 | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The selectedFields at the given index. |
getSelectedFieldsBytes(int index)
public abstract 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 | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the selectedFields at the given index. |
getSelectedFieldsCount()
public abstract 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 abstract 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 | |
|---|---|
| Type | Description |
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.v1.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the arrowSerializationOptions field is set. |
hasAvroSerializationOptions()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the avroSerializationOptions field is set. |
hasResponseCompressionCodec()
public abstract boolean hasResponseCompressionCodec()Optional. Set response_compression_codec when creating a read session to enable application-level compression of ReadRows responses.
optional .google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions.ResponseCompressionCodec response_compression_codec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the responseCompressionCodec field is set. |
hasSamplePercentage()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the samplePercentage field is set. |