Package com.salesforce.eventbus.protobuf

Class FetchResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.salesforce.eventbus.protobuf.FetchResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FetchResponseOrBuilder, Serializable
public final class FetchResponse extends com.google.protobuf.GeneratedMessageV3 implements FetchResponseOrBuilder

 Response for the Subscribe streaming RPC method. This returns ConsumerEvent(s).
 If there are no events to deliver, the server sends an empty batch fetch response with the latest replay ID. The
 empty fetch response is sent within 270 seconds. An empty fetch response provides a periodic keepalive from the
 server and the latest replay ID.
Protobuf type eventbus.v1.FetchResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FetchResponse.Builder
    Response for the Subscribe streaming RPC method.

    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
    EVENTS_FIELD_NUMBER
     
    static final int
    LATEST_REPLAY_ID_FIELD_NUMBER
     
    static final int
    PENDING_NUM_REQUESTED_FIELD_NUMBER
     
    static final int
    RPC_ID_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
    equals(Object obj)
     
    static FetchResponse
    getDefaultInstance()
     
    FetchResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ConsumerEvent
    getEvents(int index)
    Received events for subscription for client consumption
    int
    getEventsCount()
    Received events for subscription for client consumption
    List<ConsumerEvent>
    getEventsList()
    Received events for subscription for client consumption
    ConsumerEventOrBuilder
    getEventsOrBuilder(int index)
    Received events for subscription for client consumption
    List<? extends ConsumerEventOrBuilder>
    getEventsOrBuilderList()
    Received events for subscription for client consumption
    com.google.protobuf.ByteString
    getLatestReplayId()
    Latest replay ID of a subscription.
    com.google.protobuf.Parser<FetchResponse>
    getParserForType()
     
    int
    getPendingNumRequested()
    Number of remaining events to be delivered to the client for a Subscribe RPC call.
    String
    getRpcId()
    RPC ID used to trace errors.
    com.google.protobuf.ByteString
    getRpcIdBytes()
    RPC ID used to trace errors.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FetchResponse.Builder
    newBuilder()
     
    static FetchResponse.Builder
    newBuilder(FetchResponse prototype)
     
    FetchResponse.Builder
    newBuilderForType()
     
    protected FetchResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FetchResponse
    parseDelimitedFrom(InputStream input)
     
    static FetchResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchResponse
    parseFrom(byte[] data)
     
    static FetchResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static FetchResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FetchResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchResponse
    parseFrom(InputStream input)
     
    static FetchResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchResponse
    parseFrom(ByteBuffer data)
     
    static FetchResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FetchResponse>
    parser()
     
    FetchResponse.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, internalGetMapField, 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

    • EVENTS_FIELD_NUMBER

      public static final int EVENTS_FIELD_NUMBER
      See Also:

    • LATEST_REPLAY_ID_FIELD_NUMBER

      public static final int LATEST_REPLAY_ID_FIELD_NUMBER
      See Also:

    • RPC_ID_FIELD_NUMBER

      public static final int RPC_ID_FIELD_NUMBER
      See Also:

    • PENDING_NUM_REQUESTED_FIELD_NUMBER

      public static final int PENDING_NUM_REQUESTED_FIELD_NUMBER
      See Also:

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

    • internalGetFieldAccessorTable

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

    • getEventsList

      public List<ConsumerEvent> getEventsList()
       Received events for subscription for client consumption
      repeated .eventbus.v1.ConsumerEvent events = 1;
      Specified by:
      getEventsList in interface FetchResponseOrBuilder

    • getEventsOrBuilderList

      public List<? extends ConsumerEventOrBuilder> getEventsOrBuilderList()
       Received events for subscription for client consumption
      repeated .eventbus.v1.ConsumerEvent events = 1;
      Specified by:
      getEventsOrBuilderList in interface FetchResponseOrBuilder

    • getEventsCount

      public int getEventsCount()
       Received events for subscription for client consumption
      repeated .eventbus.v1.ConsumerEvent events = 1;
      Specified by:
      getEventsCount in interface FetchResponseOrBuilder

    • getEvents

      public ConsumerEvent getEvents(int index)
       Received events for subscription for client consumption
      repeated .eventbus.v1.ConsumerEvent events = 1;
      Specified by:
      getEvents in interface FetchResponseOrBuilder

    • getEventsOrBuilder

      public ConsumerEventOrBuilder getEventsOrBuilder(int index)
       Received events for subscription for client consumption
      repeated .eventbus.v1.ConsumerEvent events = 1;
      Specified by:
      getEventsOrBuilder in interface FetchResponseOrBuilder

    • getLatestReplayId

      public com.google.protobuf.ByteString getLatestReplayId()
       Latest replay ID of a subscription. Enables clients with an updated replay value so that they can keep track
 of their last consumed replay. Clients will not have to start a subscription at a very old replay in the case where a resubscribe is necessary.
      bytes latest_replay_id = 2;
      Specified by:
      getLatestReplayId in interface FetchResponseOrBuilder
      Returns:
      The latestReplayId.

    • getRpcId

      public String getRpcId()
       RPC ID used to trace errors.
      string rpc_id = 3;
      Specified by:
      getRpcId in interface FetchResponseOrBuilder
      Returns:
      The rpcId.

    • getRpcIdBytes

      public com.google.protobuf.ByteString getRpcIdBytes()
       RPC ID used to trace errors.
      string rpc_id = 3;
      Specified by:
      getRpcIdBytes in interface FetchResponseOrBuilder
      Returns:
      The bytes for rpcId.

    • getPendingNumRequested

      public int getPendingNumRequested()
       Number of remaining events to be delivered to the client for a Subscribe RPC call.
      int32 pending_num_requested = 4;
      Specified by:
      getPendingNumRequested in interface FetchResponseOrBuilder
      Returns:
      The pendingNumRequested.

    • 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 FetchResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FetchResponse.Builder newBuilder()

    • newBuilder

      public static FetchResponse.Builder newBuilder(FetchResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FetchResponse getDefaultInstance()

    • parser

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

    • getParserForType

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