Package org.cdk8s.plus25.k8s

Interface CustomResourceDefinitionNames

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomResourceDefinitionNames.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.493Z")
@Stability(Stable)
public interface CustomResourceDefinitionNames
extends software.amazon.jsii.JsiiSerializable

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CustomResourceDefinitionNames.Builder	builder()
default List<String>	getCategories()	categories is a list of grouped resources this custom resource belongs to (e.g.
String	getKind()	kind is the serialized kind of the resource.
default String	getListKind()	listKind is the serialized kind of the list for this resource.
String	getPlural()	plural is the plural name of the resource to serve.
default List<String>	getShortNames()	shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>.
default String	getSingular()	singular is the singular name of the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKind

@Stability(Stable)
@NotNull
String getKind()

kind is the serialized kind of the resource.

It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

getPlural

@Stability(Stable)
@NotNull
String getPlural()

plural is the plural name of the resource to serve.

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

getCategories

@Stability(Stable)
@Nullable
default List<String> getCategories()

categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

getListKind

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

listKind is the serialized kind of the list for this resource.

Defaults to "kindList".

Default: kind`List".

getShortNames

@Stability(Stable)
@Nullable
default List<String> getShortNames()

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>.

It must be all lowercase.

getSingular

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

singular is the singular name of the resource.

It must be all lowercase. Defaults to lowercased kind.

Default: lowercased `kind`.

builder

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

Returns:

a CustomResourceDefinitionNames.Builder of CustomResourceDefinitionNames