http4s-grpc-google-cloud-bigtable-v2
2.20.4+0.0.5
API
Generated with
http4s-grpc-google-cloud-bigtable-v2/com.google.bigtable.v2.bigtable/ReadChangeStreamResponse

ReadChangeStreamResponse

com.google.bigtable.v2.bigtable.ReadChangeStreamResponse$
See theReadChangeStreamResponse companion class
object ReadChangeStreamResponse extends GeneratedMessageCompanion[ReadChangeStreamResponse]

Attributes

Companion:
class
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadChangeStreamResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

final case class CloseStream(status: Option[Status], continuationTokens: Seq[StreamContinuationToken], newPartitions: Seq[StreamPartition], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CloseStream]

A message indicating that the client should stop reading from the stream. If status is OK and continuation_tokens & new_partitions are empty, the stream has finished (for example if there was an end_time specified). If continuation_tokens & new_partitions are present, then a change in partitioning requires the client to open a new stream for each token to resume reading. Example: [B, D) ends | v new_partitions: [A, C) [C, E) continuation_tokens.partitions: [B,C) [C,D) ^---^ ^---^ ^ ^ | | | StreamContinuationToken 2 | StreamContinuationToken 1 To read the new partition [A,C), supply the continuation tokens whose ranges cover the new partition, for example ContinuationToken[A,B) & ContinuationToken[B,C).

A message indicating that the client should stop reading from the stream. If status is OK and continuation_tokens & new_partitions are empty, the stream has finished (for example if there was an end_time specified). If continuation_tokens & new_partitions are present, then a change in partitioning requires the client to open a new stream for each token to resume reading. Example: [B, D) ends | v new_partitions: [A, C) [C, E) continuation_tokens.partitions: [B,C) [C,D) ^---^ ^---^ ^ ^ | | | StreamContinuationToken 2 | StreamContinuationToken 1 To read the new partition [A,C), supply the continuation tokens whose ranges cover the new partition, for example ContinuationToken[A,B) & ContinuationToken[B,C).

Attributes

continuationTokens

If non-empty, contains the information needed to resume reading their associated partitions.

newPartitions

If non-empty, contains the new partitions to start reading from, which are related to but not necessarily identical to the partitions for the above continuation_tokens.

status

The status of the stream.

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

Attributes

Companion:
class
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CloseStream]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DataChange(`type`: Type, sourceClusterId: String, rowKey: ByteString, commitTimestamp: Option[Timestamp], tiebreaker: Int, chunks: Seq[MutationChunk], done: Boolean, token: String, estimatedLowWatermark: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DataChange]

A message corresponding to one or more mutations to the partition being streamed. A single logical DataChange message may also be split across a sequence of multiple individual messages. Messages other than the first in a sequence will only have the type and chunks fields populated, with the final message in the sequence also containing done set to true.

A message corresponding to one or more mutations to the partition being streamed. A single logical DataChange message may also be split across a sequence of multiple individual messages. Messages other than the first in a sequence will only have the type and chunks fields populated, with the final message in the sequence also containing done set to true.

Attributes

chunks

The mutations associated with this change to the partition. May contain complete mutations or chunks of a multi-message chunked DataChange record.

commitTimestamp

The timestamp at which the mutation was applied on the Bigtable server.

done

When true, indicates that the entire DataChange has been read and the client can safely process the message.

estimatedLowWatermark

An estimate of the commit timestamp that is usually lower than or equal to any timestamp for a record that will be delivered in the future on the stream. It is possible that, under particular circumstances that a future record has a timestamp is is lower than a previously seen timestamp. For an example usage see https://beam.apache.org/documentation/basics/#watermarks

rowKey

The row key for all mutations that are part of this DataChange. If the DataChange is chunked across multiple messages, then this field will only be set for the first message.

sourceClusterId

The cluster where the mutation was applied. Not set when type is GARBAGE_COLLECTION.

tiebreaker

A value that lets stream consumers reconstruct Bigtable's conflict resolution semantics. https://cloud.google.com/bigtable/docs/writes#conflict-resolution In the event that the same row key, column family, column qualifier, timestamp are modified on different clusters at the same commit_timestamp, the mutation with the larger tiebreaker will be the one chosen for the eventually consistent state of the system.

