Class SeekRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SeekRequestOrBuilder, Serializable

    public final class SeekRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements SeekRequestOrBuilder
     Request for the `Seek` method.
     
    Protobuf type google.pubsub.v1.SeekRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SeekRequest.Builder
      Request for the `Seek` method.
      static class  SeekRequest.TargetCase  
      • 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 int SNAPSHOT_FIELD_NUMBER  
      static int SUBSCRIPTION_FIELD_NUMBER  
      static int TIME_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 Detail

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

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

        public String getSubscription()
         Required. The subscription to affect.
         
        string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSubscription in interface SeekRequestOrBuilder
        Returns:
        The subscription.
      • getSubscriptionBytes

        public com.google.protobuf.ByteString getSubscriptionBytes()
         Required. The subscription to affect.
         
        string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSubscriptionBytes in interface SeekRequestOrBuilder
        Returns:
        The bytes for subscription.
      • hasTime

        public boolean hasTime()
         The time to seek to.
         Messages retained in the subscription that were published before this
         time are marked as acknowledged, and messages retained in the
         subscription that were published after this time are marked as
         unacknowledged. Note that this operation affects only those messages
         retained in the subscription (configured by the combination of
         `message_retention_duration` and `retain_acked_messages`). For example,
         if `time` corresponds to a point before the message retention
         window (or to a point before the system's notion of the subscription
         creation time), only retained messages will be marked as unacknowledged,
         and already-expunged messages will not be restored.
         
        .google.protobuf.Timestamp time = 2;
        Specified by:
        hasTime in interface SeekRequestOrBuilder
        Returns:
        Whether the time field is set.
      • getTime

        public com.google.protobuf.Timestamp getTime()
         The time to seek to.
         Messages retained in the subscription that were published before this
         time are marked as acknowledged, and messages retained in the
         subscription that were published after this time are marked as
         unacknowledged. Note that this operation affects only those messages
         retained in the subscription (configured by the combination of
         `message_retention_duration` and `retain_acked_messages`). For example,
         if `time` corresponds to a point before the message retention
         window (or to a point before the system's notion of the subscription
         creation time), only retained messages will be marked as unacknowledged,
         and already-expunged messages will not be restored.
         
        .google.protobuf.Timestamp time = 2;
        Specified by:
        getTime in interface SeekRequestOrBuilder
        Returns:
        The time.
      • getTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getTimeOrBuilder()
         The time to seek to.
         Messages retained in the subscription that were published before this
         time are marked as acknowledged, and messages retained in the
         subscription that were published after this time are marked as
         unacknowledged. Note that this operation affects only those messages
         retained in the subscription (configured by the combination of
         `message_retention_duration` and `retain_acked_messages`). For example,
         if `time` corresponds to a point before the message retention
         window (or to a point before the system's notion of the subscription
         creation time), only retained messages will be marked as unacknowledged,
         and already-expunged messages will not be restored.
         
        .google.protobuf.Timestamp time = 2;
        Specified by:
        getTimeOrBuilder in interface SeekRequestOrBuilder
      • hasSnapshot

        public boolean hasSnapshot()
         The snapshot to seek to. The snapshot's topic must be the same as that of
         the provided subscription.
         Format is `projects/{project}/snapshots/{snap}`.
         
        string snapshot = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasSnapshot in interface SeekRequestOrBuilder
        Returns:
        Whether the snapshot field is set.
      • getSnapshot

        public String getSnapshot()
         The snapshot to seek to. The snapshot's topic must be the same as that of
         the provided subscription.
         Format is `projects/{project}/snapshots/{snap}`.
         
        string snapshot = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSnapshot in interface SeekRequestOrBuilder
        Returns:
        The snapshot.
      • getSnapshotBytes

        public com.google.protobuf.ByteString getSnapshotBytes()
         The snapshot to seek to. The snapshot's topic must be the same as that of
         the provided subscription.
         Format is `projects/{project}/snapshots/{snap}`.
         
        string snapshot = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSnapshotBytes in interface SeekRequestOrBuilder
        Returns:
        The bytes for snapshot.
      • 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 SeekRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static SeekRequest parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static SeekRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected SeekRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static SeekRequest getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<SeekRequest> parser()
      • getParserForType

        public com.google.protobuf.Parser<SeekRequest> 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 SeekRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder