com.google.cloud.bigquery.storage.v1beta2

Class ReadSession.TableReadOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

ReadSession.TableReadOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

ReadSession

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

 Options dictating how we read a table.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadSession.TableReadOptions.Builder Options dictating how we read a table.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER
static int	ROW_RESTRICTION_FIELD_NUMBER
static int	SELECTED_FIELDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ArrowSerializationOptions	getArrowSerializationOptions() Optional.
ArrowSerializationOptionsOrBuilder	getArrowSerializationOptionsOrBuilder() Optional.
static ReadSession.TableReadOptions	getDefaultInstance()
ReadSession.TableReadOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ReadSession.TableReadOptions>	getParserForType()
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.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasArrowSerializationOptions() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReadSession.TableReadOptions.Builder	newBuilder()
static ReadSession.TableReadOptions.Builder	newBuilder(ReadSession.TableReadOptions prototype)
ReadSession.TableReadOptions.Builder	newBuilderForType()
protected ReadSession.TableReadOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ReadSession.TableReadOptions	parseDelimitedFrom(InputStream input)
static ReadSession.TableReadOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSession.TableReadOptions	parseFrom(byte[] data)
static ReadSession.TableReadOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSession.TableReadOptions	parseFrom(ByteBuffer data)
static ReadSession.TableReadOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSession.TableReadOptions	parseFrom(com.google.protobuf.ByteString data)
static ReadSession.TableReadOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSession.TableReadOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static ReadSession.TableReadOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSession.TableReadOptions	parseFrom(InputStream input)
static ReadSession.TableReadOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ReadSession.TableReadOptions>	parser()
ReadSession.TableReadOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SELECTED_FIELDS_FIELD_NUMBER

public static final int SELECTED_FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

ROW_RESTRICTION_FIELD_NUMBER

public static final int ROW_RESTRICTION_FIELD_NUMBER

See Also:

Constant Field Values

ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER

public static final int ARROW_SERIALIZATION_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSession.TableReadOptions parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static ReadSession.TableReadOptions parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReadSession.TableReadOptions parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static ReadSession.TableReadOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ReadSession.TableReadOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReadSession.TableReadOptions.Builder newBuilder()

newBuilder

public static ReadSession.TableReadOptions.Builder newBuilder(ReadSession.TableReadOptions prototype)

toBuilder

public ReadSession.TableReadOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ReadSession.TableReadOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ReadSession.TableReadOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<ReadSession.TableReadOptions> parser()

getParserForType

public com.google.protobuf.Parser<ReadSession.TableReadOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ReadSession.TableReadOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder