cdk8s 2.3.83 → 2.4.1

package/.jsii

@@ -1302,6 +1302,133 @@
       ],
       "symbolId": "src/chart:ChartProps"
     },
+    "cdk8s.CronOptions": {
+      "assembly": "cdk8s",
+      "datatype": true,
+      "docs": {
+        "remarks": "All fields are strings so you can use complex expressions. Absence of\na field implies '*' or '?', whichever one is appropriate.",
+        "stability": "stable",
+        "summary": "Options to configure a cron expression."
+      },
+      "fqn": "cdk8s.CronOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/schedule.ts",
+        "line": 79
+      },
+      "name": "CronOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Every day of the month",
+            "stability": "stable",
+            "summary": "The day of the month to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 99
+          },
+          "name": "day",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Every hour",
+            "stability": "stable",
+            "summary": "The hour to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 92
+          },
+          "name": "hour",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Every minute",
+            "stability": "stable",
+            "summary": "The minute to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 85
+          },
+          "name": "minute",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Every month",
+            "stability": "stable",
+            "summary": "The month to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 106
+          },
+          "name": "month",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Any day of the week",
+            "stability": "stable",
+            "summary": "The day of the week to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 120
+          },
+          "name": "weekDay",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Every year",
+            "stability": "stable",
+            "summary": "The year to run this rule at."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 113
+          },
+          "name": "year",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/schedule:CronOptions"
+    },
     "cdk8s.DependencyGraph": {
       "assembly": "cdk8s",
       "docs": {
@@ -1867,6 +1994,22 @@
               "primitive": "number"
             }
           }
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Return unit of Duration."
+          },
+          "locationInModule": {
+            "filename": "src/duration.ts",
+            "line": 200
+          },
+          "name": "unitLabel",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
         }
       ],
       "name": "Duration",
@@ -2862,6 +3005,132 @@
       ],
       "symbolId": "src/metadata:OwnerReference"
     },
+    "cdk8s.Schedule": {
+      "abstract": true,
+      "assembly": "cdk8s",
+      "docs": {
+        "remarks": "Note that rates cannot be defined in fractions of minutes.",
+        "stability": "stable",
+        "summary": "Represents a schedule."
+      },
+      "fqn": "cdk8s.Schedule",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/schedule.ts",
+          "line": 64
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/schedule.ts",
+        "line": 8
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a schedule from a set of cron fields."
+          },
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 37
+          },
+          "name": "cron",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "cdk8s.CronOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Schedule"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Construct a schedule from a literal schedule expression."
+          },
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 14
+          },
+          "name": "expression",
+          "parameters": [
+            {
+              "docs": {
+                "remarks": "Must be in a format of 'value unit'",
+                "summary": "The expression to use."
+              },
+              "name": "expression",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Schedule"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "Rates may be defined with any unit of time, but when converted into minutes, the duration must be a positive whole number of minutes.",
+            "stability": "stable",
+            "summary": "Construct a schedule from an interval and a time unit."
+          },
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 23
+          },
+          "name": "rate",
+          "parameters": [
+            {
+              "name": "duration",
+              "type": {
+                "fqn": "cdk8s.Duration"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Schedule"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "Schedule",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Retrieve the expression for this schedule."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/schedule.ts",
+            "line": 62
+          },
+          "name": "expressionString",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/schedule:Schedule"
+    },
     "cdk8s.Size": {
       "assembly": "cdk8s",
       "docs": {
@@ -3311,7 +3580,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/duration.ts",
-        "line": 212
+        "line": 219
       },
       "name": "TimeConversionOptions",
       "properties": [
@@ -3325,7 +3594,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/duration.ts",
-            "line": 219
+            "line": 226
           },
           "name": "integral",
           "optional": true,
@@ -3567,6 +3836,6 @@
       "symbolId": "src/app:YamlOutputType"
     }
   },
-  "version": "2.3.83",
-  "fingerprint": "wH9/Ftqqi3KqxlEH/z5PpNYENd6f8/56kGwAMGrRlO0="
+  "version": "2.4.1",
+  "fingerprint": "d88/DzcmPuAK7mHLQMi7myl2Ul5Q0RqdqMDoQTUNHaI="
 }

package/docs/java.md

@@ -903,6 +903,106 @@ This namespace will only apply to objects that don't have a
 
 ---
 
