Packages

final class Snapshot extends GeneratedMessageV3 with SnapshotOrBuilder

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.

Protobuf type google.pubsub.v1.Snapshot

Source
Snapshot.java
Linear Supertypes
SnapshotOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Snapshot
  2. SnapshotOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def containsLabels(key: String): Boolean

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


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

    map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: AnyRef): Boolean
    Definition Classes
    Snapshot → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getDefaultInstanceForType(): Snapshot
    Definition Classes
    Snapshot → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getExpireTime(): Timestamp

    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.


    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.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The expireTime.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  16. def getExpireTimeOrBuilder(): TimestampOrBuilder

    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.


    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.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  17. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getLabelsCount(): Int

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


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

    map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
  20. def getLabelsMap(): Map[String, String]

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


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

    map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  21. def getLabelsOrDefault(key: String, defaultValue: String): String

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


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

    map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  22. def getLabelsOrThrow(key: String): String

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


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

    map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  23. def getName(): String

    Optional. The name of the snapshot.


    Optional. The name of the snapshot.

    string name = 1 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The name.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  24. def getNameBytes(): ByteString

    Optional. The name of the snapshot.


    Optional. The name of the snapshot.

    string name = 1 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for name.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  25. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  26. def getParserForType(): Parser[Snapshot]
    Definition Classes
    Snapshot → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  27. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  28. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def getSerializedSize(): Int
    Definition Classes
    Snapshot → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  30. def getTopic(): String

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


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

    string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

    returns

    The topic.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  31. def getTopicBytes(): ByteString

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


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

    string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

    returns

    The bytes for topic.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  32. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. def hasExpireTime(): Boolean

    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.


    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.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the expireTime field is set.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override()
  34. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  35. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  36. def hashCode(): Int
    Definition Classes
    Snapshot → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  37. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    Snapshot → GeneratedMessageV3
    Annotations
    @Override()
  38. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  39. def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
    Attributes
    protected[v1]
    Annotations
    @SuppressWarnings() @Override()
  40. final def isInitialized(): Boolean
    Definition Classes
    Snapshot → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    Snapshot → GeneratedMessageV3
    Annotations
    @Override()
  45. def newBuilderForType(): Builder
    Definition Classes
    Snapshot → Message → MessageLite
    Annotations
    @Override()
  46. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  47. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    Snapshot → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  51. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toBuilder(): Builder
    Definition Classes
    Snapshot → Message → MessageLite
    Annotations
    @Override()
  54. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  55. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  56. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  61. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  62. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Snapshot → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  63. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Definition Classes
    Snapshot → SnapshotOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from SnapshotOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped