Class: CreatePersistentSubscription

EventStore.Client.Messages.CreatePersistentSubscription(propertiesopt)

Represents a CreatePersistentSubscription.

Constructor

new CreatePersistentSubscription(propertiesopt)

Constructs a new CreatePersistentSubscription.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.ICreatePersistentSubscription <optional>
Properties to set
Implements:
  • ICreatePersistentSubscription
Source:

Members

bufferSize :number

CreatePersistentSubscription bufferSize.
Type:
  • number
Source:

checkpointAfterTime :number

CreatePersistentSubscription checkpointAfterTime.
Type:
  • number
Source:

checkpointMaxCount :number

CreatePersistentSubscription checkpointMaxCount.
Type:
  • number
Source:

checkpointMinCount :number

CreatePersistentSubscription checkpointMinCount.
Type:
  • number
Source:

eventStreamId :string

CreatePersistentSubscription eventStreamId.
Type:
  • string
Source:

liveBufferSize :number

CreatePersistentSubscription liveBufferSize.
Type:
  • number
Source:

maxRetryCount :number

CreatePersistentSubscription maxRetryCount.
Type:
  • number
Source:

messageTimeoutMilliseconds :number

CreatePersistentSubscription messageTimeoutMilliseconds.
Type:
  • number
Source:

namedConsumerStrategy :string

CreatePersistentSubscription namedConsumerStrategy.
Type:
  • string
Source:

preferRoundRobin :boolean

CreatePersistentSubscription preferRoundRobin.
Type:
  • boolean
Source:

readBatchSize :number

CreatePersistentSubscription readBatchSize.
Type:
  • number
Source:

recordStatistics :boolean

CreatePersistentSubscription recordStatistics.
Type:
  • boolean
Source:

resolveLinkTos :boolean

CreatePersistentSubscription resolveLinkTos.
Type:
  • boolean
Source:

startFrom :number|Long

CreatePersistentSubscription startFrom.
Type:
  • number | Long
Source:

subscriberMaxCount :number

CreatePersistentSubscription subscriberMaxCount.
Type:
  • number
Source:

subscriptionGroupName :string

CreatePersistentSubscription subscriptionGroupName.
Type:
  • string
Source:

Methods

(static) create(propertiesopt) → {EventStore.Client.Messages.CreatePersistentSubscription}

Creates a new CreatePersistentSubscription instance using the specified properties.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.ICreatePersistentSubscription <optional>
Properties to set
Source:
Returns:
CreatePersistentSubscription instance
Type
EventStore.Client.Messages.CreatePersistentSubscription

(static) decode(reader, lengthopt) → {EventStore.Client.Messages.CreatePersistentSubscription}

Decodes a CreatePersistentSubscription 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:
CreatePersistentSubscription
Type
EventStore.Client.Messages.CreatePersistentSubscription

(static) decodeDelimited(reader) → {EventStore.Client.Messages.CreatePersistentSubscription}

Decodes a CreatePersistentSubscription 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:
CreatePersistentSubscription
Type
EventStore.Client.Messages.CreatePersistentSubscription

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CreatePersistentSubscription message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ICreatePersistentSubscription CreatePersistentSubscription 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 CreatePersistentSubscription message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ICreatePersistentSubscription CreatePersistentSubscription message or plain object to encode
writer $protobuf.Writer <optional>
Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

(static) fromObject(object) → {EventStore.Client.Messages.CreatePersistentSubscription}

Creates a CreatePersistentSubscription message from a plain object. Also converts values to their respective internal types.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
CreatePersistentSubscription
Type
EventStore.Client.Messages.CreatePersistentSubscription

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a CreatePersistentSubscription message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.CreatePersistentSubscription CreatePersistentSubscription
options $protobuf.IConversionOptions <optional>
Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>

(static) verify(message) → {string|null}

Verifies a CreatePersistentSubscription 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 | null

toJSON() → {Object.<string, *>}

Converts this CreatePersistentSubscription to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>