Package com.salesforce.eventbus.protobuf

Class FetchRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<FetchRequest.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
com.salesforce.eventbus.protobuf.FetchRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FetchRequestOrBuilder, Cloneable
Enclosing class:
FetchRequest
public static final class FetchRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder> 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

  • Method Details

    • 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.Builder<FetchRequest.Builder>

    • clear

      public FetchRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public FetchRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • setField

      public FetchRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • clearField

      public FetchRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • clearOneof

      public FetchRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • setRepeatedField

      public FetchRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • addRepeatedField

      public FetchRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • mergeFrom

      public FetchRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FetchRequest.Builder>

    • mergeFrom

      public FetchRequest.Builder mergeFrom(FetchRequest other)

    • isInitialized

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

    • mergeFrom

      public FetchRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FetchRequest.Builder>
      Throws:
      IOException

    • 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.

    • setTopicName

      public FetchRequest.Builder setTopicName(String value)
      
 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;
      Parameters:
      value - The topicName to set.
      Returns:
      This builder for chaining.

    • clearTopicName

      public FetchRequest.Builder clearTopicName()
      
 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;
      Returns:
      This builder for chaining.

    • setTopicNameBytes

      public FetchRequest.Builder setTopicNameBytes(com.google.protobuf.ByteString value)
      
 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;
      Parameters:
      value - The bytes for topicName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setReplayPresetValue

      public FetchRequest.Builder setReplayPresetValue(int value)
      
 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;
      Parameters:
      value - The enum numeric value on the wire for replayPreset to set.
      Returns:
      This builder for chaining.

    • 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.

    • setReplayPreset

      public FetchRequest.Builder setReplayPreset(ReplayPreset value)
      
 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;
      Parameters:
      value - The replayPreset to set.
      Returns:
      This builder for chaining.

    • clearReplayPreset

      public FetchRequest.Builder clearReplayPreset()
      
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setReplayId

      public FetchRequest.Builder setReplayId(com.google.protobuf.ByteString value)
      
 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;
      Parameters:
      value - The replayId to set.
      Returns:
      This builder for chaining.

    • clearReplayId

      public FetchRequest.Builder clearReplayId()
      
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setNumRequested

      public FetchRequest.Builder setNumRequested(int value)
      
 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;
      Parameters:
      value - The numRequested to set.
      Returns:
      This builder for chaining.

    • clearNumRequested

      public FetchRequest.Builder clearNumRequested()
      
 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;
      Returns:
      This builder for chaining.

    • 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.

    • setAuthRefresh

      public FetchRequest.Builder setAuthRefresh(String value)
       For internal Salesforce use only.
      string auth_refresh = 5;
      Parameters:
      value - The authRefresh to set.
      Returns:
      This builder for chaining.

    • clearAuthRefresh

      public FetchRequest.Builder clearAuthRefresh()
       For internal Salesforce use only.
      string auth_refresh = 5;
      Returns:
      This builder for chaining.

    • setAuthRefreshBytes

      public FetchRequest.Builder setAuthRefreshBytes(com.google.protobuf.ByteString value)
       For internal Salesforce use only.
      string auth_refresh = 5;
      Parameters:
      value - The bytes for authRefresh to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final FetchRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>

    • mergeUnknownFields

      public final FetchRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>