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

The name of the snapshot.

topic

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

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).

Annotations
@SerialVersionUID()
Source
Snapshot.scala
Linear Supertypes
Updatable[Snapshot], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Snapshot
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

    The name of the snapshot.

    topic

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

    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).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllLabels(__vs: Iterable[(String, String)]): Snapshot
  5. def addLabels(__vs: (String, String)*): Snapshot
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearExpireTime: Snapshot
  8. def clearLabels: Snapshot
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def companion: Snapshot.type
    Definition Classes
    Snapshot → GeneratedMessage
  11. def discardUnknownFields: Snapshot
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val expireTime: Option[Timestamp]
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getExpireTime: Timestamp
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Snapshot → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Snapshot → GeneratedMessage
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val labels: Map[String, String]
  21. val name: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def serializedSize: Int
    Definition Classes
    Snapshot → GeneratedMessage
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  29. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  30. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  31. def toProtoString: String
    Definition Classes
    Snapshot → GeneratedMessage
  32. val topic: String
  33. val unknownFields: UnknownFieldSet
  34. def update(ms: (Lens[Snapshot, Snapshot]) => Mutation[Snapshot]*): Snapshot
    Definition Classes
    Updatable
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. def withExpireTime(__v: Timestamp): Snapshot
  39. def withLabels(__v: Map[String, String]): Snapshot
  40. def withName(__v: String): Snapshot
  41. def withTopic(__v: String): Snapshot
  42. def withUnknownFields(__v: UnknownFieldSet): Snapshot
  43. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  44. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Snapshot → GeneratedMessage
  45. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[Snapshot]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped