cdk8s 2.4.12 → 2.4.15

package/.jsii

@@ -1302,19 +1302,198 @@
       ],
       "symbolId": "src/chart:ChartProps"
     },
+    "cdk8s.Cron": {
+      "assembly": "cdk8s",
+      "docs": {
+        "stability": "stable",
+        "summary": "Represents a cron schedule."
+      },
+      "fqn": "cdk8s.Cron",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cron.ts",
+          "line": 59
+        },
+        "parameters": [
+          {
+            "name": "cronOptions",
+            "optional": true,
+            "type": {
+              "fqn": "cdk8s.CronOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cron.ts",
+        "line": 4
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs first day of January every year."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 43
+          },
+          "name": "annually",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs every day at midnight."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 22
+          },
+          "name": "daily",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs every minute."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 8
+          },
+          "name": "everyMinute",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs every hour."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 15
+          },
+          "name": "hourly",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs first day of every month."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 36
+          },
+          "name": "monthly",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a custom cron schedule from a set of cron fields."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 50
+          },
+          "name": "schedule",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "cdk8s.CronOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Create a cron schedule which runs every week on Sunday."
+          },
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 29
+          },
+          "name": "weekly",
+          "returns": {
+            "type": {
+              "fqn": "cdk8s.Cron"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "Cron",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Retrieve the expression for this schedule."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cron.ts",
+            "line": 57
+          },
+          "name": "expressionString",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/cron:Cron"
+    },
     "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.",
+        "remarks": "All fields are strings so you can use complex expressions. Absence of\na field implies '*'",
         "stability": "stable",
         "summary": "Options to configure a cron expression."
       },
       "fqn": "cdk8s.CronOptions",
       "kind": "interface",
       "locationInModule": {
-        "filename": "src/schedule.ts",
-        "line": 79
+        "filename": "src/cron.ts",
+        "line": 76
       },
       "name": "CronOptions",
       "properties": [
@@ -1327,8 +1506,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/schedule.ts",
-            "line": 99
+            "filename": "src/cron.ts",
+            "line": 96
           },
           "name": "day",
           "optional": true,
@@ -1345,8 +1524,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/schedule.ts",
-            "line": 92
+            "filename": "src/cron.ts",
+            "line": 89
           },
           "name": "hour",
           "optional": true,
@@ -1363,8 +1542,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/schedule.ts",
-            "line": 85
+            "filename": "src/cron.ts",
+            "line": 82
           },
           "name": "minute",
           "optional": true,
@@ -1381,8 +1560,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/schedule.ts",
-            "line": 106
+            "filename": "src/cron.ts",
+            "line": 103
           },
           "name": "month",
           "optional": true,
@@ -1399,35 +1578,17 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/schedule.ts",
-            "line": 120
+            "filename": "src/cron.ts",
+            "line": 110
           },
           "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"
+      "symbolId": "src/cron:CronOptions"
     },
     "cdk8s.DependencyGraph": {
       "assembly": "cdk8s",
@@ -3005,132 +3166,6 @@
       ],
       "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": {
@@ -3836,6 +3871,6 @@
       "symbolId": "src/app:YamlOutputType"
     }
   },
-  "version": "2.4.12",
-  "fingerprint": "6RHmoImrS8msmXGHdMi8Q+/wvB+OjzxNCL16tOgfleg="
+  "version": "2.4.15",
+  "fingerprint": "a6ObvxbP3EiwJQLKMO9R+4gfUJUPNa4osu1TTbzrfdI="
 }

package/docs/java.md

@@ -908,7 +908,7 @@ This namespace will only apply to objects that don't have 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.
+a field implies '*'
 
 #### Initializer <a name="[object Object].Initializer"></a>
 
@@ -921,7 +921,6 @@ CronOptions.builder()
 //  .minute(java.lang.String)
 //  .month(java.lang.String)
 //  .weekDay(java.lang.String)
-//  .year(java.lang.String)
     .build();
 ```
 
@@ -990,19 +989,6 @@ 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>
@@ -1659,6 +1645,149 @@ The object's namespace.
 ---
 
 
+### Cron <a name="org.cdk8s.Cron"></a>
+
+Represents a cron schedule.
+
+#### Initializers <a name="org.cdk8s.Cron.Initializer"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.Builder.create()
+//  .day(java.lang.String)
+//  .hour(java.lang.String)
+//  .minute(java.lang.String)
+//  .month(java.lang.String)
+//  .weekDay(java.lang.String)
+    .build();
+```
+
+##### `day`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.parameter.day"></a>
+
+- *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.parameter.hour"></a>
+
+- *Type:* `java.lang.String`
+- *Default:* Every hour
+
+The hour to run this rule at.
+
+---
+
+##### `minute`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.parameter.minute"></a>
+
+- *Type:* `java.lang.String`
+- *Default:* Every minute
+
+The minute to run this rule at.
+
+---
+
+##### `month`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.parameter.month"></a>
+
+- *Type:* `java.lang.String`
+- *Default:* Every month
+
+The month to run this rule at.
+
+---
+
+##### `weekDay`<sup>Optional</sup> <a name="org.cdk8s.CronOptions.parameter.weekDay"></a>
+
+- *Type:* `java.lang.String`
+- *Default:* Any day of the week
+
+The day of the week to run this rule at.
+
+---
+
+
+#### Static Functions <a name="Static Functions"></a>
+
+##### `annually` <a name="org.cdk8s.Cron.annually"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.annually()
+```
+
+##### `daily` <a name="org.cdk8s.Cron.daily"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.daily()
+```
+
+##### `everyMinute` <a name="org.cdk8s.Cron.everyMinute"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.everyMinute()
+```
+
+##### `hourly` <a name="org.cdk8s.Cron.hourly"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.hourly()
+```
+
+##### `monthly` <a name="org.cdk8s.Cron.monthly"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.monthly()
+```
+
+##### `schedule` <a name="org.cdk8s.Cron.schedule"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.schedule(CronOptions options)
+```
+
+###### `options`<sup>Required</sup> <a name="org.cdk8s.Cron.parameter.options"></a>
+
+- *Type:* [`org.cdk8s.CronOptions`](#org.cdk8s.CronOptions)
+
+---
+
+##### `weekly` <a name="org.cdk8s.Cron.weekly"></a>
+
+```java
+import org.cdk8s.Cron;
+
+Cron.weekly()
+```
+
+#### Properties <a name="Properties"></a>
+
+##### `expressionString`<sup>Required</sup> <a name="org.cdk8s.Cron.property.expressionString"></a>
+
+```java
+public java.lang.String getExpressionString();
+```
+
+- *Type:* `java.lang.String`
+
+Retrieve the expression for this schedule.
+
+---
+
+
 ### DependencyGraph <a name="org.cdk8s.DependencyGraph"></a>
 
 Represents the dependency graph for a given Node.
@@ -2230,84 +2359,6 @@ 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.