io.dekorate.crd.annotation

Annotation Type CustomResource

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

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.
Scope	scope The resource scope.
String	shortName The custom resource short name.
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:

""

scope

public abstract Scope scope

The resource scope.

Returns:

The scope, defaults to Namespaced.

Default:

io.dekorate.crd.confg.Scope.Namespaced