Packages > pkg.pkl-lang.org/pkl-k8s/k8s > k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition

CustomResourceDefinitionSpec1.1.1

Properties
Methods

class CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

Known subtypes:
Known usages:
All versions:

Properties

link

preserveUnknownFields: Boolean?Source

Deprecated.

preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage.
apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the x-kubernetes-preserve-unknown-fields: true extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
link

names: CustomResourceDefinitionNames Source

names specify the resource and kind names for the custom resource.
link

versions: Listing<CustomResourceDefinitionVersion>?Source

versions is the list of all API versions of the defined custom resource.

Optional if version is specified. The name of the first item in the versions list must match the version field if version and versions are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
link

scope: ("Cluster"|"Namespaced")?Source

scope indicates whether the defined custom resource is cluster- or namespace-scoped.

Allowed values are Cluster and Namespaced. Default is Namespaced.
link

subresources: CustomResourceSubresources?Source

subresources specify what subresources the defined custom resource has.

If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive.
link

additionalPrinterColumns: Listing<CustomResourceColumnDefinition>?Source

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 present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
link

version: String?Source

Deprecated.

version is the API version of the defined custom resource.
The custom resources are served under /apis/<group>/<version>/.... Must match the name of the first item in the versions list if version and versions are both specified. Optional if versions is specified. Deprecated: use versions instead.
link

validation: CustomResourceValidation?Source

validation describes the schema used for validation and pruning of the custom resource.

If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive.
link

conversion: CustomResourceConversion?Source

conversion defines conversion settings for the CRD.
link

group: String Source

group is the API group of the defined custom resource.

The custom resources are served under /apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>).

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.