Package com.salesforce.eventbus.protobuf

Class FetchRequest

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

 Request for the Subscribe streaming RPC method. This request is used to:
 1. Establish the initial subscribe stream.
 2. Request more events from the subscription stream.
 Flow Control is handled by the subscriber via num_requested.
 A client can specify a starting point for the subscription with replay_preset and replay_id combinations.
 If no replay_preset is specified, the subscription starts at LATEST (tip of the stream).
 replay_preset and replay_id values are only consumed as part of the first FetchRequest. If
 a client needs to start at another point in the stream, it must start a new subscription.
Protobuf type eventbus.v1.FetchRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FetchRequest.Builder
    Request 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
    AUTH_REFRESH_FIELD_NUMBER
     
    static final int
    NUM_REQUESTED_FIELD_NUMBER
     
    static final int
    REPLAY_ID_FIELD_NUMBER
     
    static final int
    REPLAY_PRESET_FIELD_NUMBER
     
    static final int
    TOPIC_NAME_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)
     
    String
    getAuthRefresh()
    For internal Salesforce use only.
    com.google.protobuf.ByteString
    getAuthRefreshBytes()
    For internal Salesforce use only.
    static FetchRequest
    getDefaultInstance()
     
    FetchRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getNumRequested()
    Number of events a client is ready to accept.
    com.google.protobuf.Parser<FetchRequest>
    getParserForType()
     
    com.google.protobuf.ByteString
    getReplayId()
    If replay_preset of CUSTOM is selected, specify the subscription point to start after.
    ReplayPreset
    getReplayPreset()
    Subscription starting point.
    int
    getReplayPresetValue()
    Subscription starting point.
    int
    getSerializedSize()
     
    String
    getTopicName()
    Identifies a topic for subscription in the very first FetchRequest of the stream.
    com.google.protobuf.ByteString
    getTopicNameBytes()
    Identifies a topic for subscription in the very first FetchRequest of the stream.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FetchRequest.Builder
    newBuilder()
     
    static FetchRequest.Builder
    newBuilder(FetchRequest prototype)
     
    FetchRequest.Builder
    newBuilderForType()
     
    protected FetchRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FetchRequest
    parseDelimitedFrom(InputStream input)
     
    static FetchRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchRequest
    parseFrom(byte[] data)
     
    static FetchRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static FetchRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FetchRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchRequest
    parseFrom(InputStream input)
     
    static FetchRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FetchRequest
    parseFrom(ByteBuffer data)
     
    static FetchRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FetchRequest>
    parser()
     
    FetchRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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

    • TOPIC_NAME_FIELD_NUMBER

      public static final int TOPIC_NAME_FIELD_NUMBER
      See Also:

    • REPLAY_PRESET_FIELD_NUMBER

      public static final int REPLAY_PRESET_FIELD_NUMBER
      See Also:

    • REPLAY_ID_FIELD_NUMBER

      public static final int REPLAY_ID_FIELD_NUMBER
      See Also:

    • NUM_REQUESTED_FIELD_NUMBER

      public static final int NUM_REQUESTED_FIELD_NUMBER
      See Also:

    • AUTH_REFRESH_FIELD_NUMBER

      public static final int AUTH_REFRESH_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

    • getTopicName

      public String getTopicName()
      
 Identifies a topic for subscription in the very first FetchRequest of the stream. The topic cannot change
 in subsequent FetchRequests within the same subscribe stream, but can be omitted for efficiency.
      string topic_name = 1;
      Specified by:
      getTopicName in interface FetchRequestOrBuilder
      Returns:
      The topicName.

    • getTopicNameBytes

      public com.google.protobuf.ByteString getTopicNameBytes()
      
 Identifies a topic for subscription in the very first FetchRequest of the stream. The topic cannot change
 in subsequent FetchRequests within the same subscribe stream, but can be omitted for efficiency.
      string topic_name = 1;
      Specified by:
      getTopicNameBytes in interface FetchRequestOrBuilder
      Returns:
      The bytes for topicName.

    • getReplayPresetValue

      public int getReplayPresetValue()
      
 Subscription starting point. This is consumed only as part of the first FetchRequest
 when the subscription is set up.
      .eventbus.v1.ReplayPreset replay_preset = 2;
      Specified by:
      getReplayPresetValue in interface FetchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for replayPreset.

    • getReplayPreset

      public ReplayPreset getReplayPreset()
      
 Subscription starting point. This is consumed only as part of the first FetchRequest
 when the subscription is set up.
      .eventbus.v1.ReplayPreset replay_preset = 2;
      Specified by:
      getReplayPreset in interface FetchRequestOrBuilder
      Returns:
      The replayPreset.

    • getReplayId

      public com.google.protobuf.ByteString getReplayId()
      
 If replay_preset of CUSTOM is selected, specify the subscription point to start after.
 This is consumed only as part of the first FetchRequest when the subscription is set up.
      bytes replay_id = 3;
      Specified by:
      getReplayId in interface FetchRequestOrBuilder
      Returns:
      The replayId.

    • getNumRequested

      public int getNumRequested()
      
 Number of events a client is ready to accept. Each subsequent FetchRequest informs the server
 of additional processing capacity available on the client side. There is no guarantee of equal number of
 FetchResponse messages to be sent back. There is not necessarily a correspondence between
 number of requested events in FetchRequest and the number of events returned in subsequent
 FetchResponses.
      int32 num_requested = 4;
      Specified by:
      getNumRequested in interface FetchRequestOrBuilder
      Returns:
      The numRequested.

    • getAuthRefresh

      public String getAuthRefresh()
       For internal Salesforce use only.
      string auth_refresh = 5;
      Specified by:
      getAuthRefresh in interface FetchRequestOrBuilder
      Returns:
      The authRefresh.

    • getAuthRefreshBytes

      public com.google.protobuf.ByteString getAuthRefreshBytes()
       For internal Salesforce use only.
      string auth_refresh = 5;
      Specified by:
      getAuthRefreshBytes in interface FetchRequestOrBuilder
      Returns:
      The bytes for authRefresh.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FetchRequest.Builder newBuilder()

    • newBuilder

      public static FetchRequest.Builder newBuilder(FetchRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FetchRequest getDefaultInstance()

    • parser

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

    • getParserForType

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