public final class ReadSession extends com.google.protobuf.GeneratedMessageV3 implements ReadSessionOrBuilder
Information about the ReadSession.Protobuf type
google.cloud.bigquery.storage.v1.ReadSession| Modifier and Type | Class and Description |
|---|---|
static class |
ReadSession.Builder
Information about the ReadSession.
|
static class |
ReadSession.SchemaCase |
static class |
ReadSession.TableModifiers
Additional attributes when reading a table.
|
static interface |
ReadSession.TableModifiersOrBuilder |
static class |
ReadSession.TableReadOptions
Options dictating how we read a table.
|
static interface |
ReadSession.TableReadOptionsOrBuilder |
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| Modifier and Type | Field and Description |
|---|---|
static int |
ARROW_SCHEMA_FIELD_NUMBER |
static int |
AVRO_SCHEMA_FIELD_NUMBER |
static int |
DATA_FORMAT_FIELD_NUMBER |
static int |
ESTIMATED_ROW_COUNT_FIELD_NUMBER |
static int |
ESTIMATED_TOTAL_BYTES_SCANNED_FIELD_NUMBER |
static int |
EXPIRE_TIME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
READ_OPTIONS_FIELD_NUMBER |
static int |
STREAMS_FIELD_NUMBER |
static int |
TABLE_FIELD_NUMBER |
static int |
TABLE_MODIFIERS_FIELD_NUMBER |
static int |
TRACE_ID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
ArrowSchema |
getArrowSchema()
Output only.
|
ArrowSchemaOrBuilder |
getArrowSchemaOrBuilder()
Output only.
|
AvroSchema |
getAvroSchema()
Output only.
|
AvroSchemaOrBuilder |
getAvroSchemaOrBuilder()
Output only.
|
DataFormat |
getDataFormat()
Immutable.
|
int |
getDataFormatValue()
Immutable.
|
static ReadSession |
getDefaultInstance() |
ReadSession |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
long |
getEstimatedRowCount()
Output only.
|
long |
getEstimatedTotalBytesScanned()
Output only.
|
com.google.protobuf.Timestamp |
getExpireTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getExpireTimeOrBuilder()
Output only.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<ReadSession> |
getParserForType() |
ReadSession.TableReadOptions |
getReadOptions()
Optional.
|
ReadSession.TableReadOptionsOrBuilder |
getReadOptionsOrBuilder()
Optional.
|
ReadSession.SchemaCase |
getSchemaCase() |
int |
getSerializedSize() |
ReadStream |
getStreams(int index)
Output only.
|
int |
getStreamsCount()
Output only.
|
List<ReadStream> |
getStreamsList()
Output only.
|
ReadStreamOrBuilder |
getStreamsOrBuilder(int index)
Output only.
|
List<? extends ReadStreamOrBuilder> |
getStreamsOrBuilderList()
Output only.
|
String |
getTable()
Immutable.
|
com.google.protobuf.ByteString |
getTableBytes()
Immutable.
|
ReadSession.TableModifiers |
getTableModifiers()
Optional.
|
ReadSession.TableModifiersOrBuilder |
getTableModifiersOrBuilder()
Optional.
|
String |
getTraceId()
Optional.
|
com.google.protobuf.ByteString |
getTraceIdBytes()
Optional.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasArrowSchema()
Output only.
|
boolean |
hasAvroSchema()
Output only.
|
boolean |
hasExpireTime()
Output only.
|
int |
hashCode() |
boolean |
hasReadOptions()
Optional.
|
boolean |
hasTableModifiers()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ReadSession.Builder |
newBuilder() |
static ReadSession.Builder |
newBuilder(ReadSession prototype) |
ReadSession.Builder |
newBuilderForType() |
protected ReadSession.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ReadSession |
parseDelimitedFrom(InputStream input) |
static ReadSession |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ReadSession |
parseFrom(byte[] data) |
static ReadSession |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ReadSession |
parseFrom(ByteBuffer data) |
static ReadSession |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ReadSession |
parseFrom(com.google.protobuf.ByteString data) |
static ReadSession |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ReadSession |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ReadSession |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ReadSession |
parseFrom(InputStream input) |
static ReadSession |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ReadSession> |
parser() |
ReadSession.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
public static final int DATA_FORMAT_FIELD_NUMBER
public static final int AVRO_SCHEMA_FIELD_NUMBER
public static final int ARROW_SCHEMA_FIELD_NUMBER
public static final int TABLE_FIELD_NUMBER
public static final int TABLE_MODIFIERS_FIELD_NUMBER
public static final int READ_OPTIONS_FIELD_NUMBER
public static final int STREAMS_FIELD_NUMBER
public static final int ESTIMATED_TOTAL_BYTES_SCANNED_FIELD_NUMBER
public static final int ESTIMATED_ROW_COUNT_FIELD_NUMBER
public static final int TRACE_ID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ReadSession.SchemaCase getSchemaCase()
getSchemaCase in interface ReadSessionOrBuilderpublic String getName()
Output only. Unique identifier for the session, in the form
`projects/{project_id}/locations/{location}/sessions/{session_id}`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface ReadSessionOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Unique identifier for the session, in the form
`projects/{project_id}/locations/{location}/sessions/{session_id}`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface ReadSessionOrBuilderpublic boolean hasExpireTime()
Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.
.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasExpireTime in interface ReadSessionOrBuilderpublic com.google.protobuf.Timestamp getExpireTime()
Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.
.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExpireTime in interface ReadSessionOrBuilderpublic com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.
.google.protobuf.Timestamp expire_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExpireTimeOrBuilder in interface ReadSessionOrBuilderpublic int getDataFormatValue()
Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.
.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
getDataFormatValue in interface ReadSessionOrBuilderpublic DataFormat getDataFormat()
Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.
.google.cloud.bigquery.storage.v1.DataFormat data_format = 3 [(.google.api.field_behavior) = IMMUTABLE];
getDataFormat in interface ReadSessionOrBuilderpublic boolean hasAvroSchema()
Output only. Avro schema.
.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAvroSchema in interface ReadSessionOrBuilderpublic AvroSchema getAvroSchema()
Output only. Avro schema.
.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAvroSchema in interface ReadSessionOrBuilderpublic AvroSchemaOrBuilder getAvroSchemaOrBuilder()
Output only. Avro schema.
.google.cloud.bigquery.storage.v1.AvroSchema avro_schema = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAvroSchemaOrBuilder in interface ReadSessionOrBuilderpublic boolean hasArrowSchema()
Output only. Arrow schema.
.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasArrowSchema in interface ReadSessionOrBuilderpublic ArrowSchema getArrowSchema()
Output only. Arrow schema.
.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getArrowSchema in interface ReadSessionOrBuilderpublic ArrowSchemaOrBuilder getArrowSchemaOrBuilder()
Output only. Arrow schema.
.google.cloud.bigquery.storage.v1.ArrowSchema arrow_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getArrowSchemaOrBuilder in interface ReadSessionOrBuilderpublic String getTable()
Immutable. Table that this ReadSession is reading from, in the form
`projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getTable in interface ReadSessionOrBuilderpublic com.google.protobuf.ByteString getTableBytes()
Immutable. Table that this ReadSession is reading from, in the form
`projects/{project_id}/datasets/{dataset_id}/tables/{table_id}`
string table = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getTableBytes in interface ReadSessionOrBuilderpublic boolean hasTableModifiers()
Optional. Any modifiers which are applied when reading from the specified table.
.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
hasTableModifiers in interface ReadSessionOrBuilderpublic ReadSession.TableModifiers getTableModifiers()
Optional. Any modifiers which are applied when reading from the specified table.
.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
getTableModifiers in interface ReadSessionOrBuilderpublic ReadSession.TableModifiersOrBuilder getTableModifiersOrBuilder()
Optional. Any modifiers which are applied when reading from the specified table.
.google.cloud.bigquery.storage.v1.ReadSession.TableModifiers table_modifiers = 7 [(.google.api.field_behavior) = OPTIONAL];
getTableModifiersOrBuilder in interface ReadSessionOrBuilderpublic boolean hasReadOptions()
Optional. Read options for this session (e.g. column selection, filters).
.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
hasReadOptions in interface ReadSessionOrBuilderpublic ReadSession.TableReadOptions getReadOptions()
Optional. Read options for this session (e.g. column selection, filters).
.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
getReadOptions in interface ReadSessionOrBuilderpublic ReadSession.TableReadOptionsOrBuilder getReadOptionsOrBuilder()
Optional. Read options for this session (e.g. column selection, filters).
.google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions read_options = 8 [(.google.api.field_behavior) = OPTIONAL];
getReadOptionsOrBuilder in interface ReadSessionOrBuilderpublic List<ReadStream> getStreamsList()
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreamsList in interface ReadSessionOrBuilderpublic List<? extends ReadStreamOrBuilder> getStreamsOrBuilderList()
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreamsOrBuilderList in interface ReadSessionOrBuilderpublic int getStreamsCount()
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreamsCount in interface ReadSessionOrBuilderpublic ReadStream getStreams(int index)
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreams in interface ReadSessionOrBuilderpublic ReadStreamOrBuilder getStreamsOrBuilder(int index)
Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values *may* result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.
repeated .google.cloud.bigquery.storage.v1.ReadStream streams = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreamsOrBuilder in interface ReadSessionOrBuilderpublic long getEstimatedTotalBytesScanned()
Output only. An estimate on the number of bytes this session will scan when all streams are completely consumed. This estimate is based on metadata from the table which might be incomplete or stale.
int64 estimated_total_bytes_scanned = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEstimatedTotalBytesScanned in interface ReadSessionOrBuilderpublic long getEstimatedRowCount()
Output only. An estimate on the number of rows present in this session's streams. This estimate is based on metadata from the table which might be incomplete or stale.
int64 estimated_row_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getEstimatedRowCount in interface ReadSessionOrBuilderpublic String getTraceId()
Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable). Maximum length is 256 bytes.
string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];getTraceId in interface ReadSessionOrBuilderpublic com.google.protobuf.ByteString getTraceIdBytes()
Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable). Maximum length is 256 bytes.
string trace_id = 13 [(.google.api.field_behavior) = OPTIONAL];getTraceIdBytes in interface ReadSessionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ReadSession parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ReadSession parseFrom(InputStream input) throws IOException
IOExceptionpublic static ReadSession parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ReadSession parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ReadSession parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ReadSession parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ReadSession parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ReadSession.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ReadSession.Builder newBuilder()
public static ReadSession.Builder newBuilder(ReadSession prototype)
public ReadSession.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ReadSession.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ReadSession getDefaultInstance()
public static com.google.protobuf.Parser<ReadSession> parser()
public com.google.protobuf.Parser<ReadSession> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ReadSession getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.