Chronicle V1 API - Class Google::Backstory::ScheduledCronTask (v1.4.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::ScheduledCronTask.

Information about a scheduled cron task.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#author

def author() -> ::String
Returns
  • (::String) — The author or creator of the task.

#author=

def author=(value) -> ::String
Parameter
  • value (::String) — The author or creator of the task.
Returns
  • (::String) — The author or creator of the task.

#comment

def comment() -> ::String
Returns
  • (::String) — A comment or description for the task.

#comment=

def comment=(value) -> ::String
Parameter
  • value (::String) — A comment or description for the task.
Returns
  • (::String) — A comment or description for the task.

#event

def event() -> ::String
Returns
  • (::String) — Crontab special string or event (e.g., "@reboot", "@daily").

#event=

def event=(value) -> ::String
Parameter
  • value (::String) — Crontab special string or event (e.g., "@reboot", "@daily").
Returns
  • (::String) — Crontab special string or event (e.g., "@reboot", "@daily").

#hour

def hour() -> ::String
Returns
  • (::String) — Crontab hour field. Value is an integer between 0 and 23, a range or list of values (e.g., "0-6", "/2", "1,2"), or an asterisk () to indicate first-last hours.

#hour=

def hour=(value) -> ::String
Parameter
  • value (::String) — Crontab hour field. Value is an integer between 0 and 23, a range or list of values (e.g., "0-6", "/2", "1,2"), or an asterisk () to indicate first-last hours.
Returns
  • (::String) — Crontab hour field. Value is an integer between 0 and 23, a range or list of values (e.g., "0-6", "/2", "1,2"), or an asterisk () to indicate first-last hours.

#minute

def minute() -> ::String
Returns
  • (::String) — Crontab minute field. Value is an integer between 0 and 59 and can also be a range or list of values (e.g., "0-59", "0-59/5", "0,15,30,45") and it // can also be an asterisk (*) to indicate first-last minutes. More on crontab format can be found here: https://www.linux.org/docs/man5/crontab.html

#minute=

def minute=(value) -> ::String
Parameter
  • value (::String) — Crontab minute field. Value is an integer between 0 and 59 and can also be a range or list of values (e.g., "0-59", "0-59/5", "0,15,30,45") and it // can also be an asterisk (*) to indicate first-last minutes. More on crontab format can be found here: https://www.linux.org/docs/man5/crontab.html
Returns
  • (::String) — Crontab minute field. Value is an integer between 0 and 59 and can also be a range or list of values (e.g., "0-59", "0-59/5", "0,15,30,45") and it // can also be an asterisk (*) to indicate first-last minutes. More on crontab format can be found here: https://www.linux.org/docs/man5/crontab.html

#month

def month() -> ::String
Returns
  • (::String) — Crontab month field. Value is an integer between 1 and 12 or a 3-letter name (e.g., "Jan"), a range or list of values (e.g., "1-3", "/2", "1,6"), or an asterisk () to indicate first-last months.

#month=

def month=(value) -> ::String
Parameter
  • value (::String) — Crontab month field. Value is an integer between 1 and 12 or a 3-letter name (e.g., "Jan"), a range or list of values (e.g., "1-3", "/2", "1,6"), or an asterisk () to indicate first-last months.
Returns
  • (::String) — Crontab month field. Value is an integer between 1 and 12 or a 3-letter name (e.g., "Jan"), a range or list of values (e.g., "1-3", "/2", "1,6"), or an asterisk () to indicate first-last months.

#month_day

def month_day() -> ::String
Returns
  • (::String) — Crontab day of month field. Value is an integer between 1 and 31, a range or list of values (e.g., "1-7", "1-31/7", "1,15"), or an asterisk (*) to indicate first-last days of month.

#month_day=

def month_day=(value) -> ::String
Parameter
  • value (::String) — Crontab day of month field. Value is an integer between 1 and 31, a range or list of values (e.g., "1-7", "1-31/7", "1,15"), or an asterisk (*) to indicate first-last days of month.
Returns
  • (::String) — Crontab day of month field. Value is an integer between 1 and 31, a range or list of values (e.g., "1-7", "1-31/7", "1,15"), or an asterisk (*) to indicate first-last days of month.

#path

def path() -> ::String
Returns
  • (::String) — The PATH environment variable defined in the crontab file.

#path=

def path=(value) -> ::String
Parameter
  • value (::String) — The PATH environment variable defined in the crontab file.
Returns
  • (::String) — The PATH environment variable defined in the crontab file.

#week_day

def week_day() -> ::String
Returns
  • (::String) — Crontab day of week field. Value is an integer between 0 and 7 (0 or 7 is Sunday) or a 3-letter name (e.g., "Fri"), a range or list of values (e.g., "1-5", "0,6"), or an asterisk (*) to indicate first-last days of week.

#week_day=

def week_day=(value) -> ::String
Parameter
  • value (::String) — Crontab day of week field. Value is an integer between 0 and 7 (0 or 7 is Sunday) or a 3-letter name (e.g., "Fri"), a range or list of values (e.g., "1-5", "0,6"), or an asterisk (*) to indicate first-last days of week.
Returns
  • (::String) — Crontab day of week field. Value is an integer between 0 and 7 (0 or 7 is Sunday) or a 3-letter name (e.g., "Fri"), a range or list of values (e.g., "1-5", "0,6"), or an asterisk (*) to indicate first-last days of week.