com.google.cloud.bigquery.storage.v1beta2

Class ReadSession.TableReadOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

com.google.cloud.bigquery.storage.v1beta2.ReadSession.TableReadOptions.Builder

All Implemented Interfaces:

ReadSession.TableReadOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ReadSession.TableReadOptions

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

 Options dictating how we read a table.
 

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

Method Summary

Modifier and Type	Method and Description
ReadSession.TableReadOptions.Builder	addAllSelectedFields(Iterable<String> values) Names of the fields in the table that should be read.
ReadSession.TableReadOptions.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ReadSession.TableReadOptions.Builder	addSelectedFields(String value) Names of the fields in the table that should be read.
ReadSession.TableReadOptions.Builder	addSelectedFieldsBytes(com.google.protobuf.ByteString value) Names of the fields in the table that should be read.
ReadSession.TableReadOptions	build()
ReadSession.TableReadOptions	buildPartial()
ReadSession.TableReadOptions.Builder	clear()
ReadSession.TableReadOptions.Builder	clearArrowSerializationOptions() Optional.
ReadSession.TableReadOptions.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ReadSession.TableReadOptions.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ReadSession.TableReadOptions.Builder	clearRowRestriction() SQL text filtering statement, similar to a WHERE clause in a query.
ReadSession.TableReadOptions.Builder	clearSelectedFields() Names of the fields in the table that should be read.
ReadSession.TableReadOptions.Builder	clone()
ArrowSerializationOptions	getArrowSerializationOptions() Optional.
ArrowSerializationOptions.Builder	getArrowSerializationOptionsBuilder() Optional.
ArrowSerializationOptionsOrBuilder	getArrowSerializationOptionsOrBuilder() Optional.
ReadSession.TableReadOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getRowRestriction() SQL text filtering statement, similar to a WHERE clause in a query.
com.google.protobuf.ByteString	getRowRestrictionBytes() SQL text filtering statement, similar to a WHERE clause in a query.
String	getSelectedFields(int index) Names of the fields in the table that should be read.
com.google.protobuf.ByteString	getSelectedFieldsBytes(int index) Names of the fields in the table that should be read.
int	getSelectedFieldsCount() Names of the fields in the table that should be read.
com.google.protobuf.ProtocolStringList	getSelectedFieldsList() Names of the fields in the table that should be read.
boolean	hasArrowSerializationOptions() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ReadSession.TableReadOptions.Builder	mergeArrowSerializationOptions(ArrowSerializationOptions value) Optional.
ReadSession.TableReadOptions.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ReadSession.TableReadOptions.Builder	mergeFrom(com.google.protobuf.Message other)
ReadSession.TableReadOptions.Builder	mergeFrom(ReadSession.TableReadOptions other)
ReadSession.TableReadOptions.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ReadSession.TableReadOptions.Builder	setArrowSerializationOptions(ArrowSerializationOptions.Builder builderForValue) Optional.
ReadSession.TableReadOptions.Builder	setArrowSerializationOptions(ArrowSerializationOptions value) Optional.
ReadSession.TableReadOptions.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ReadSession.TableReadOptions.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ReadSession.TableReadOptions.Builder	setRowRestriction(String value) SQL text filtering statement, similar to a WHERE clause in a query.
ReadSession.TableReadOptions.Builder	setRowRestrictionBytes(com.google.protobuf.ByteString value) SQL text filtering statement, similar to a WHERE clause in a query.
ReadSession.TableReadOptions.Builder	setSelectedFields(int index, String value) Names of the fields in the table that should be read.
ReadSession.TableReadOptions.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

clear

public ReadSession.TableReadOptions.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

getDefaultInstanceForType

public ReadSession.TableReadOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ReadSession.TableReadOptions build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ReadSession.TableReadOptions buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ReadSession.TableReadOptions.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

clearField

public ReadSession.TableReadOptions.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

clearOneof

public ReadSession.TableReadOptions.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

mergeFrom

public ReadSession.TableReadOptions.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadSession.TableReadOptions.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

mergeFrom

public ReadSession.TableReadOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadSession.TableReadOptions.Builder>

Throws:

IOException

getSelectedFieldsList

public com.google.protobuf.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;

Specified by:

getSelectedFieldsList in interface ReadSession.TableReadOptionsOrBuilder

Returns:

A list containing the selectedFields.

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;

Specified by:

getSelectedFieldsCount in interface ReadSession.TableReadOptionsOrBuilder

Returns:

The count of selectedFields.

getSelectedFields

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;

Specified by:

getSelectedFields in interface ReadSession.TableReadOptionsOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The selectedFields at the given index.

getSelectedFieldsBytes

public com.google.protobuf.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;

Specified by:

getSelectedFieldsBytes in interface ReadSession.TableReadOptionsOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the selectedFields at the given index.

setSelectedFields

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:

index - The index to set the value at.

value - The selectedFields to set.

Returns:

This builder for chaining.

addSelectedFields

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;

Parameters:

value - The selectedFields to add.

Returns:

This builder for chaining.

addAllSelectedFields

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;

Parameters:

values - The selectedFields to add.

Returns:

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:

This builder for chaining.

addSelectedFieldsBytes

public ReadSession.TableReadOptions.Builder addSelectedFieldsBytes(com.google.protobuf.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;

Parameters:

value - The bytes of the selectedFields to add.

Returns:

This builder for chaining.

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;

Specified by:

getRowRestriction in interface ReadSession.TableReadOptionsOrBuilder

Returns:

The rowRestriction.

getRowRestrictionBytes

public com.google.protobuf.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;

Specified by:

getRowRestrictionBytes in interface ReadSession.TableReadOptionsOrBuilder

Returns:

The bytes for rowRestriction.

setRowRestriction

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;

Parameters:

value - The rowRestriction to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setRowRestrictionBytes

public ReadSession.TableReadOptions.Builder setRowRestrictionBytes(com.google.protobuf.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;

Parameters:

value - The bytes for rowRestriction to set.

Returns:

This builder for chaining.

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

Specified by:

hasArrowSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder

Returns:

Whether the arrowSerializationOptions field is set.

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

Specified by:

getArrowSerializationOptions in interface ReadSession.TableReadOptionsOrBuilder

Returns:

The arrowSerializationOptions.

setArrowSerializationOptions

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

setArrowSerializationOptions

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

mergeArrowSerializationOptions

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

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

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

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

Specified by:

getArrowSerializationOptionsOrBuilder in interface ReadSession.TableReadOptionsOrBuilder

setUnknownFields

public final ReadSession.TableReadOptions.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>

mergeUnknownFields

public final ReadSession.TableReadOptions.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadSession.TableReadOptions.Builder>