HasMetadata (Fabric8 :: Kubernetes Model

All Superinterfaces:

KubernetesResource, Serializable

All Known Implementing Classes:

APIService, Binding, ComponentStatus, ConfigMap, Endpoints, Event, GenericKubernetesResource, LimitRange, Namespace, Node, PersistentVolume, PersistentVolumeClaim, Pod, PodTemplate, ReplicationController, ResourceQuota, Secret, Service, ServiceAccount
```
public interface HasMetadata
extends KubernetesResource
```
Represents any KubernetesResource which possesses a ObjectMeta and is associated with a kind and API version.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DNS_LABEL_END`
`static String`	`DNS_LABEL_REGEXP`
`static String`	`DNS_LABEL_START`
`static Pattern`	`FINALIZER_NAME_MATCHER` Pattern that checks the format of finalizer identifiers, which should be in `<domain name>/<finalizer name>` format.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`addFinalizer(String finalizer)` Adds the specified finalizer to this `HasMetadata` if it's valid.
`default String`	`getApiVersion()`
`static String`	`getApiVersion(Class<?> clazz)` Computes the `apiVersion` associated with this HasMetadata implementation.
`static String`	`getGroup(Class<?> clazz)` Retrieves the group associated with the specified HasMetadata as defined by the `Group` annotation.
`default String`	`getKind()`
`static String`	`getKind(Class<?> clazz)` Retrieves the kind associated with the specified HasMetadata implementation.
`ObjectMeta`	`getMetadata()`
`default String`	`getPlural()`
`static String`	`getPlural(Class<?> clazz)` Retrieves the plural form associated with the specified class if annotated with `Plural` or computes a default value using the value returned by `getSingular(Class)` as input to `Pluralize.toPlural(String)`.
`default String`	`getSingular()`
`static String`	`getSingular(Class<?> clazz)` Retrieves the singular form associated with the specified class as defined by the `Singular` annotation or computes a default value (lower-cased version of the value returned by `getKind(Class)`) if the annotation is not present.
`static String`	`getVersion(Class<?> clazz)` Retrieves the version associated with the specified HasMetadata as defined by the `Version` annotation.
`default boolean`	`hasFinalizer(String finalizer)` Determines whether this `HasMetadata` holds the specified finalizer.
`default boolean`	`isFinalizerValid(String finalizer)` Determines whether the specified finalizer is valid according to the finalizer specification.
`default boolean`	`isMarkedForDeletion()` Determines whether this `HasMetadata` is marked for deletion or not.
`default boolean`	`removeFinalizer(String finalizer)` Removes the specified finalizer if it's held by this `HasMetadata`.
`void`	`setApiVersion(String version)`
`void`	`setMetadata(ObjectMeta metadata)`

- Field Detail
  - DNS_LABEL_START
```
static final String DNS_LABEL_START
```
    See Also:
    
    Constant Field Values
  - DNS_LABEL_END
```
static final String DNS_LABEL_END
```
    See Also:
    
    Constant Field Values
  - DNS_LABEL_REGEXP
```
static final String DNS_LABEL_REGEXP
```
    See Also:
    
    Constant Field Values
  - FINALIZER_NAME_MATCHER
```
static final Pattern FINALIZER_NAME_MATCHER
```
    Pattern that checks the format of finalizer identifiers, which should be in <domain name>/<finalizer name> format.
- Method Detail
  - getMetadata
```
ObjectMeta getMetadata()
```
  - setMetadata
```
void setMetadata(ObjectMeta metadata)
```
  - getKind
```
static String getKind(Class<?> clazz)
```
    Retrieves the kind associated with the specified HasMetadata implementation. If the implementation is annotated with Kind, the annotation value will be used, otherwise the value will be derived from the class name.
    
    Parameters:
    
    clazz - the HasMetadata implementation whose Kind we want to retrieve
    
    Returns:
    
    the kind associated with the specified HasMetadata
  - getKind
```
default String getKind()
```
  - getApiVersion
```
static String getApiVersion(Class<?> clazz)
```
    Computes the apiVersion associated with this HasMetadata implementation. The value is derived from the Group and Version annotations.
    
    Parameters:
    
    clazz - the HasMetadata whose apiVersion we want to compute
    
    Returns:
    
    the computed apiVersion or null if neither Group or Version annotations are present
    
    Throws:
    
    IllegalArgumentException - if only one of Group or Version is provided
  - getGroup
```
static String getGroup(Class<?> clazz)
```
    Retrieves the group associated with the specified HasMetadata as defined by the Group annotation.
    
    Parameters:
    
    clazz - the HasMetadata whose group we want to retrieve
    
    Returns:
    
    the associated group or null if the HasMetadata is not annotated with Group
  - getVersion
```
static String getVersion(Class<?> clazz)
```
    Retrieves the version associated with the specified HasMetadata as defined by the Version annotation.
    
    Parameters:
    
    clazz - the HasMetadata whose version we want to retrieve
    
    Returns:
    
    the associated version or null if the HasMetadata is not annotated with Version
  - getApiVersion
```
default String getApiVersion()
```
  - setApiVersion
```
void setApiVersion(String version)
```
  - getPlural
```
static String getPlural(Class<?> clazz)
```
    Retrieves the plural form associated with the specified class 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
```
default String getPlural()
```
  - getSingular
```
static String getSingular(Class<?> clazz)
```
    Retrieves the singular form associated with the specified class as defined by the Singular annotation or computes a default value (lower-cased version of the value returned by getKind(Class)) if the annotation is not present.
    
    Parameters:
    
    clazz - the class whose singular form we want to retrieve
    
    Returns:
    
    the singular form defined by the Singular annotation or a computed default value
  - getSingular
```
default String getSingular()
```
  - isMarkedForDeletion
```
default boolean isMarkedForDeletion()
```
    Determines whether this HasMetadata is marked for deletion or not.
    
    Returns:
    
    true if the cluster marked this HasMetadata for deletion, false otherwise
  - hasFinalizer
```
default boolean hasFinalizer(String finalizer)
```
    Determines whether this HasMetadata holds the specified finalizer.
    
    Parameters:
    
    finalizer - the identifier of the finalizer we want to check
    
    Returns:
    
    true if this HasMetadata holds the specified finalizer, false otherwise
  - addFinalizer
```
default boolean addFinalizer(String finalizer)
```
    Adds the specified finalizer to this HasMetadata if it's valid. See isFinalizerValid(String).
    
    Parameters:
    
    finalizer - the identifier of the finalizer to add to this HasMetadata in <domain name>/<finalizer name> format.
    
    Returns:
    
    true if the finalizer was successfully added, false otherwise (in particular, if the object is marked for deletion)
    
    Throws:
    
    IllegalArgumentException - if the specified finalizer identifier is null or is invalid
  - isFinalizerValid
```
default boolean isFinalizerValid(String finalizer)
```
    Determines whether the specified finalizer is valid according to the finalizer specification.
    
    Parameters:
    
    finalizer - the identifier of the finalizer which validity we want to check
    
    Returns:
    
    true if the identifier is valid, false otherwise
  - removeFinalizer
```
default boolean removeFinalizer(String finalizer)
```
    Removes the specified finalizer if it's held by this HasMetadata.
    
    Parameters:
    
    finalizer - the identifier of the finalizer we want to remove
    
    Returns:
    
    true if the finalizer was successfully removed, false otherwise

Interface HasMetadata

Field Summary

Method Summary

Field Detail

DNS_LABEL_START

DNS_LABEL_END

DNS_LABEL_REGEXP

FINALIZER_NAME_MATCHER

Method Detail

getMetadata

setMetadata

getKind

getKind

getApiVersion

getGroup

getVersion

getApiVersion

setApiVersion

getPlural

getPlural

getSingular

getSingular

isMarkedForDeletion

hasFinalizer

addFinalizer

isFinalizerValid

removeFinalizer