final case class Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Snapshot] with Product with Serializable
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.
- name
Optional. The name of the snapshot.
- topic
Optional. The name of the topic from which this snapshot is retaining messages.
- expireTime
Optional. 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
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
- Annotations
- @SerialVersionUID()
- Source
- Snapshot.scala
- Alphabetic
- By Inheritance
- Snapshot
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- name
Optional. The name of the snapshot.
- topic
Optional. The name of the topic from which this snapshot is retaining messages.
- expireTime
Optional. 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
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllLabels(__vs: Iterable[(String, String)]): Snapshot
- def addLabels(__vs: (String, String)*): Snapshot
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearExpireTime: Snapshot
- def clearLabels: Snapshot
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: Snapshot.type
- Definition Classes
- Snapshot → GeneratedMessage
- def discardUnknownFields: Snapshot
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val expireTime: Option[Timestamp]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getExpireTime: Timestamp
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Snapshot → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Snapshot → GeneratedMessage
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val labels: Map[String, String]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- Snapshot → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- Snapshot → GeneratedMessage
- val topic: String
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Snapshot, Snapshot]) => Mutation[Snapshot]*): Snapshot
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withExpireTime(__v: Timestamp): Snapshot
- def withLabels(__v: Map[String, String]): Snapshot
- def withName(__v: String): Snapshot
- def withTopic(__v: String): Snapshot
- def withUnknownFields(__v: UnknownFieldSet): Snapshot
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Snapshot → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage