new UpdatePersistentSubscription(propertiesopt)
Constructs a new UpdatePersistentSubscription.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.UpdatePersistentSubscription$Properties |
<optional> |
Properties to set |
- Source:
Members
bufferSize :number
UpdatePersistentSubscription bufferSize.
Type:
- number
- Source:
checkpointAfterTime :number
UpdatePersistentSubscription checkpointAfterTime.
Type:
- number
- Source:
checkpointMaxCount :number
UpdatePersistentSubscription checkpointMaxCount.
Type:
- number
- Source:
checkpointMinCount :number
UpdatePersistentSubscription checkpointMinCount.
Type:
- number
- Source:
eventStreamId :string
UpdatePersistentSubscription eventStreamId.
Type:
- string
- Source:
liveBufferSize :number
UpdatePersistentSubscription liveBufferSize.
Type:
- number
- Source:
maxRetryCount :number
UpdatePersistentSubscription maxRetryCount.
Type:
- number
- Source:
messageTimeoutMilliseconds :number
UpdatePersistentSubscription messageTimeoutMilliseconds.
Type:
- number
- Source:
namedConsumerStrategy :string
UpdatePersistentSubscription namedConsumerStrategy.
Type:
- string
- Source:
preferRoundRobin :boolean
UpdatePersistentSubscription preferRoundRobin.
Type:
- boolean
- Source:
readBatchSize :number
UpdatePersistentSubscription readBatchSize.
Type:
- number
- Source:
recordStatistics :boolean
UpdatePersistentSubscription recordStatistics.
Type:
- boolean
- Source:
resolveLinkTos :boolean
UpdatePersistentSubscription resolveLinkTos.
Type:
- boolean
- Source:
startFrom :number
UpdatePersistentSubscription startFrom.
Type:
- number
- Source:
subscriberMaxCount :number
UpdatePersistentSubscription subscriberMaxCount.
Type:
- number
- Source:
subscriptionGroupName :string
UpdatePersistentSubscription subscriptionGroupName.
Type:
- string
- Source:
Methods
(static) create(propertiesopt) → {EventStore.Client.Messages.UpdatePersistentSubscription}
Creates a new UpdatePersistentSubscription instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.UpdatePersistentSubscription$Properties |
<optional> |
Properties to set |
- Source:
Returns:
UpdatePersistentSubscription instance
(static) decode(reader, lengthopt) → {EventStore.Client.Messages.UpdatePersistentSubscription}
Decodes an UpdatePersistentSubscription message from the specified reader or buffer.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from | |
length |
number |
<optional> |
Message length if known beforehand |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
UpdatePersistentSubscription
(static) decodeDelimited(reader) → {EventStore.Client.Messages.UpdatePersistentSubscription}
Decodes an UpdatePersistentSubscription message from the specified reader or buffer, length delimited.
Parameters:
Name | Type | Description |
---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
UpdatePersistentSubscription
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified UpdatePersistentSubscription message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.UpdatePersistentSubscription$Properties | UpdatePersistentSubscription message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified UpdatePersistentSubscription message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.UpdatePersistentSubscription$Properties | UpdatePersistentSubscription message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) from(object) → {EventStore.Client.Messages.UpdatePersistentSubscription}
Creates an UpdatePersistentSubscription message from a plain object. Also converts values to their respective internal types.
This is an alias of EventStore.Client.Messages.UpdatePersistentSubscription.fromObject.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
UpdatePersistentSubscription
(static) fromObject(object) → {EventStore.Client.Messages.UpdatePersistentSubscription}
Creates an UpdatePersistentSubscription message from a plain object. Also converts values to their respective internal types.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
UpdatePersistentSubscription
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an UpdatePersistentSubscription message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.UpdatePersistentSubscription | UpdatePersistentSubscription | |
options |
$protobuf.ConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>
(static) verify(message) → (nullable) {string}
Verifies an UpdatePersistentSubscription message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object.<string, *> | Plain object to verify |
- Source:
Returns:
`null` if valid, otherwise the reason why it is not
- Type
- string
toJSON() → {Object.<string, *>}
Converts this UpdatePersistentSubscription to JSON.
- Source:
Returns:
JSON object
- Type
- Object.<string, *>
toObject(optionsopt) → {Object.<string, *>}
Creates a plain object from this UpdatePersistentSubscription message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
$protobuf.ConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>