Package org.cdk8s.plus24.k8s

Interface CustomResourceDefinitionVersion

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomResourceDefinitionVersion.Jsii$Proxy

@Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
           date="2023-02-20T02:42:02.028Z")
@Stability(Stable)
public interface CustomResourceDefinitionVersion
extends software.amazon.jsii.JsiiSerializable

CustomResourceDefinitionVersion describes a version for CRD.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomResourceDefinitionVersion.Builder	A builder for CustomResourceDefinitionVersion
static class	CustomResourceDefinitionVersion.Jsii$Proxy	An implementation for CustomResourceDefinitionVersion

Method Summary

Modifier and Type	Method	Description
static CustomResourceDefinitionVersion.Builder	builder()
default List<CustomResourceColumnDefinition>	getAdditionalPrinterColumns()	additionalPrinterColumns specifies additional columns returned in Table output.
default Boolean	getDeprecated()	deprecated indicates this version of the custom resource API is deprecated.
default String	getDeprecationWarning()	deprecationWarning overrides the default warning returned to API clients.
String	getName()	name is the version name, e.g.
default CustomResourceValidation	getSchema()	schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
Boolean	getServed()	served is a flag enabling/disabling this version from being served via REST APIs.
Boolean	getStorage()	storage indicates this version should be used when persisting custom resources to storage.
default CustomResourceSubresources	getSubresources()	subresources specify what subresources this version of the defined custom resource have.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Stable)
@NotNull
String getName()

name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true.

getServed

@Stability(Stable)
@NotNull
Boolean getServed()

served is a flag enabling/disabling this version from being served via REST APIs.

getStorage

@Stability(Stable)
@NotNull
Boolean getStorage()

storage indicates this version should be used when persisting custom resources to storage.

There must be exactly one version with storage=true.

getAdditionalPrinterColumns

@Stability(Stable)
@Nullable
default List<CustomResourceColumnDefinition> getAdditionalPrinterColumns()

additionalPrinterColumns specifies additional columns returned in Table output.

See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.

getDeprecated

@Stability(Stable)
@Nullable
default Boolean getDeprecated()

deprecated indicates this version of the custom resource API is deprecated.

When set to true, API requests to this version receive a warning header in the server response. Defaults to false.

Default: false.

getDeprecationWarning

@Stability(Stable)
@Nullable
default String getDeprecationWarning()

deprecationWarning overrides the default warning returned to API clients.

May only be set when deprecated is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.

getSchema

@Stability(Stable)
@Nullable
default CustomResourceValidation getSchema()

schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.

getSubresources

@Stability(Stable)
@Nullable
default CustomResourceSubresources getSubresources()

subresources specify what subresources this version of the defined custom resource have.

builder

@Stability(Stable)
static CustomResourceDefinitionVersion.Builder builder()

Returns:

a CustomResourceDefinitionVersion.Builder of CustomResourceDefinitionVersion