public static final class ReadOptions.TableReadOptions.Builder extends GeneratedMessageV3.Builder<ReadOptions.TableReadOptions.Builder> implements ReadOptions.TableReadOptionsOrBuilderOptions dictating how we read a table.
Protobuf type google.cloud.bigquery.storage.v1beta1.TableReadOptions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadOptions.TableReadOptions.BuilderImplements
ReadOptions.TableReadOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllSelectedFields(Iterable<String> values)
public ReadOptions.TableReadOptions.Builder addAllSelectedFields(Iterable<String> values)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 |
values | Iterable<String>The selectedFields to add. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadOptions.TableReadOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
addSelectedFields(String value)
public ReadOptions.TableReadOptions.Builder addSelectedFields(String value)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 |
value | StringThe selectedFields to add. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
addSelectedFieldsBytes(ByteString value)
public ReadOptions.TableReadOptions.Builder addSelectedFieldsBytes(ByteString value)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 |
value | ByteStringThe bytes of the selectedFields to add. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
build()
public ReadOptions.TableReadOptions build()| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions | |
buildPartial()
public ReadOptions.TableReadOptions buildPartial()| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions | |
clear()
public ReadOptions.TableReadOptions.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ReadOptions.TableReadOptions.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ReadOptions.TableReadOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
clearRowRestriction()
public ReadOptions.TableReadOptions.Builder clearRowRestriction()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 |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
clearSelectedFields()
public ReadOptions.TableReadOptions.Builder clearSelectedFields()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 |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
clone()
public ReadOptions.TableReadOptions.Builder clone()| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
getDefaultInstanceForType()
public ReadOptions.TableReadOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | intThe 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 | intThe 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ReadOptions.TableReadOptions other)
public ReadOptions.TableReadOptions.Builder mergeFrom(ReadOptions.TableReadOptions other)| Parameter | |
|---|---|
| Name | Description |
other | ReadOptions.TableReadOptions |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReadOptions.TableReadOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ReadOptions.TableReadOptions.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReadOptions.TableReadOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ReadOptions.TableReadOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadOptions.TableReadOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |
setRowRestriction(String value)
public ReadOptions.TableReadOptions.Builder setRowRestriction(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe rowRestriction to set. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
setRowRestrictionBytes(ByteString value)
public ReadOptions.TableReadOptions.Builder setRowRestrictionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for rowRestriction to set. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
setSelectedFields(int index, String value)
public ReadOptions.TableReadOptions.Builder setSelectedFields(int index, String value)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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe selectedFields to set. |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ReadOptions.TableReadOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadOptions.TableReadOptions.Builder | |