Variable $MsgVpnQueueConst

Type declaration

• properties: {
      accessType: {
          type: "Enum";
      };
      consumerAckPropagationEnabled: {
          description: "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`.";
          type: "boolean";
      };
      deadMsgQueue: {
          description: "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.";
          type: "string";
      };
      deliveryCountEnabled: {
          description: "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.";
          type: "boolean";
      };
      deliveryDelay: {
          description: "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      egressEnabled: {
          description: "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
      eventBindCountThreshold: {
          type: "EventThreshold";
      };
      eventMsgSpoolUsageThreshold: {
          type: "EventThreshold";
      };
      eventRejectLowPriorityMsgLimitThreshold: {
          type: "EventThreshold";
      };
      ingressEnabled: {
          description: "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
      maxBindCount: {
          description: "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
          format: "int64";
          type: "number";
      };
      maxDeliveredUnackedMsgsPerFlow: {
          description: "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.";
          format: "int64";
          type: "number";
      };
      maxMsgSize: {
          description: "The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.";
          format: "int32";
          type: "number";
      };
      maxMsgSpoolUsage: {
          description: "The maximum message spool usage allowed by the Queue, 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`.";
          format: "int64";
          type: "number";
      };
      maxRedeliveryCount: {
          description: "The maximum number of times the Queue will attempt redelivery of a message prior to it 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`.";
          format: "int64";
          type: "number";
      };
      maxTtl: {
          description: "The maximum time in seconds a message can stay in the 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`.";
          format: "int64";
          type: "number";
      };
      msgVpnName: {
          description: "The name of the Message VPN.";
          type: "string";
      };
      owner: {
          description: "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
          type: "string";
      };
      permission: {
          type: "Enum";
      };
      queueName: {
          description: "The name of the Queue.";
          type: "string";
      };
      redeliveryEnabled: {
          description: "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.";
          type: "boolean";
      };
      rejectLowPriorityMsgEnabled: {
          description: "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`.";
          type: "boolean";
      };
      rejectLowPriorityMsgLimit: {
          description: "The number of messages of any priority in the Queue 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`.";
          format: "int64";
          type: "number";
      };
      rejectMsgToSenderOnDiscardBehavior: {
          type: "Enum";
      };
      respectMsgPriorityEnabled: {
          description: "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.";
          type: "boolean";
      };
      respectTtlEnabled: {
          description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. 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`.";
          type: "boolean";
      };
  }

  • accessType: {
        type: "Enum";
    }

    • type: "Enum"

  • consumerAckPropagationEnabled: {
        description: "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`.";
        type: "boolean";
    }

    • description: "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`."

    • type: "boolean"

  • deadMsgQueue: {
        description: "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2.";
        type: "string";
    }

    • description: "The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#DEAD_MSG_QUEUE\"`. Available since 2.2."

    • type: "string"

  • deliveryCountEnabled: {
        description: "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19.";
        type: "boolean";
    }

    • description: "Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.19."

    • type: "boolean"

  • deliveryDelay: {
        description: "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • egressEnabled: {
        description: "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"

  • eventBindCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • eventMsgSpoolUsageThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • eventRejectLowPriorityMsgLimitThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • ingressEnabled: {
        description: "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"

  • maxBindCount: {
        description: "The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
        format: "int64";
        type: "number";
    }

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

    • format: "int64"

    • type: "number"

  • maxDeliveredUnackedMsgsPerFlow: {
        description: "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`."

    • format: "int64"

    • type: "number"

  • maxMsgSize: {
        description: "The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`.";
        format: "int32";
        type: "number";
    }

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

    • format: "int32"

    • type: "number"

  • maxMsgSpoolUsage: {
        description: "The maximum message spool usage allowed by the Queue, 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`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum message spool usage allowed by the Queue, 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`."

    • format: "int64"

    • type: "number"

  • maxRedeliveryCount: {
        description: "The maximum number of times the Queue will attempt redelivery of a message prior to it 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`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of times the Queue will attempt redelivery of a message prior to it 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`."

    • format: "int64"

    • type: "number"

  • maxTtl: {
        description: "The maximum time in seconds a message can stay in the 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`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum time in seconds a message can stay in the 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`."

    • format: "int64"

    • type: "number"

  • msgVpnName: {
        description: "The name of the Message VPN.";
        type: "string";
    }

    • description: "The name of the Message VPN."

    • type: "string"

  • owner: {
        description: "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
        type: "string";
    }

    • description: "The Client Username that owns the Queue and has permission equivalent to `\"delete\"`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`."

    • type: "string"

  • permission: {
        type: "Enum";
    }

    • type: "Enum"

  • queueName: {
        description: "The name of the Queue.";
        type: "string";
    }

    • description: "The name of the Queue."

    • type: "string"

  • redeliveryEnabled: {
        description: "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.";
        type: "boolean";
    }

    • description: "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."

    • type: "boolean"

  • rejectLowPriorityMsgEnabled: {
        description: "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`.";
        type: "boolean";
    }

    • description: "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`."

    • type: "boolean"

  • rejectLowPriorityMsgLimit: {
        description: "The number of messages of any priority in the Queue 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`.";
        format: "int64";
        type: "number";
    }

    • description: "The number of messages of any priority in the Queue 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`."

    • format: "int64"

    • type: "number"

  • rejectMsgToSenderOnDiscardBehavior: {
        type: "Enum";
    }

    • type: "Enum"

  • respectMsgPriorityEnabled: {
        description: "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8.";
        type: "boolean";
    }

    • description: "Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.8."

    • type: "boolean"

  • respectTtlEnabled: {
        description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. 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`.";
        type: "boolean";
    }

    • description: "Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. 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`."

    • type: "boolean"