cdk8s 1.0.0-beta.46 → 1.0.0-beta.47

package/.jsii

@@ -8,7 +8,7 @@
   },
   "bundled": {
     "fast-json-patch": "^2.2.1",
-    "follow-redirects": "^1.14.3",
+    "follow-redirects": "^1.14.4",
     "yaml": "2.0.0-7"
   },
   "dependencies": {
@@ -3179,6 +3179,6 @@
       "name": "YamlOutputType"
     }
   },
-  "version": "1.0.0-beta.46",
-  "fingerprint": "sOydpFsnHNrnMUJLTMS+bh6iLQchooEqEKCjWR33zJ8="
+  "version": "1.0.0-beta.47",
+  "fingerprint": "4ZH9zwpAnRTovRdNhOV1PrOfublLCH/5U4f87rjGdRA="
 }

package/docs/java.md

@@ -117,6 +117,10 @@ The higher-level construct.
 
 ##### `apiGroup`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.apiGroup"></a>
 
+```java
+public java.lang.String getApiGroup();
+```
+
 - *Type:* `java.lang.String`
 
 The group portion of the API version (e.g. `authorization.k8s.io`).
@@ -125,6 +129,10 @@ The group portion of the API version (e.g. `authorization.k8s.io`).
 
 ##### `apiVersion`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.apiVersion"></a>
 
+```java
+public java.lang.String getApiVersion();
+```
+
 - *Type:* `java.lang.String`
 
 The object's API version (e.g. `authorization.k8s.io/v1`).
@@ -133,6 +141,10 @@ The object's API version (e.g. `authorization.k8s.io/v1`).
 
 ##### `chart`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.chart"></a>
 
+```java
+public Chart getChart();
+```
+
 - *Type:* [`org.cdk8s.Chart`](#org.cdk8s.Chart)
 
 The chart in which this object is defined.
@@ -141,6 +153,10 @@ The chart in which this object is defined.
 
 ##### `kind`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.kind"></a>
 
+```java
+public java.lang.String getKind();
+```
+
 - *Type:* `java.lang.String`
 
 The object kind.
@@ -149,6 +165,10 @@ The object kind.
 
 ##### `metadata`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.metadata"></a>
 
+```java
+public ApiObjectMetadataDefinition getMetadata();
+```
+
 - *Type:* [`org.cdk8s.ApiObjectMetadataDefinition`](#org.cdk8s.ApiObjectMetadataDefinition)
 
 Metadata associated with this API object.
@@ -157,6 +177,10 @@ Metadata associated with this API object.
 
 ##### `name`<sup>Required</sup> <a name="org.cdk8s.ApiObject.property.name"></a>
 
+```java
+public java.lang.String getName();
+```
+
 - *Type:* `java.lang.String`
 
 The name of the API object.
@@ -215,6 +239,10 @@ public synth()
 
 ##### `outdir`<sup>Required</sup> <a name="org.cdk8s.App.property.outdir"></a>
 
+```java
+public java.lang.String getOutdir();
+```
+
 - *Type:* `java.lang.String`
 
 The output directory into which manifests will be synthesized.
@@ -223,6 +251,10 @@ The output directory into which manifests will be synthesized.
 
 ##### `yamlOutputType`<sup>Required</sup> <a name="org.cdk8s.App.property.yamlOutputType"></a>
 
+```java
+public YamlOutputType getYamlOutputType();
+```
+
 - *Type:* [`org.cdk8s.YamlOutputType`](#org.cdk8s.YamlOutputType)
 - *Default:* YamlOutputType.FILE_PER_CHART
 
@@ -335,6 +367,10 @@ a construct node.
 
 ##### `labels`<sup>Required</sup> <a name="org.cdk8s.Chart.property.labels"></a>
 
+```java
+public java.util.Map<java.lang.String, java.lang.String> getLabels();
+```
+
 - *Type:* java.util.Map<java.lang.String, `java.lang.String`>
 
 Labels applied to all resources in this chart.
@@ -345,6 +381,10 @@ This is an immutable copy.
 
 ##### `namespace`<sup>Optional</sup> <a name="org.cdk8s.Chart.property.namespace"></a>
 
+```java
+public java.lang.String getNamespace();
+```
+
 - *Type:* `java.lang.String`
 
 The default namespace for all objects in this chart.
@@ -438,6 +478,10 @@ Values to pass to the chart.
 
 ##### `releaseName`<sup>Required</sup> <a name="org.cdk8s.Helm.property.releaseName"></a>
 
+```java
+public java.lang.String getReleaseName();
+```
+
 - *Type:* `java.lang.String`
 
 The helm release name.
@@ -488,6 +532,10 @@ Local file path or URL which includes a Kubernetes YAML manifest.
 
 ##### `apiObjects`<sup>Required</sup> <a name="org.cdk8s.Include.property.apiObjects"></a>
 
+```java
+public java.util.List<ApiObject> getApiObjects();
+```
+
 - *Type:* java.util.List<[`org.cdk8s.ApiObject`](#org.cdk8s.ApiObject)>
 
 Returns all the included API objects.
@@ -516,6 +564,10 @@ ApiObjectMetadata.builder()
 
 ##### `annotations`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadata.property.annotations"></a>
 
+```java
+public java.util.Map<java.lang.String, java.lang.String> getAnnotations();
+```
+
 - *Type:* java.util.Map<java.lang.String, `java.lang.String`>
 - *Default:* No annotations.
 
@@ -530,6 +582,10 @@ preserved when modifying objects.
 
 ##### `labels`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadata.property.labels"></a>
 
+```java
+public java.util.Map<java.lang.String, java.lang.String> getLabels();
+```
+
 - *Type:* java.util.Map<java.lang.String, `java.lang.String`>
 - *Default:* No labels.
 
@@ -543,6 +599,10 @@ May match selectors of replication controllers and services.
 
 ##### `name`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadata.property.name"></a>
 
+```java
+public java.lang.String getName();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* an app-unique name generated by the chart
 
@@ -565,6 +625,10 @@ leave this unspecified.
 
 ##### `namespace`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadata.property.namespace"></a>
 
+```java
+public java.lang.String getNamespace();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* undefined (will be assigned to the 'default' namespace)
 
@@ -593,6 +657,10 @@ ApiObjectProps.builder()
 
 ##### `apiVersion`<sup>Required</sup> <a name="org.cdk8s.ApiObjectProps.property.apiVersion"></a>
 
+```java
+public java.lang.String getApiVersion();
+```
+
 - *Type:* `java.lang.String`
 
 API version.
@@ -601,6 +669,10 @@ API version.
 
 ##### `kind`<sup>Required</sup> <a name="org.cdk8s.ApiObjectProps.property.kind"></a>
 
+```java
+public java.lang.String getKind();
+```
+
 - *Type:* `java.lang.String`
 
 Resource kind.
@@ -609,6 +681,10 @@ Resource kind.
 
 ##### `metadata`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectProps.property.metadata"></a>
 
+```java
+public ApiObjectMetadata getMetadata();
+```
+
 - *Type:* [`org.cdk8s.ApiObjectMetadata`](#org.cdk8s.ApiObjectMetadata)
 
 Object metadata.
@@ -633,6 +709,10 @@ AppProps.builder()
 
 ##### `outdir`<sup>Optional</sup> <a name="org.cdk8s.AppProps.property.outdir"></a>
 
+```java
+public java.lang.String getOutdir();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* CDK8S_OUTDIR if defined, otherwise "dist"
 
@@ -642,6 +722,10 @@ The directory to output Kubernetes manifests.
 
 ##### `yamlOutputType`<sup>Optional</sup> <a name="org.cdk8s.AppProps.property.yamlOutputType"></a>
 
+```java
+public YamlOutputType getYamlOutputType();
+```
+
 - *Type:* [`org.cdk8s.YamlOutputType`](#org.cdk8s.YamlOutputType)
 - *Default:* YamlOutputType.FILE_PER_CHART
 
@@ -664,6 +748,10 @@ ChartProps.builder()
 
 ##### `labels`<sup>Optional</sup> <a name="org.cdk8s.ChartProps.property.labels"></a>
 
+```java
+public java.util.Map<java.lang.String, java.lang.String> getLabels();
+```
+
 - *Type:* java.util.Map<java.lang.String, `java.lang.String`>
 - *Default:* no common labels
 
@@ -673,6 +761,10 @@ Labels to apply to all resources in this chart.
 
 ##### `namespace`<sup>Optional</sup> <a name="org.cdk8s.ChartProps.property.namespace"></a>
 
+```java
+public java.lang.String getNamespace();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* no namespace is synthesized (usually this implies "default")
 
@@ -698,6 +790,10 @@ GroupVersionKind.builder()
 
 ##### `apiVersion`<sup>Required</sup> <a name="org.cdk8s.GroupVersionKind.property.apiVersion"></a>
 
+```java
+public java.lang.String getApiVersion();
+```
+
 - *Type:* `java.lang.String`
 
 The object's API version (e.g. `authorization.k8s.io/v1`).
@@ -706,6 +802,10 @@ The object's API version (e.g. `authorization.k8s.io/v1`).
 
 ##### `kind`<sup>Required</sup> <a name="org.cdk8s.GroupVersionKind.property.kind"></a>
 
+```java
+public java.lang.String getKind();
+```
+
 - *Type:* `java.lang.String`
 
 The object kind.
@@ -732,6 +832,10 @@ HelmProps.builder()
 
 ##### `chart`<sup>Required</sup> <a name="org.cdk8s.HelmProps.property.chart"></a>
 
+```java
+public java.lang.String getChart();
+```
+
 - *Type:* `java.lang.String`
 
 The chart name to use. It can be a chart from a helm repository or a local directory.
@@ -742,6 +846,10 @@ This name is passed to `helm template` and has all the relevant semantics.
 
 ##### `helmExecutable`<sup>Optional</sup> <a name="org.cdk8s.HelmProps.property.helmExecutable"></a>
 
+```java
+public java.lang.String getHelmExecutable();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* "helm"
 
@@ -751,6 +859,10 @@ The local helm executable to use in order to create the manifest the chart.
 
 ##### `helmFlags`<sup>Optional</sup> <a name="org.cdk8s.HelmProps.property.helmFlags"></a>
 
+```java
+public java.util.List<java.lang.String> getHelmFlags();
+```
+
 - *Type:* java.util.List<`java.lang.String`>
 - *Default:* []
 
@@ -760,6 +872,10 @@ Additional flags to add to the `helm` execution.
 
 ##### `releaseName`<sup>Optional</sup> <a name="org.cdk8s.HelmProps.property.releaseName"></a>
 
+```java
+public java.lang.String getReleaseName();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* if unspecified, a name will be allocated based on the construct path
 
@@ -771,6 +887,10 @@ The release name.
 
 ##### `values`<sup>Optional</sup> <a name="org.cdk8s.HelmProps.property.values"></a>
 
+```java
+public java.util.Map<java.lang.String, java.lang.Object> getValues();
+```
+
 - *Type:* java.util.Map<java.lang.String, `java.lang.Object`>
 - *Default:* If no values are specified, chart will use the defaults.
 
@@ -792,6 +912,10 @@ IncludeProps.builder()
 
 ##### `url`<sup>Required</sup> <a name="org.cdk8s.IncludeProps.property.url"></a>
 
+```java
+public java.lang.String getUrl();
+```
+
 - *Type:* `java.lang.String`
 
 Local file path or URL which includes a Kubernetes YAML manifest.
@@ -817,6 +941,10 @@ NameOptions.builder()
 
 ##### `delimiter`<sup>Optional</sup> <a name="org.cdk8s.NameOptions.property.delimiter"></a>
 
+```java
+public java.lang.String getDelimiter();
+```
+
 - *Type:* `java.lang.String`
 - *Default:* "-"
 
@@ -826,6 +954,10 @@ Delimiter to use between components.
 
 ##### `extra`<sup>Optional</sup> <a name="org.cdk8s.NameOptions.property.extra"></a>
 
+```java
+public java.util.List<java.lang.String> getExtra();
+```
+
 - *Type:* java.util.List<`java.lang.String`>
 - *Default:* [] use the construct path components
 
@@ -835,6 +967,10 @@ Extra components to include in the name.
 
 ##### `includeHash`<sup>Optional</sup> <a name="org.cdk8s.NameOptions.property.includeHash"></a>
 
+```java
+public java.lang.Boolean getIncludeHash();
+```
+
 - *Type:* `java.lang.Boolean`
 - *Default:* true
 
@@ -844,6 +980,10 @@ Include a short hash as last part of the name.
 
 ##### `maxLen`<sup>Optional</sup> <a name="org.cdk8s.NameOptions.property.maxLen"></a>
 
+```java
+public java.lang.Number getMaxLen();
+```
+
 - *Type:* `java.lang.Number`
 - *Default:* 63
 
@@ -867,6 +1007,10 @@ SizeConversionOptions.builder()
 
 ##### `rounding`<sup>Optional</sup> <a name="org.cdk8s.SizeConversionOptions.property.rounding"></a>
 
+```java
+public SizeRoundingBehavior getRounding();
+```
+
 - *Type:* [`org.cdk8s.SizeRoundingBehavior`](#org.cdk8s.SizeRoundingBehavior)
 - *Default:* SizeRoundingBehavior.FAIL
 
@@ -890,6 +1034,10 @@ TimeConversionOptions.builder()
 
 ##### `integral`<sup>Optional</sup> <a name="org.cdk8s.TimeConversionOptions.property.integral"></a>
 
+```java
+public java.lang.Boolean getIntegral();
+```
+
 - *Type:* `java.lang.Boolean`
 - *Default:* true
 
@@ -1070,6 +1218,10 @@ public toJson()
 
 ##### `name`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadataDefinition.property.name"></a>
 
+```java
+public java.lang.String getName();
+```
+
 - *Type:* `java.lang.String`
 
 The name of the API object.
@@ -1083,6 +1235,10 @@ construct path to generate a DNS-compatible name for the resource.
 
 ##### `namespace`<sup>Optional</sup> <a name="org.cdk8s.ApiObjectMetadataDefinition.property.namespace"></a>
 
+```java
+public java.lang.String getNamespace();
+```
+
 - *Type:* `java.lang.String`
 
 The object's namespace.
@@ -1130,6 +1286,10 @@ public topology()
 
 ##### `root`<sup>Required</sup> <a name="org.cdk8s.DependencyGraph.property.root"></a>
 
+```java
+public DependencyVertex getRoot();
+```
+
 - *Type:* [`org.cdk8s.DependencyVertex`](#org.cdk8s.DependencyVertex)
 
 Returns the root of the graph.
@@ -1188,6 +1348,10 @@ public topology()
 
 ##### `inbound`<sup>Required</sup> <a name="org.cdk8s.DependencyVertex.property.inbound"></a>
 
+```java
+public java.util.List<DependencyVertex> getInbound();
+```
+
 - *Type:* java.util.List<[`org.cdk8s.DependencyVertex`](#org.cdk8s.DependencyVertex)>
 
 Returns the parents of the vertex (i.e dependants).
@@ -1196,6 +1360,10 @@ Returns the parents of the vertex (i.e dependants).
 
 ##### `outbound`<sup>Required</sup> <a name="org.cdk8s.DependencyVertex.property.outbound"></a>
 
+```java
+public java.util.List<DependencyVertex> getOutbound();
+```
+
 - *Type:* java.util.List<[`org.cdk8s.DependencyVertex`](#org.cdk8s.DependencyVertex)>
 
 Returns the children of the vertex (i.e dependencies).
@@ -1204,6 +1372,10 @@ Returns the children of the vertex (i.e dependencies).
 
 ##### `value`<sup>Optional</sup> <a name="org.cdk8s.DependencyVertex.property.value"></a>
 
+```java
+public IConstruct getValue();
+```
+
 - *Type:* [`software.constructs.IConstruct`](#software.constructs.IConstruct)
 
 Returns the IConstruct this graph vertex represents.