io.fabric8.kubernetes.client

Class CustomResource<S,T>

java.lang.Object

io.fabric8.kubernetes.client.CustomResource<S,T>

Type Parameters:

S - the class providing the Spec part of this CustomResource

T - the class providing the Status part of this CustomResource

All Implemented Interfaces:

io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

public abstract class CustomResource<S,T>
extends Object
implements io.fabric8.kubernetes.api.model.HasMetadata

A base class for implementing a custom resource kind. Implementations must be annotated with Group and Version. Properties are set up automatically as follows:

• group is set using HasMetadata.getGroup(Class)
• version is set using HasMetadata.getVersion(Class)
• singular is set using getSingular(Class)
• plural is set using getPlural(Class)
• computed CRD name using getCRDName(Class)

In addition, setApiVersion(String) and setKind(String) are overridden to not do anything since these values are set.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_SCOPE
static String	NAMESPACE_SCOPE
protected S	spec
protected T	status

Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER

Constructor Summary

Constructors

Constructor and Description
CustomResource()

Method Summary

Modifier and Type	Method and Description
String	getApiVersion()
String	getCRDName()
static String	getCRDName(Class<? extends CustomResource> clazz) Computes the name of the Custom Resource Definition (CRD) associated with the specified CustomResource.
String	getGroup()
String	getKind()
io.fabric8.kubernetes.api.model.ObjectMeta	getMetadata()
String	getPlural()
static String	getPlural(Class<? extends io.fabric8.kubernetes.api.model.HasMetadata> clazz) Retrieves the plural form associated with the specified CustomResource if annotated with Plural or computes a default value using the value returned by getSingular(Class) as input to Pluralize.toPlural(String).
String	getScope() Retrieves the scope that this CustomResource targets
static boolean	getServed(Class<? extends CustomResource> clazz)
String	getSingular()
static String	getSingular(Class<? extends io.fabric8.kubernetes.api.model.HasMetadata> clazz) Retrieves the singular form associated with the specified CustomResource as defined by the Singular annotation or computes a default value (lower-cased version of the value returned by HasMetadata.getKind(Class)) if the annotation is not present.
S	getSpec()
T	getStatus()
static boolean	getStorage(Class<? extends CustomResource> clazz)
String	getVersion()
protected S	initSpec() Override to provide your own Spec instance
protected T	initStatus() Override to provide your own Status instance
boolean	isServed()
boolean	isStorage()
void	setApiVersion(String version)
void	setKind(String kind)
void	setMetadata(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
void	setSpec(S spec)
void	setStatus(T status)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

addFinalizer, getApiVersion, getGroup, getKind, getVersion, hasFinalizer, isFinalizerValid, isMarkedForDeletion, removeFinalizer

Field Detail

NAMESPACE_SCOPE

public static final String NAMESPACE_SCOPE

See Also:

Constant Field Values

CLUSTER_SCOPE

public static final String CLUSTER_SCOPE

See Also:

Constant Field Values

spec

protected S spec

status

protected T status

Constructor Detail

CustomResource

public CustomResource()

Method Detail

getServed

public static boolean getServed(Class<? extends CustomResource> clazz)

getStorage

public static boolean getStorage(Class<? extends CustomResource> clazz)

initSpec

protected S initSpec()

Override to provide your own Spec instance

Returns:

a new Spec instance

initStatus

protected T initStatus()

Override to provide your own Status instance

Returns:

a new Status instance

toString

public String toString()

Overrides:

toString in class Object

getApiVersion

public String getApiVersion()

Specified by:

getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

setApiVersion

public void setApiVersion(String version)

Specified by:

setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

getKind

public String getKind()

Specified by:

getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

setKind

public void setKind(String kind)

getMetadata

public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()

Specified by:

getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

setMetadata

public void setMetadata(io.fabric8.kubernetes.api.model.ObjectMeta metadata)

Specified by:

setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

getPlural

public static String getPlural(Class<? extends io.fabric8.kubernetes.api.model.HasMetadata> clazz)

Retrieves the plural form associated with the specified CustomResource if annotated with Plural or computes a default value using the value returned by getSingular(Class) as input to Pluralize.toPlural(String).

Parameters:

clazz - the CustomResource whose plural form we want to retrieve

Returns:

the plural form defined by the Plural annotation or a computed default value

getPlural

public String getPlural()

getSingular

public static String getSingular(Class<? extends io.fabric8.kubernetes.api.model.HasMetadata> clazz)

Retrieves the singular form associated with the specified CustomResource as defined by the Singular annotation or computes a default value (lower-cased version of the value returned by HasMetadata.getKind(Class)) if the annotation is not present.

Parameters:

clazz - the CustomResource whose singular form we want to retrieve

Returns:

the singular form defined by the Singular annotation or a computed default value

getSingular

public String getSingular()

getCRDName

public static String getCRDName(Class<? extends CustomResource> clazz)

Computes the name of the Custom Resource Definition (CRD) associated with the specified CustomResource. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/ for more details.

Parameters:

clazz - the CustomResource whose CRD name we want to compute

Returns:

the CRD name associated with the CustomResource

getCRDName

public String getCRDName()

getScope

public String getScope()

Retrieves the scope that this CustomResource targets

Returns:

the scope that this CustomResource targets. Possible values are CLUSTER_SCOPE or NAMESPACE_SCOPE.

getGroup

public String getGroup()

getVersion

public String getVersion()

isServed

public boolean isServed()

isStorage

public boolean isStorage()

getSpec

public S getSpec()

setSpec

public void setSpec(S spec)

getStatus

public T getStatus()

setStatus

public void setStatus(T status)