token

An encoded position for this stream's partition to restart reading from. This token is for the StreamPartition from the request.

type

The type of the mutation.

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

Attributes

Companion:
class
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DataChange]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class Heartbeat(continuationToken: Option[StreamContinuationToken], estimatedLowWatermark: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Heartbeat]

A periodic message with information that can be used to checkpoint the state of a stream.

A periodic message with information that can be used to checkpoint the state of a stream.

Attributes

continuationToken

A token that can be provided to a subsequent ReadChangeStream call to pick up reading at the current stream position.

estimatedLowWatermark

An estimate of the commit timestamp that is usually lower than or equal to any timestamp for a record that will be delivered in the future on the stream. It is possible that, under particular circumstances that a future record has a timestamp is is lower than a previously seen timestamp. For an example usage see https://beam.apache.org/documentation/basics/#watermarks

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

Attributes

Companion:
class
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Heartbeat]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class MutationChunk(chunkInfo: Option[ChunkInfo], mutation: Option[Mutation], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[MutationChunk]

A partial or complete mutation.

A partial or complete mutation.

Attributes

chunkInfo

If set, then the mutation is a SetCell with a chunked value across multiple messages.

mutation

If this is a continuation of a chunked message (chunked_value_offset > 0), ignore all fields except the SetCell's value and merge it with the previous message by concatenating the value fields.

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

Attributes

Companion:
class
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MutationChunk]
trait Serializable
class Object
trait Matchable
class Any
Self type
implicit class ReadChangeStreamResponseLens[UpperPB](_l: Lens[UpperPB, ReadChangeStreamResponse]) extends ObjectLens[UpperPB, ReadChangeStreamResponse]

Attributes

Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
class ObjectLens[UpperPB, ReadChangeStreamResponse]
trait Lens[UpperPB, ReadChangeStreamResponse]
trait Serializable
class Object
trait Matchable
class Any
object StreamRecord

Attributes

Companion:
trait
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait StreamRecord extends GeneratedOneof

Attributes

Companion:
object
Source:
ReadChangeStreamResponse.scala
Graph
Supertypes
trait GeneratedOneof
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
object Empty.type
class Heartbeat

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source:
Mirror.scala
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source:
Mirror.scala
type ValueType = A

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala

Value members

Concrete methods

def enumCompanionForFieldNumber(`__fieldNumber`: Int): GeneratedEnumCompanion[_]
def javaDescriptor: Descriptor

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Attributes

Source:
ReadChangeStreamResponse.scala
def messageCompanionForFieldNumber(`__number`: Int): GeneratedMessageCompanion[_]
def parseFrom(`_input__`: CodedInputStream): ReadChangeStreamResponse

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

Source:
ReadChangeStreamResponse.scala
def scalaDescriptor: Descriptor

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def fromAscii(s: String): A

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def merge(a: ReadChangeStreamResponse, input: CodedInputStream): A

Merges the given message with the additional fields in the steam.

Merges the given message with the additional fields in the steam.

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def parseDelimitedFrom(input: InputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def parseDelimitedFrom(input: CodedInputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def parseFrom(s: Array[Byte]): A

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def parseFrom(input: InputStream): A

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def streamFromDelimitedInput(input: InputStream): Stream[A]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def toByteArray(a: ReadChangeStreamResponse): Array[Byte]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def validate(s: Array[Byte]): Try[A]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala
def validateAscii(s: String): Either[TextFormatError, A]

Attributes

Inherited from:
GeneratedMessageCompanion
Source:
GeneratedMessageCompanion.scala

Concrete fields

lazy val nestedMessagesCompanions: Seq[GeneratedMessageCompanion[_ <: GeneratedMessage]]

Implicits

Implicits

final implicit def ReadChangeStreamResponseLens[UpperPB](_l: Lens[UpperPB, ReadChangeStreamResponse]): ReadChangeStreamResponseLens[UpperPB]
implicit def messageCompanion: GeneratedMessageCompanion[ReadChangeStreamResponse]
Generated with