Package com.google.pubsub.v1

Class Snapshot

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.pubsub.v1.Snapshot
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SnapshotOrBuilder, Serializable
public final class Snapshot extends com.google.protobuf.GeneratedMessageV3 implements 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Snapshot.Builder
    A snapshot resource.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXPIRE_TIME_FIELD_NUMBER
     
    static final int
    LABELS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TOPIC_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    boolean
    equals(Object obj)
     
    static Snapshot
    getDefaultInstance()
     
    Snapshot
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Timestamp
    getExpireTime()
    The snapshot is guaranteed to exist up until this time.
    com.google.protobuf.TimestampOrBuilder
    getExpireTimeOrBuilder()
    The snapshot is guaranteed to exist up until this time.
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    Map<String,String>
    getLabelsMap()
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getLabelsOrDefault(String key, String defaultValue)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getLabelsOrThrow(String key)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getName()
    The name of the snapshot.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the snapshot.
    com.google.protobuf.Parser<Snapshot>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTopic()
    The name of the topic from which this snapshot is retaining messages.
    com.google.protobuf.ByteString
    getTopicBytes()
    The name of the topic from which this snapshot is retaining messages.
    boolean
    hasExpireTime()
    The snapshot is guaranteed to exist up until this time.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapField
    internalGetMapField(int number)
     
    final boolean
    isInitialized()
     
    static Snapshot.Builder
    newBuilder()
     
    static Snapshot.Builder
    newBuilder(Snapshot prototype)
     
    Snapshot.Builder
    newBuilderForType()
     
    protected Snapshot.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Snapshot
    parseDelimitedFrom(InputStream input)
     
    static Snapshot
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(byte[] data)
     
    static Snapshot
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(com.google.protobuf.ByteString data)
     
    static Snapshot
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Snapshot
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(InputStream input)
     
    static Snapshot
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Snapshot
    parseFrom(ByteBuffer data)
     
    static Snapshot
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Snapshot>
    parser()
     
    Snapshot.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public String getName()
       The name of the snapshot.
      string name = 1;
      Specified by:
      getName in interface SnapshotOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the snapshot.
      string name = 1;
      Specified by:
      getNameBytes in interface SnapshotOrBuilder
      Returns:
      The bytes for name.

    • getTopic

      public String getTopic()
       The name of the topic from which this snapshot is retaining messages.
      string topic = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getTopic in interface SnapshotOrBuilder
      Returns:
      The topic.

    • getTopicBytes

      public com.google.protobuf.ByteString getTopicBytes()
       The name of the topic from which this snapshot is retaining messages.
      string topic = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getTopicBytes in interface SnapshotOrBuilder
      Returns:
      The bytes for topic.

    • hasExpireTime

      public boolean hasExpireTime()
       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;
      Specified by:
      hasExpireTime in interface SnapshotOrBuilder
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      public com.google.protobuf.Timestamp getExpireTime()
       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;
      Specified by:
      getExpireTime in interface SnapshotOrBuilder
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       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;
      Specified by:
      getExpireTimeOrBuilder in interface SnapshotOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: SnapshotOrBuilder
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 4;
      Specified by:
      getLabelsCount in interface SnapshotOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 4;
      Specified by:
      containsLabels in interface SnapshotOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface SnapshotOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 4;
      Specified by:
      getLabelsMap in interface SnapshotOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 4;
      Specified by:
      getLabelsOrDefault in interface SnapshotOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 4;
      Specified by:
      getLabelsOrThrow in interface SnapshotOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Snapshot parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Snapshot parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Snapshot parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Snapshot parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Snapshot parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Snapshot parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Snapshot parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Snapshot.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Snapshot.Builder newBuilder()

    • newBuilder

      public static Snapshot.Builder newBuilder(Snapshot prototype)

    • toBuilder

      public Snapshot.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Snapshot.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Snapshot getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Snapshot> parser()

    • getParserForType

      public com.google.protobuf.Parser<Snapshot> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Snapshot getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder