Package org.cdk8s

Class Cron

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.81.0 (build 80988b0)",
           date="2023-05-15T18:42:27.027Z")
@Stability(Stable)
public class Cron
extends software.amazon.jsii.JsiiObject
    Represents a cron schedule.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Cron.Builder
      A fluent builder for Cron.

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        Cron()  
        Cron​(CronOptions cronOptions)  
      protected Cron​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected Cron​(software.amazon.jsii.JsiiObjectRef objRef)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Cron annually()
      Create a cron schedule which runs first day of January every year.
      static Cron daily()
      Create a cron schedule which runs every day at midnight.
      static Cron everyMinute()
      Create a cron schedule which runs every minute.
      String getExpressionString()
      Retrieve the expression for this schedule.
      static Cron hourly()
      Create a cron schedule which runs every hour.
      static Cron monthly()
      Create a cron schedule which runs first day of every month.
      static Cron schedule​(CronOptions options)
      Create a custom cron schedule from a set of cron fields.
      static Cron weekly()
      Create a cron schedule which runs every week on Sunday.

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • Cron

        protected Cron​(software.amazon.jsii.JsiiObjectRef objRef)

      • Cron

        protected Cron​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • Cron

        @Stability(Stable)
public Cron​(@Nullable
            CronOptions cronOptions)
        Parameters:
        cronOptions -

      • Cron

        @Stability(Stable)
public Cron()

    • Method Detail

      • annually

        @Stability(Stable)
@NotNull
public static Cron annually()
        Create a cron schedule which runs first day of January every year.

      • daily

        @Stability(Stable)
@NotNull
public static Cron daily()
        Create a cron schedule which runs every day at midnight.

      • everyMinute

        @Stability(Stable)
@NotNull
public static Cron everyMinute()
        Create a cron schedule which runs every minute.

      • hourly

        @Stability(Stable)
@NotNull
public static Cron hourly()
        Create a cron schedule which runs every hour.

      • monthly

        @Stability(Stable)
@NotNull
public static Cron monthly()
        Create a cron schedule which runs first day of every month.

      • schedule

        @Stability(Stable)
@NotNull
public static Cron schedule​(@NotNull
                            CronOptions options)
        Create a custom cron schedule from a set of cron fields.

        Parameters:
        options - This parameter is required.

      • weekly

        @Stability(Stable)
@NotNull
public static Cron weekly()
        Create a cron schedule which runs every week on Sunday.

      • getExpressionString

        @Stability(Stable)
@NotNull
public String getExpressionString()
        Retrieve the expression for this schedule.