Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CommandParams

Interface for objects that represent a collection of valid key-value pairs of parameters that can be set withing a convenience method like Client.subscribe, Client.sow, etc.

See Command class for detailed descriptions of the parameters.

Hierarchy

  • CommandParams

Indexable

[key: string]: any

Interface for objects that represent a collection of valid key-value pairs of parameters that can be set withing a convenience method like Client.subscribe, Client.sow, etc.

See Command class for detailed descriptions of the parameters.

Index

Properties

Optional ackType

ackType: string

The acknowledgements requested for the command. Multiple ack types should be comma-delimited. The acknowledgement messages will be delivered to the message handler.

Optional batchSize

batchSize: number

The number of messages that are batched together when returning a query result. If it's not set, it is 10 by default.

Optional bookmark

bookmark: string

The client-originated identifier used to mark a location in journaled messages.

Optional command

command: string

The command e.g. 'publish', 'sow_and_subscribe', to be executed. The following commands are available:

  • publish
  • delta_publish
  • subscribe
  • delta_subscribe
  • sow
  • sow_and_subscribe
  • sow_and_delta_subscribe
  • sow_delete
  • unsubscribe

Optional commandId

commandId: string

The Client-specified command id. The command id is returned by the engine in responses to commands to allow the client to correlate the response to the command.

Optional correlationId

correlationId: string

The opaque token set by an application and returned with the message.

Optional data

data: any

The command data (message payload). Makes sense only for publish, delta_publish, and sow_delete commands.

Optional expiration

expiration: number

The SOW expiration time (in seconds) if used in publish.

Optional filter

filter: string

The content filter expression.

Optional options

options: string

The (comma-delimited) string of options on a specific Command.

Optional orderBy

orderBy: string

The SOW topic key(s) by which to order SOW query.

Optional queryId

queryId: string

The SOW Query identifier set by client to identify a query.

Optional sequenceId

sequenceId: BigInteger

The sequenceId value. SequenceId is an integer that corresponds to the publish message sequence number. For more information see the Replication section in the User Guide.

Optional sowKey

sowKey: string

The sow key value. A SOW key will accompany each message returned in an SOW batch. A SowKey may also be added to messages coming in on a subscription when the published message matches a record in the SOW.

Format:

  • string containing the digits of an unsigned long for AMPS-generated SOW keys

OR

  • arbitrary string in the base64 character set for user-provided SOW keys.

Optional sowKeys

sowKeys: string

The sowKeys as a comma-delimited value.

Optional subId

subId: string

The subscription identifier set by server when processing a subscription.

Optional subIds

subIds: string

The subIds - a comma-separated list of subscription ids sent from AMPS engine to identify which client subscriptions match a given publish message.

Optional topN

topN: number

The number of records to return.

deprecated

provide the top_n=<value> value as a part of the options field instead.

Note: If TopN is not equally divisible by the BatchSize value, then more records will be returned so that the total number of records is equally divisible by the BatchSize setting.

Optional topic

topic: string

The topic value.