Class ReadSession.TableReadOptions.Builder (3.8.0)

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

Options dictating how we read a table.

Protobuf type google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadSession.TableReadOptions.Builder

Implements

ReadSession.TableReadOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllSelectedFields(Iterable<String> values)

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

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
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.TableReadOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

addSelectedFields(String value)

public ReadSession.TableReadOptions.Builder addSelectedFields(String value)

repeated string selected_fields = 1;

Parameter
Name	Description
`value`	`String` The selectedFields to add.

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

addSelectedFieldsBytes(ByteString value)

public ReadSession.TableReadOptions.Builder addSelectedFieldsBytes(ByteString value)

repeated string selected_fields = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes of the selectedFields to add.

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

build()

public ReadSession.TableReadOptions build()

Returns
Type	Description
`ReadSession.TableReadOptions`

buildPartial()

public ReadSession.TableReadOptions buildPartial()

Returns
Type	Description
`ReadSession.TableReadOptions`

clear()

public ReadSession.TableReadOptions.Builder clear()

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArrowSerializationOptions()

public ReadSession.TableReadOptions.Builder clearArrowSerializationOptions()

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
Type	Description
`ReadSession.TableReadOptions.Builder`

clearField(Descriptors.FieldDescriptor field)

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

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

clearRowRestriction()

public ReadSession.TableReadOptions.Builder clearRowRestriction()

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
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

clearSelectedFields()

public ReadSession.TableReadOptions.Builder clearSelectedFields()

repeated string selected_fields = 1;

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

clone()

public ReadSession.TableReadOptions.Builder clone()

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getArrowSerializationOptions()

public 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
Type	Description
`ArrowSerializationOptions`	The arrowSerializationOptions.

getArrowSerializationOptionsBuilder()

public ArrowSerializationOptions.Builder getArrowSerializationOptionsBuilder()

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
Type	Description
`ArrowSerializationOptions.Builder`

getArrowSerializationOptionsOrBuilder()

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

Returns
Type	Description
`ArrowSerializationOptionsOrBuilder`

getDefaultInstanceForType()

public ReadSession.TableReadOptions getDefaultInstanceForType()

Returns
Type	Description
`ReadSession.TableReadOptions`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getRowRestriction()

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

getSelectedFields(int index)

public String getSelectedFields(int index)

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)

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()

repeated string selected_fields = 1;

Returns
Type	Description
`int`	The count of selectedFields.

getSelectedFieldsList()

public ProtocolStringList getSelectedFieldsList()

repeated string selected_fields = 1;

Returns
Type	Description
`ProtocolStringList`	A list containing the selectedFields.

hasArrowSerializationOptions()

public 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
Type	Description
`boolean`	Whether the arrowSerializationOptions field is set.

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()

mergeArrowSerializationOptions(ArrowSerializationOptions value)

public ReadSession.TableReadOptions.Builder mergeArrowSerializationOptions(ArrowSerializationOptions value)

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ArrowSerializationOptions`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

mergeFrom(ReadSession.TableReadOptions other)

public ReadSession.TableReadOptions.Builder mergeFrom(ReadSession.TableReadOptions other)

Parameter
Name	Description
`other`	`ReadSession.TableReadOptions`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadSession.TableReadOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ReadSession.TableReadOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

setArrowSerializationOptions(ArrowSerializationOptions value)

public ReadSession.TableReadOptions.Builder setArrowSerializationOptions(ArrowSerializationOptions value)

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ArrowSerializationOptions`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

setArrowSerializationOptions(ArrowSerializationOptions.Builder builderForValue)

public ReadSession.TableReadOptions.Builder setArrowSerializationOptions(ArrowSerializationOptions.Builder builderForValue)

Optional. Options specific to the Apache Arrow output format.

.google.cloud.bigquery.storage.v1beta2.ArrowSerializationOptions arrow_serialization_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`ArrowSerializationOptions.Builder`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.TableReadOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReadSession.TableReadOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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

setRowRestriction(String value)

public ReadSession.TableReadOptions.Builder setRowRestriction(String value)

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;

Parameter
Name	Description
`value`	`String` The rowRestriction to set.

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

setRowRestrictionBytes(ByteString value)

public ReadSession.TableReadOptions.Builder setRowRestrictionBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for rowRestriction to set.

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

setSelectedFields(int index, String value)

public ReadSession.TableReadOptions.Builder setSelectedFields(int index, String value)

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
`ReadSession.TableReadOptions.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.TableReadOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReadSession.TableReadOptions.Builder`

Overrides

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