io.dekorate.crd.annotation

Annotation Type CustomResource

@Target(value={CONSTRUCTOR,TYPE})
 @Retention(value=SOURCE)
public @interface CustomResource

This indicates that the annotated classs represents a `CustomResource` from which a `CustomResourceDefinition` needs to be generated.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	group The custom resource group.
String	kind The custom resource kind.
String	name The custom resource name.
String	plural The custom resource plural name.
Scale	scale The scale configuration.
Scope	scope The resource scope.
boolean	served Flag that indicates that version is enabled.
String	shortName The custom resource short name.
Class	status The class that defines the status.
boolean	storage Flag that indicates that the version is the storage version.
String	version The custom resource version.

Element Detail

group

public abstract String group

The custom resource group.

Returns:

The group, or the package name if group if empty.

Default:

""

kind

public abstract String kind

The custom resource kind.

Returns:

The kind or the classname if kind is empty.

Default:

""

name

public abstract String name

The custom resource name.

Returns:

The name, or the kind in lower case if empty.

Default:

""

plural

public abstract String plural

The custom resource plural name.

Returns:

The plural, or the actual name converted automatically to plural.

Default:

""

shortName

public abstract String shortName

The custom resource short name.

Returns:

The short name, or a calculated short name (based on camelcase) if shortname is empty.

Default:

""

version

public abstract String version

The custom resource version.

Returns:

The version, or the project version if empty.

Default:

""

served

public abstract boolean served

Flag that indicates that version is enabled.

Returns:

true if version is enabled.

Default:

true

storage

public abstract boolean storage

Flag that indicates that the version is the storage version. Only one version should be set as 'storage' at a time.

Returns:

true if version is the storage version.

Default:

false

scope

public abstract Scope scope

The resource scope.

Returns:

The scope, defaults to Namespaced.

Default:

io.dekorate.crd.config.Scope.Namespaced

scale

public abstract Scale scale

The scale configuration.

Returns:

the scale configuration.

Default:

@io.dekorate.crd.annotation.Scale

status

public abstract Class status

The class that defines the status. When no status is present, autodetection will be attempted.

Returns:

The class or Autodetect.class if no class is specified.

Default:

io.dekorate.crd.annotation.Autodetect.class