Create an Every Cron

The following SDK can be used to create a recurring cron that will submit a job to the job pool at a scheduled interval that is less than 24Hrs.

    

        
copy
        

            

        
    
    

         
// create function job meta
const jobMeta = {
job_name: ’test_job’, // set a name for the job
target_type: ‘Function’, // set the target type as Function for function jobs
target_name: ’target_function’, // set the target function’s name (optional) (either target_id or target_name is mandatory)
// target_id: ‘123467890’, // set the target functions’s Id (optional) (either target_id or target_name is mandatory)
jobpool_name: ’test’, // set the name of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
// jobpool_id: ‘1234567890’ // set the Id of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
job_config: {
number_of_retries: 2, // set the number of retries
retry_interval: 15 * 60 // set the retry  interval
}, // set job config - job retries => 2 retries in 15 mins (optional)
params: {
arg1: ’test’,
arg2: ‘job’
}, // set params to be passed to target function (optional)
};
// create every cron details
const everyCron = {
cron_name: ’every_cron’, // set a name for the cron (unique)
description: ’every_cron’, // set a description for the cron (optional)
cron_status: true, // set the cron status as enabled
cron_type: ‘Periodic’, // set the cron type as Periodic for every cron
cron_detail: {
hour: 2, // set the hour interval of the repetition
minute: 1, // set the minute interval of the repetition
second: 3, // set the second interval of the repetition
repetition_type: “every” // set the repetition type as every for every cron
},
job_meta: jobMeta // set the function job meta
};
// create every cron
const everyCronDetails = await jobScheduling.CRON.createCron(everyCron);

    

Create a Daily Cron

The following SDK can be used to schedule a cron to submit a job to the job pool at a fixed time at a daily interval.

    

        
copy
        

            

        
    
    

         
// create function job meta
const jobMeta = {
job_name: ’test_job’, // set a name for the job
target_type: ‘Function’, // set the target type as Function for function jobs
target_name: ’target_function’, // set the target function’s name (optional) (either target_id or target_name is mandatory)
// target_id: ‘123467890’, // set the target functions’s Id (optional) (either target_id or target_name is mandatory)
jobpool_name: ’test’, // set the name of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
// jobpool_id: ‘1234567890’ // set the Id of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
job_config: {
number_of_retries: 2, // set the number of retries
retry_interval: 15 * 60 // set the retry  interval
}, // set job config - job retries => 2 retries in 15 mins (optional)
params: {
arg1: ’test’,
arg2: ‘job’
}, // set params to be passed to target function (optional)
};
// create daily cron details
const dailyCron = {
cron_name: ‘daily_cron’, // set a name for the cron (unique)
description: ‘daily_cron’, // set a description for the cron (optional)
cron_status: true, // set the cron status as enabled
cron_type: ‘Calendar’, // set the cron type as Calendar for daily, monthly and yearly
cron_detail: {
hour: 0, // set the hour of the day in which the cron should be executed
minute: 0, // set the minute of the day in which the cron should be executed
second: 0, // set the second of the day in which the cron should be executed
repetition_type: ‘daily’, // set the repetition type as daily for daily cron
// timezone: ‘America/Los_Angeles’ // set the timezone (optional)
},
job_meta: jobMeta // set the function job meta
};
// create daily cron
const dailyCronDetails = await jobScheduling.CRON.createCron(dailyCron);

    

Create a Monthly Cron

The following SDK can be used to schedule a cron to submit a job to the job pool at a fixed date, and time at a monthly interval. Additionally, you also have the option to submit a job at a monthly interval but on a particular week.

