jsScheduleOptions Struct Reference

#include <nats.h>

Public Attributes
const char *	Schedule
const char *	Target
	The subject the message will be delivered to.
const char *	Source
int64_t	TTL
	When publishing sets a TTL (in milliseconds) on the message if the stream supports per message TTLs.
const char *	TimeZone
bool	Rollup
	When publishing sets a Rollup on the message.
const char *	CancelScheduledSubject
	Subject of scheduled message to be canceled.

Detailed Description

Options for scheduled jetstream messages; sent as part of jsPubOptions.

Note

The stream must have AllowMsgSchedules configured

Member Data Documentation

Schedule

const char* jsScheduleOptions::Schedule

The schedule the message will be published on. Can be set as intervals (@every 1m), predefined schedules (@yearly, @monthly, @weekly, @daily, @hourly), or in a cron format (* * * * * *).

Target

const char* jsScheduleOptions::Target

Source

const char* jsScheduleOptions::Source

Instructs the schedule to read the last message on the given subject and publish it to the target. If no message exists on the source subject, the schedule's own body and headers is published as a fallback. Wildcards are not supported.

TTL

int64_t jsScheduleOptions::TTL

TimeZone

const char* jsScheduleOptions::TimeZone

The time zone used for the Cron schedule. If not specified, the Cron schedule will be in UTC. Not allowed to be used if the schedule is not a Cron schedule.

Rollup

bool jsScheduleOptions::Rollup

CancelScheduledSubject

const char* jsScheduleOptions::CancelScheduledSubject

---

The documentation for this struct was generated from the following file:

• nats.h