proto-google-cloud-pubsub-v1-scalapb_0.11/com.google.pubsub.v1.pubsub/Snapshot

Snapshot

@SerialVersionUID(0L) final case
class Snapshot(name: String, topic: String, expireTime: Option[Timestamp], labels: Map[String, String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Snapshot]

A snapshot resource. Snapshots are used in Seek 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 Params
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.

Companion
object
trait Updatable[Snapshot]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addAllLabels(`__vs`: Iterable[(String, String)]): Snapshot
def addLabels(`__vs`: (String, String)*): Snapshot
def getExpireTime: Timestamp
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override
def serializedSize: Int
Definition Classes
GeneratedMessage
def toProtoString: String
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
def writeTo(`_output__`: CodedOutputStream): Unit

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
final
def toByteArray: Array[Byte]

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

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

Inherited from
GeneratedMessage
final
def toByteString: ByteString

Serializes the messgae and returns a ByteString containing its raw bytes

Serializes the messgae and returns a ByteString containing its raw bytes

Inherited from
GeneratedMessage
final
def toPMessage: PMessage
Inherited from
GeneratedMessage
def update(ms: Lens[Snapshot, Snapshot] => () => Snapshot*): Snapshot
Inherited from
Updatable
final
def writeDelimitedTo(output: OutputStream): Unit
Inherited from
GeneratedMessage
final
def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Inherited from
GeneratedMessage