Type alias MsgVpnDistributedCache

MsgVpnDistributedCache: {
    cacheName?: string;
    cacheVirtualRouter?: cacheVirtualRouter;
    enabled?: boolean;
    heartbeat?: number;
    msgVpnName?: string;
    scheduledDeleteMsgDayList?: string;
    scheduledDeleteMsgTimeList?: string;
}

Type declaration

  • Optional cacheName?: string

    The name of the Distributed Cache.

  • Optional cacheVirtualRouter?: cacheVirtualRouter

    The virtual router of the Distributed Cache. The default value is "auto". The allowed values and their meaning are:

    "auto" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.

    Available since 2.28.

  • Optional enabled?: boolean

    Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional heartbeat?: number

    The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional scheduledDeleteMsgDayList?: string

    The scheduled delete message day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduledDeleteMsgTimeList" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional scheduledDeleteMsgTimeList?: string

    The scheduled delete message time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduledDeleteMsgDayList" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

Settings

Member Visibility

Theme