CreateReadSessionRequest

com.google.cloud.bigquery.storage.v1.storage.CreateReadSessionRequest
See theCreateReadSessionRequest companion object
final case class CreateReadSessionRequest(parent: String, readSession: Option[ReadSession], maxStreamCount: Int, preferredMinStreamCount: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateReadSessionRequest]

Request message for CreateReadSession.

Value parameters

maxStreamCount

Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000. This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

parent

Required. The request project that owns the session, in the form of projects/{project_id}.

preferredMinStreamCount

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization). The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

readSession

Required. Session to be created.

Attributes

Companion
object
Source
CreateReadSessionRequest.scala
Graph
Supertypes
trait Updatable[CreateReadSessionRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
CreateReadSessionRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
CreateReadSessionRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
CreateReadSessionRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
CreateReadSessionRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): CreateReadSessionRequest

Attributes

Source
CreateReadSessionRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
CreateReadSessionRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala