Type alias MsgVpnQueueTemplate

MsgVpnQueueTemplate: {
    accessType?: MsgVpnQueueTemplate.accessType;
    consumerAckPropagationEnabled?: boolean;
    deadMsgQueue?: string;
    deliveryDelay?: number;
    durabilityOverride?: durabilityOverride;
    eventBindCountThreshold?: EventThreshold;
    eventMsgSpoolUsageThreshold?: EventThreshold;
    eventRejectLowPriorityMsgLimitThreshold?: EventThreshold;
    maxBindCount?: number;
    maxDeliveredUnackedMsgsPerFlow?: number;
    maxMsgSize?: number;
    maxMsgSpoolUsage?: number;
    maxRedeliveryCount?: number;
    maxTtl?: number;
    msgVpnName?: string;
    permission?: MsgVpnQueueTemplate.permission;
    queueNameFilter?: string;
    queueTemplateName?: string;
    redeliveryEnabled?: boolean;
    rejectLowPriorityMsgEnabled?: boolean;
    rejectLowPriorityMsgLimit?: number;
    rejectMsgToSenderOnDiscardBehavior?: MsgVpnQueueTemplate.rejectMsgToSenderOnDiscardBehavior;
    respectMsgPriorityEnabled?: boolean;
    respectTtlEnabled?: boolean;
}

Type declaration

  • Optional accessType?: MsgVpnQueueTemplate.accessType

    The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are:

    "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
"non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
  • Optional consumerAckPropagationEnabled?: boolean

    Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional deadMsgQueue?: string

    The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE".

  • Optional deliveryDelay?: number

    The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. This attribute does not apply to MQTT queues created from this template, but it may apply in future releases. Therefore, to maintain forward compatibility, do not set this value on templates that might be used for MQTT queues. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

  • Optional durabilityOverride?: durabilityOverride

    Controls the durability of queues created from this template. If non-durable, the created queue will be non-durable, regardless of the specified durability. If none, the created queue will have the requested durability. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "none". The allowed values and their meaning are:

    "none" - The durability of the endpoint will be as requested on create.
"non-durable" - The durability of the created queue will be non-durable, regardless of what was requested.
  • Optional eventBindCountThreshold?: EventThreshold
  • Optional eventMsgSpoolUsageThreshold?: EventThreshold
  • Optional eventRejectLowPriorityMsgLimitThreshold?: EventThreshold
  • Optional maxBindCount?: number

    The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional maxDeliveredUnackedMsgsPerFlow?: number

    The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

  • Optional maxMsgSize?: number

    The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

  • Optional maxMsgSpoolUsage?: number

    The maximum message spool usage allowed, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

  • Optional maxRedeliveryCount?: number

    The maximum number of message redelivery attempts that will occur prior to the message being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional maxTtl?: number

    The maximum time in seconds a message can stay in a Queue when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional permission?: MsgVpnQueueTemplate.permission

    The permission level for all consumers, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are:

    "no-access" - Disallows all access.
"read-only" - Read-only access to the messages.
"consume" - Consume (read and remove) messages.
"modify-topic" - Consume messages or modify the topic/selector.
"delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
  • Optional queueNameFilter?: string

    A wildcardable pattern used to determine which Queues use settings from this Template. Two different wildcards are supported: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional queueTemplateName?: string

    The name of the Queue Template.

  • Optional redeliveryEnabled?: boolean

    Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

  • Optional rejectLowPriorityMsgEnabled?: boolean

    Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional rejectLowPriorityMsgLimit?: number

    The number of messages of any priority above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional rejectMsgToSenderOnDiscardBehavior?: MsgVpnQueueTemplate.rejectMsgToSenderOnDiscardBehavior

    Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs prevent the message from being delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-queue-enabled". The allowed values and their meaning are:

    "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
"when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
"never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
  • Optional respectMsgPriorityEnabled?: boolean

    Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional respectTtlEnabled?: boolean

    Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

Settings

Member Visibility

Theme