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 Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
For internal Salesforce use only.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) Number of events a client is ready to accept.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) If replay_preset of CUSTOM is selected, specify the subscription point to start after.Subscription starting point.Identifies a topic for subscription in the very first FetchRequest of the stream.clone()
For internal Salesforce use only.com.google.protobuf.ByteString
For internal Salesforce use only.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
int
Number of events a client is ready to accept.com.google.protobuf.ByteString
If replay_preset of CUSTOM is selected, specify the subscription point to start after.Subscription starting point.int
Subscription starting point.Identifies a topic for subscription in the very first FetchRequest of the stream.com.google.protobuf.ByteString
Identifies a topic for subscription in the very first FetchRequest of the stream.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(FetchRequest other) final FetchRequest.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) setAuthRefresh
(String value) For internal Salesforce use only.setAuthRefreshBytes
(com.google.protobuf.ByteString value) For internal Salesforce use only.setNumRequested
(int value) Number of events a client is ready to accept.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setReplayId
(com.google.protobuf.ByteString value) If replay_preset of CUSTOM is selected, specify the subscription point to start after.setReplayPreset
(ReplayPreset value) Subscription starting point.setReplayPresetValue
(int value) Subscription starting point.setTopicName
(String value) Identifies a topic for subscription in the very first FetchRequest of the stream.setTopicNameBytes
(com.google.protobuf.ByteString value) Identifies a topic for subscription in the very first FetchRequest of the stream.final FetchRequest.Builder
setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
setField
public FetchRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
addRepeatedField
public FetchRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FetchRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FetchRequest.Builder>
- Throws:
IOException
-
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 interfaceFetchRequestOrBuilder
- 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 interfaceFetchRequestOrBuilder
- Returns:
- The bytes for topicName.
-
setTopicName
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
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
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 interfaceFetchRequestOrBuilder
- Returns:
- The enum numeric value on the wire for replayPreset.
-
setReplayPresetValue
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
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 interfaceFetchRequestOrBuilder
- Returns:
- The replayPreset.
-
setReplayPreset
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
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 interfaceFetchRequestOrBuilder
- Returns:
- The replayId.
-
setReplayId
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
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 interfaceFetchRequestOrBuilder
- Returns:
- The numRequested.
-
setNumRequested
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
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
For internal Salesforce use only.
string auth_refresh = 5;
- Specified by:
getAuthRefresh
in interfaceFetchRequestOrBuilder
- Returns:
- The authRefresh.
-
getAuthRefreshBytes
public com.google.protobuf.ByteString getAuthRefreshBytes()For internal Salesforce use only.
string auth_refresh = 5;
- Specified by:
getAuthRefreshBytes
in interfaceFetchRequestOrBuilder
- Returns:
- The bytes for authRefresh.
-
setAuthRefresh
For internal Salesforce use only.
string auth_refresh = 5;
- Parameters:
value
- The authRefresh to set.- Returns:
- This builder for chaining.
-
clearAuthRefresh
For internal Salesforce use only.
string auth_refresh = 5;
- Returns:
- This builder for chaining.
-
setAuthRefreshBytes
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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-
mergeUnknownFields
public final FetchRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FetchRequest.Builder>
-