Class ReadOptions.TableReadOptions.Builder (2.6.5)

Version 2.6.5

• 3.10.3 (latest)
• 3.10.2
• 3.9.3
• 3.8.0
• 3.6.1
• 3.5.2
• 3.4.0
• 3.3.1
• 3.2.0
• 3.1.0
• 3.0.1
• 2.47.0
• 2.45.0
• 2.44.1
• 2.43.0

public static final class ReadOptions.TableReadOptions.Builder extends GeneratedMessageV3.Builder<ReadOptions.TableReadOptions.Builder> implements ReadOptions.TableReadOptionsOrBuilder

Options 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.Builder

Implements

ReadOptions.TableReadOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addAllSelectedFields(Iterable<String> values)

public ReadOptions.TableReadOptions.Builder addAllSelectedFields(Iterable<String> values)

Optional. 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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSelectedFields(String value)

public ReadOptions.TableReadOptions.Builder addSelectedFields(String value)

Optional. 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

Name	Description
value	String The selectedFields to add.

Returns

Type	Description
ReadOptions.TableReadOptions.Builder	This builder for chaining.

addSelectedFieldsBytes(ByteString value)

public ReadOptions.TableReadOptions.Builder addSelectedFieldsBytes(ByteString value)

Optional. 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

Name	Description
value	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ReadOptions.TableReadOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ReadOptions.TableReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadOptions.TableReadOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ReadOptions.TableReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRowRestriction()

public ReadOptions.TableReadOptions.Builder clearRowRestriction()

Optional. 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"

string row_restriction = 2;

Returns

Type	Description
ReadOptions.TableReadOptions.Builder	This builder for chaining.

clearSelectedFields()

public ReadOptions.TableReadOptions.Builder clearSelectedFields()

Optional. 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

Type	Description
ReadOptions.TableReadOptions.Builder	This builder for chaining.

clone()

public ReadOptions.TableReadOptions.Builder clone()

Returns

Type	Description
ReadOptions.TableReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ReadOptions.TableReadOptions getDefaultInstanceForType()

Returns

Type	Description
ReadOptions.TableReadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getRowRestriction()

public String getRowRestriction()

Optional. 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"

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 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"

string row_restriction = 2;

Returns

Type	Description
ByteString	The bytes for rowRestriction.

getSelectedFields(int index)

public String getSelectedFields(int index)

Optional. 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

Name	Description
index	int The 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. 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

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the selectedFields at the given index.

getSelectedFieldsCount()

public int getSelectedFieldsCount()

Optional. 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

Type	Description
int	The count of selectedFields.

getSelectedFieldsList()

public ProtocolStringList getSelectedFieldsList()

Optional. 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

Type	Description
ProtocolStringList	A list containing the selectedFields.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadOptions.TableReadOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ReadOptions.TableReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRowRestriction(String value)

public ReadOptions.TableReadOptions.Builder setRowRestriction(String value)

Optional. 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"

string row_restriction = 2;

Parameter

Name	Description
value	String The 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 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"

string row_restriction = 2;

Parameter

Name	Description
value	ByteString The 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. 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

Name	Description
index	int The index to set the value at.
value	String The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)