Snapshot

com.google.pubsub.v1.pubsub.Snapshot
See theSnapshot companion object
final case class Snapshot(name: String, topic: String, expireTime: Option[Timestamp], labels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Snapshot]

A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Value parameters

expireTime

The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

labels

See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

name

The name of the snapshot.

topic

The name of the topic from which this snapshot is retaining messages.

Attributes

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

Members list

Value members

Concrete methods

Attributes

Source
Snapshot.scala
def addLabels(`__vs`: (String, String)*): Snapshot

Attributes

Source
Snapshot.scala

Attributes

Source
Snapshot.scala

Attributes

Source
Snapshot.scala
def companion: Snapshot.type

Attributes

Source
Snapshot.scala

Attributes

Source
Snapshot.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

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

Attributes

Source
Snapshot.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
Snapshot.scala

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
Snapshot.scala

Attributes

Source
Snapshot.scala

Attributes

Source
Snapshot.scala
def withName(`__v`: String): Snapshot

Attributes

Source
Snapshot.scala
def withTopic(`__v`: String): Snapshot

Attributes

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

Attributes

Source
Snapshot.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
Snapshot.scala

Inherited methods

Attributes

Inherited from:
Product

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
def update(ms: Lens[Snapshot, Snapshot] => () => Snapshot*): A

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