Class ReadSession.TableReadOptions.Builder (3.3.1)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The selectedFields to add.

Returns
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.TableReadOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

addSelectedFields(String value)

public ReadSession.TableReadOptions.Builder addSelectedFields(String value)

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
NameDescription
valueString

The selectedFields to add.

Returns
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

addSelectedFieldsBytes(ByteString value)

public ReadSession.TableReadOptions.Builder addSelectedFieldsBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the selectedFields to add.

Returns
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

build()

public ReadSession.TableReadOptions build()
Returns
TypeDescription
ReadSession.TableReadOptions

buildPartial()

public ReadSession.TableReadOptions buildPartial()
Returns
TypeDescription
ReadSession.TableReadOptions

clear()

public ReadSession.TableReadOptions.Builder clear()
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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
TypeDescription
ReadSession.TableReadOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public ReadSession.TableReadOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadSession.TableReadOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

clearSelectedFields()

public ReadSession.TableReadOptions.Builder clearSelectedFields()

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
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

clone()

public ReadSession.TableReadOptions.Builder clone()
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
ArrowSerializationOptionsOrBuilder

getDefaultInstanceForType()

public ReadSession.TableReadOptions getDefaultInstanceForType()
Returns
TypeDescription
ReadSession.TableReadOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for rowRestriction.

getSelectedFields(int index)

public String getSelectedFields(int index)

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The selectedFields at the given index.

getSelectedFieldsBytes(int index)

public ByteString getSelectedFieldsBytes(int index)

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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the selectedFields at the given index.

getSelectedFieldsCount()

public int getSelectedFieldsCount()

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
TypeDescription
int

The count of selectedFields.

getSelectedFieldsList()

public ProtocolStringList getSelectedFieldsList()

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
TypeDescription
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
TypeDescription
boolean

Whether the arrowSerializationOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueArrowSerializationOptions
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

mergeFrom(ReadSession.TableReadOptions other)

public ReadSession.TableReadOptions.Builder mergeFrom(ReadSession.TableReadOptions other)
Parameter
NameDescription
otherReadSession.TableReadOptions
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadSession.TableReadOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadSession.TableReadOptions.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.TableReadOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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
NameDescription
valueArrowSerializationOptions
Returns
TypeDescription
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
NameDescription
builderForValueArrowSerializationOptions.Builder
Returns
TypeDescription
ReadSession.TableReadOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReadSession.TableReadOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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

public ReadSession.TableReadOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides

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
NameDescription
valueString

The rowRestriction to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for rowRestriction to set.

Returns
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

setSelectedFields(int index, String value)

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

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
NameDescription
indexint

The index to set the value at.

valueString

The selectedFields to set.

Returns
TypeDescription
ReadSession.TableReadOptions.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadSession.TableReadOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadSession.TableReadOptions.Builder
Overrides