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.

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

Linear Supertypes

Product, Equals, Updatable[Snapshot], Message[Snapshot], GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = ...)

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

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def companion: Snapshot.type

Definition Classes
Snapshot → GeneratedMessage
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val expireTime: Option[Timestamp]

The snapshot is guaranteed to exist up until this time.
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.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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]

See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
def mergeFrom(_input__: CodedInputStream): Snapshot

Definition Classes
Snapshot → Message
val name: String

The name of the snapshot.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def serializedSize: Int

Definition Classes
Snapshot → GeneratedMessage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
def toProtoString: String

Definition Classes
Snapshot → GeneratedMessage
val topic: String

The name of the topic from which this snapshot is retaining messages.
def update(ms: (Lens[Snapshot, Snapshot]) ⇒ Mutation[Snapshot]*): Snapshot

Definition Classes
Updatable
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withExpireTime(__v: Timestamp): Snapshot
def withLabels(__v: Map[String, String]): Snapshot
def withName(__v: String): Snapshot
def withTopic(__v: String): Snapshot
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
Snapshot → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Related Docs: object Snapshot | package pubsub

final case class Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = ...) extends GeneratedMessage with Message[Snapshot] with Updatable[Snapshot] with Product with Serializable

Instance Constructors

new Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = ...)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllLabels(__vs: Iterable[(String, String)]): Snapshot

def addLabels(__vs: (String, String)*): Snapshot

final def asInstanceOf[T0]: T0

def clearExpireTime: Snapshot

def clearLabels: Snapshot

def clone(): AnyRef

def companion: Snapshot.type

final def eq(arg0: AnyRef): Boolean

val expireTime: Option[Timestamp]

def finalize(): Unit

final def getClass(): Class[_]

def getExpireTime: Timestamp

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

final def isInstanceOf[T0]: Boolean

val labels: Map[String, String]

def mergeFrom(_input__: CodedInputStream): Snapshot

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def serializedSize: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

val topic: String

def update(ms: (Lens[Snapshot, Snapshot]) ⇒ Mutation[Snapshot]*): Snapshot

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withExpireTime(__v: Timestamp): Snapshot

def withLabels(__v: Map[String, String]): Snapshot

def withName(__v: String): Snapshot

def withTopic(__v: String): Snapshot

def writeDelimitedTo(output: OutputStream): Unit

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

def getField(field: FieldDescriptor): Any

Inherited from Product

Inherited from Equals

Inherited from Updatable[Snapshot]

Inherited from Message[Snapshot]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped