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:

HasMetadata, KubernetesResource, Serializable
```
public abstract class CustomResource<S,T>
extends Object
implements 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 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, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

Constructor Summary

Constructors
Constructor Description

CustomResource()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getApiVersion()`
`static String[]`	`getCategories(Class<?> clazz)`	Retrieves the categories associated with this CustomResource or an empty array if none was provided
`String`	`getCRDName()`
`static String`	`getCRDName(Class<?> clazz)`	Computes the name of the Custom Resource Definition (CRD) associated with the specified CustomResource.
`static boolean`	`getDeprecated(Class<?> clazz)`
`String`	`getDeprecationWarning()`
`static String`	`getDeprecationWarning(Class<?> clazz)`
`String`	`getGroup()`
`String`	`getKind()`
`ObjectMeta`	`getMetadata()`
`String`	`getPlural()`
`String`	`getScope()`	Retrieves the scope that this CustomResource targets
`static boolean`	`getServed(Class<?> clazz)`
`static String[]`	`getShortNames(Class<?> clazz)`	Retrieves the short names associated with this CustomResource or an empty array if none was provided
`String`	`getSingular()`
`S`	`getSpec()`
`T`	`getStatus()`
`static boolean`	`getStorage(Class<?> 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`	`isDeprecated()`
`boolean`	`isServed()`
`boolean`	`isStorage()`
`void`	`setApiVersion(String version)`
`void`	`setKind(String kind)`
`void`	`setMetadata(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, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, isSameResource, isSameResource, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

- Field Detail
  - spec
```
protected S spec
```
  - status
```
protected T status
```
- Constructor Detail
  - CustomResource
```
public CustomResource()
```
- Method Detail
  - getServed
```
public static boolean getServed(Class<?> clazz)
```
  - getStorage
```
public static boolean getStorage(Class<?> clazz)
```
  - getDeprecated
```
public static boolean getDeprecated(Class<?> clazz)
```
  - getDeprecationWarning
```
public static String getDeprecationWarning(Class<?> 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 HasMetadata
  - setApiVersion
```
public void setApiVersion(String version)
```
    Specified by:
    
    setApiVersion in interface HasMetadata
  - getKind
```
public String getKind()
```
    Specified by:
    
    getKind in interface HasMetadata
  - setKind
```
public void setKind(String kind)
```
  - getMetadata
```
public ObjectMeta getMetadata()
```
    Specified by:
    
    getMetadata in interface HasMetadata
  - setMetadata
```
public void setMetadata(ObjectMeta metadata)
```
    Specified by:
    
    setMetadata in interface HasMetadata
  - getPlural
```
public String getPlural()
```
    Specified by:
    
    getPlural in interface HasMetadata
  - getSingular
```
public String getSingular()
```
    Specified by:
    
    getSingular in interface 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<?> 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
  - getCategories
```
public static String[] getCategories(Class<?> clazz)
```
    Retrieves the categories associated with this CustomResource or an empty array if none was provided
    
    Parameters:
    
    clazz - the CustomResource class for which the categories are to be retrieved
    
    Returns:
    
    the categories 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()
```
  - isDeprecated
```
public boolean isDeprecated()
```
  - getDeprecationWarning
```
public String getDeprecationWarning()
```
  - 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

Class CustomResource<S,​T>

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

spec

status

Constructor Detail

CustomResource

Method Detail

getServed

getStorage

getDeprecated

getDeprecationWarning

initSpec

initStatus

toString

getApiVersion

setApiVersion

getKind

setKind

getMetadata

setMetadata

getPlural

getSingular

getCRDName

getCRDName

getShortNames

getCategories

getScope

getGroup

getVersion

isServed

isStorage

isDeprecated

getDeprecationWarning

getSpec

setSpec

getStatus

setStatus

equals

hashCode

Class CustomResource<S,T>