+### CronOptions <a name="org.cdk8s.CronOptions"></a>
+
+Options to configure a cron expression.
+
+All fields are strings so you can use complex expressions. Absence of
+a field implies '*' or '?', whichever one is appropriate.
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```java
+import org.cdk8s.CronOptions;
+
+CronOptions.builder()
+//  .day(java.lang.String)
+//  .hour(java.lang.String)
+//  .minute(java.lang.String)
+//  .month(java.lang.String)
+//  .weekDay(java.lang.String)
+//  .year(java.lang.String)
+    .build();
+```
+
+##### `day`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.day"></a>
+
+```java
+public java.lang.String getDay();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Every day of the month
+
+The day of the month to run this rule at.
+
+---
+
+##### `hour`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.hour"></a>
+
+```java
+public java.lang.String getHour();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Every hour
+
+The hour to run this rule at.
+
+---
+
+##### `minute`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.minute"></a>
+
+```java
+public java.lang.String getMinute();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Every minute
+
+The minute to run this rule at.
+
+---
+
+##### `month`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.month"></a>
+
+```java
+public java.lang.String getMonth();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Every month
+
+The month to run this rule at.
+
+---
+
+##### `weekDay`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.weekDay"></a>
+
+```java
+public java.lang.String getWeekDay();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Any day of the week
+
+The day of the week to run this rule at.
+
+---
+
+##### `year`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.property.year"></a>
+
+```java
+public java.lang.String getYear();
+```
+
+- *Type:* `java.lang.String`
+- *Default:* Every year
+
+The year to run this rule at.
+
+---
+
 ### GroupVersionKind <a name="org.cdk8s.GroupVersionKind"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
@@ -1784,6 +1884,12 @@ public toSeconds(TimeConversionOptions opts)
 
 ---
 
+##### `unitLabel` <a name="org.cdk8s.Duration.unitLabel"></a>
+
+```java
+public unitLabel()
+```
+
 #### Static Functions <a name="Static Functions"></a>
 
 ##### `days` <a name="org.cdk8s.Duration.days"></a>
@@ -2124,6 +2230,84 @@ Name options.
 
 
 
+### Schedule <a name="org.cdk8s.Schedule"></a>
+
+Represents a schedule.
+
+Note that rates cannot be defined in fractions of minutes.
+
+#### Initializers <a name="org.cdk8s.Schedule.Initializer"></a>
+
+```java
+import org.cdk8s.Schedule;
+
+new Schedule();
+```
+
+
+#### Static Functions <a name="Static Functions"></a>
+
+##### `cron` <a name="org.cdk8s.Schedule.cron"></a>
+
+```java
+import org.cdk8s.Schedule;
+
+Schedule.cron(CronOptions options)
+```
+
+###### `options`<sup>Required</sup> <a name="org.cdk8s.Schedule.parameter.options"></a>
+
+- *Type:* [`org.cdk8s.CronOptions`](#org.cdk8s.CronOptions)
+
+---
+
+##### `expression` <a name="org.cdk8s.Schedule.expression"></a>
+
+```java
+import org.cdk8s.Schedule;
+
+Schedule.expression(java.lang.String expression)
+```
+
+###### `expression`<sup>Required</sup> <a name="org.cdk8s.Schedule.parameter.expression"></a>
+
+- *Type:* `java.lang.String`
+
+The expression to use.
+
+Must be in a format of 'value unit'
+
+---
+
+##### `rate` <a name="org.cdk8s.Schedule.rate"></a>
+
+```java
+import org.cdk8s.Schedule;
+
+Schedule.rate(Duration duration)
+```
+
+###### `duration`<sup>Required</sup> <a name="org.cdk8s.Schedule.parameter.duration"></a>
+
+- *Type:* [`org.cdk8s.Duration`](#org.cdk8s.Duration)
+
+---
+
+#### Properties <a name="Properties"></a>
+
+##### `expressionString`<sup>Required</sup> <a name="org.cdk8s.Schedule.property.expressionString"></a>
+
+```java
+public java.lang.String getExpressionString();
+```
+
+- *Type:* `java.lang.String`
+
+Retrieve the expression for this schedule.
+
+---
+
+
 ### Size <a name="org.cdk8s.Size"></a>
 
 Represents the amount of digital storage.