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 HasMetadata.getSingular(Class)
• plural is set using HasMetadata.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
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
boolean	equals(Object o)
String	getApiVersion()
String	getCRDName()
static String	getCRDName(Class<?> 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<?> clazz) Deprecated. use HasMetadata.getPlural(Class) instead
String	getScope() Retrieves the scope that this CustomResource targets
static boolean	getServed(Class<? extends CustomResource> clazz)
static String[]	getShortNames(Class<? extends CustomResource> clazz) Retrieves the short names associated with this CustomResource or an empty array if none was provided
String	getSingular()
static String	getSingular(Class<?> clazz) Deprecated. use HasMetadata.getSingular(Class) instead
S	getSpec()
T	getStatus()
static boolean	getStorage(Class<? extends CustomResource> clazz)
String	getVersion()
int	hashCode()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addFinalizer, addOwnerReference, addOwnerReference, getApiVersion, getFinalizers, getFullResourceName, getFullResourceName, getFullResourceName, getGroup, getKind, getOwnerReferenceFor, getOwnerReferenceFor, getVersion, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, isFinalizerValid, isMarkedForDeletion, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference, sanitizeAndValidate, validateFinalizer

Field Detail

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 or null if the responsibility of instantiating the Spec is left to users of this CustomResource

initStatus

protected T initStatus()

Override to provide your own Status instance

Returns:

a new Status instance or null if the responsibility of instantiating the Status is left to users of this CustomResource

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

@Deprecated
public static String getPlural(Class<?> clazz)

Deprecated. use HasMetadata.getPlural(Class) instead

Specified by:

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

getPlural

public String getPlural()

Specified by:

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

getSingular

@Deprecated
public static String getSingular(Class<?> clazz)

Deprecated. use HasMetadata.getSingular(Class) instead

Specified by:

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

getSingular

public String getSingular()

Specified by:

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

getCRDName

public static String getCRDName(Class<?> 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()

getShortNames

public static String[] getShortNames(Class<? extends CustomResource> clazz)

Retrieves the short names associated with this CustomResource or an empty array if none was provided

Parameters:

clazz - the CustomResource class which short names we want to retrieve

Returns:

the short names associated with this CustomResource or an empty array if none was provided

getScope

public String getScope()

Retrieves the scope that this CustomResource targets

Returns:

the scope that this CustomResource targets. Possible values are Scope.CLUSTER or Scope.NAMESPACED.

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)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object