http4s-grpc-google-cloud-bigquerystorage-v1
2.37.0+0.0.5
API
Generated with
http4s-grpc-google-cloud-bigquerystorage-v1/com.google.cloud.bigquery.storage.v1.stream

com.google.cloud.bigquery.storage.v1.stream

package com.google.cloud.bigquery.storage.v1.stream

Members list

Concise view

Type members

Classlikes

sealed abstract class DataFormat(val value: Int) extends GeneratedEnum

Data format for input or output data.

Data format for input or output data.

Attributes

Companion:
object
Source:
DataFormat.scala
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object ARROW.type
object AVRO.type
object DataFormat extends GeneratedEnumCompanion[DataFormat]

Attributes

Companion:
class
Source:
DataFormat.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[DataFormat]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ReadSession(name: String, expireTime: Option[Timestamp], dataFormat: DataFormat, schema: Schema, table: String, tableModifiers: Option[TableModifiers], readOptions: Option[TableReadOptions], streams: Seq[ReadStream], estimatedTotalBytesScanned: Long, estimatedRowCount: Long, traceId: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ReadSession]

Information about the ReadSession.

Information about the ReadSession.

Attributes

dataFormat

Immutable. Data format of the output data. DATA_FORMAT_UNSPECIFIED not supported.

estimatedRowCount

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.

estimatedTotalBytesScanned

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.

expireTime

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.

name

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

readOptions

Optional. Read options for this session (e.g. column selection, filters).

streams

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.

table

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

tableModifiers

Optional. Any modifiers which are applied when reading from the specified table.

traceId

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.

Companion:
object
Source:
ReadSession.scala
Graph
Supertypes
trait Updatable[ReadSession]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ReadSession extends GeneratedMessageCompanion[ReadSession]

Attributes

Companion:
class
Source:
ReadSession.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadSession]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ReadStream(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ReadStream]

Information about a single stream that gets data out of the storage system. Most of the information about ReadStream instances is aggregated, making ReadStream lightweight.

Information about a single stream that gets data out of the storage system. Most of the information about ReadStream instances is aggregated, making ReadStream lightweight.

Attributes

name

Output only. Name of the stream, in the form projects/{project_id}/locations/{location}/sessions/{session_id}/streams/{stream_id}.

Companion:
object
Source:
ReadStream.scala
Graph
Supertypes
trait Updatable[ReadStream]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ReadStream extends GeneratedMessageCompanion[ReadStream]

Attributes

Companion:
class
Source:
ReadStream.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadStream]
trait Serializable
class Object
trait Matchable
class Any
Self type
object StreamProto extends GeneratedFileObject

Attributes

Source:
StreamProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class WriteStream(name: String, `type`: Type, createTime: Option[Timestamp], commitTime: Option[Timestamp], tableSchema: Option[TableSchema], writeMode: WriteMode, location: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[WriteStream]

Information about a single stream that gets data inside the storage system.

Information about a single stream that gets data inside the storage system.

Attributes

commitTime

Output only. Commit time of the stream. If a stream is of COMMITTED type, then it will have a commit_time same as create_time. If the stream is of PENDING type, empty commit_time means it is not committed.

createTime

Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.

location

Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.

name

Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

tableSchema

Output only. The schema of the destination table. It is only returned in CreateWriteStream response. Caller should generate data that's compatible with this schema to send in initial AppendRowsRequest. The table schema could go out of date during the life time of the stream.

type

Immutable. Type of the stream.

writeMode

Immutable. Mode of the stream.

Companion:
object
Source:
WriteStream.scala
Graph
Supertypes
trait Updatable[WriteStream]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object WriteStream extends GeneratedMessageCompanion[WriteStream]

Attributes

Companion:
class
Source:
WriteStream.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[WriteStream]
trait Serializable
class Object
trait Matchable
class Any
Self type
sealed abstract class WriteStreamView(val value: Int) extends GeneratedEnum

WriteStreamView is a view enum that controls what details about a write stream should be returned.

WriteStreamView is a view enum that controls what details about a write stream should be returned.

Attributes

Companion:
object
Source:
WriteStreamView.scala
Graph
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object BASIC.type
object FULL.type
object WriteStreamView extends GeneratedEnumCompanion[WriteStreamView]

Attributes

Companion:
class
Source:
WriteStreamView.scala
Graph
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[WriteStreamView]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with