If you choose to schedule the cron to execute at a monthly interval on a date-based schedule, then the range of possible dates, based on the month, will be 1-31. Similarly, if you choose a week-based interval, then the range can either be from 1-4, and the particular days of the week will be in the range of 1-7.

    

        
copy
        

            

        
    
    

         
// create function job meta
const jobMeta = {
job_name: ’test_job’, // set a name for the job
target_type: ‘Function’, // set the target type as Function for function jobs
target_name: ’target_function’, // set the target function’s name (optional) (either target_id or target_name is mandatory)
// target_id: ‘123467890’, // set the target functions’s Id (optional) (either target_id or target_name is mandatory)
jobpool_name: ’test’, // set the name of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
// jobpool_id: ‘1234567890’ // set the Id of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
job_config: {
number_of_retries: 2, // set the number of retries
retry_interval: 15 * 60 // set the retry  interval
}, // set job config - job retries => 2 retries in 15 mins (optional)
params: {
arg1: ’test’,
arg2: ‘job’
}, // set params to be passed to target function (optional)
};
// create monthly cron details
const monthlyCron = {
cron_name: ‘monthly_cron’, // set a name for the cron (unique)
description: ‘monthly_cron’, // set a description for the cron (optional)
cron_status: true, // set the cron status as enabled
cron_type: ‘Calendar’, // set the cron type as Calendar for daily, monthly and yearly
cron_detail: {
hour: 0, // set the hour of the day in which the cron should be executed
minute: 0, // set the minute of the day in which the cron should be executed
second: 0, // set the second of the day in which the cron should be executed
days: [1, 3, 5], // set the days of the month in which the cron should be executed
// week_day: [1, 3], // set the days of the week in a month during which the cron should be executed
// weeks_of_month: [2], // set the weeks of the month during which the cron should be executed
repetition_type: ‘monthly’, // set the repetition type as monthly for monthly cron
// timezone: ‘America/Los_Angeles’ // set the timezone (optional)
},
job_meta: jobMeta // set function job meta
};
// create monthly cron
const monthlyCronDetails = await jobScheduling.CRON.createCron(monthlyCron);

    

Create a Yearly Cron

The following SDK can be used to schedule a cron tosubmit a job to the job pool at a fixed date, and time at a fixed month on a yearly interval. Additionally, you also have the option to submit a job at a yearly interval but on a particular week.

If you choose to schedule the cron to execute at a yearly interval on a date-based schedule, then the range of possible dates, based on the month, will be 1-31, and the month will be determined based on the range of values 1-12. Similarly, if you choose a week-based interval, then the range can either be from 1-4, and the particular days of the week will be in the range of 1-7.

    

        
copy
        

            

        
    
    

         
// create function job meta
const jobMeta = {
job_name: ’test_job’, // set a name for the job
target_type: ‘Function’, // set the target type as Function for function jobs
target_name: ’target_function’, // set the target function’s name (optional) (either target_id or target_name is mandatory)
// target_id: ‘123467890’, // set the target functions’s Id (optional) (either target_id or target_name is mandatory)
jobpool_name: ’test’, // set the name of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
// jobpool_id: ‘1234567890’ // set the Id of the function jobpool (optional) (either jobpool_name or jobpool_id is mandatory)
job_config: {
number_of_retries: 2, // set the number of retries
retry_interval: 15 * 60 // set the retry  interval
}, // set job config - job retries => 2 retries in 15 mins (optional)
params: {
arg1: ’test’,
arg2: ‘job’
}, // set params to be passed to target function (optional)
};
// create yearly cron details
const yearlyCron = {
cron_name: ‘yearly_cron’, // set a name for the cron (unique)
description: ‘yearly_cron’, // set a description for the cron (optional)
cron_status: true, // set the cron status as enabled
cron_type: ‘Calendar’, // set the cron type as Calendar for daily, monthly and yearly
cron_detail: {
hour: 0, // set the hour of the day in which the cron should be executed
minute: 0, // set the minute of the day in which the cron should be executed
second: 0, // set the second of the day in which the cron should be executed
days: [1, 2, 3], // set the days of the month in which the cron should be executed
// week_day: [1, 3], // set the days of the week in a month during which the cron should be executed
// weeks_of_month: [2], // set the weeks of the month during which the cron should be executed
months: [8], // set the months of the year in which the cron should be executed
repetition_type: ‘yearly’, // set the repetition type as yearly for yearly cron
// timezone: ‘America/Los_Angeles’ // set the timezone (optional)
},
job_meta: jobMeta // set function job meta
};
// create yearly cron
const yearlyCronDetails = await jobScheduling.CRON.createCron(yearlyCron);