Package io.fabric8.kubernetes.client.utils

Class KubernetesResourceUtil

java.lang.Object
io.fabric8.kubernetes.client.utils.KubernetesResourceUtil
public class KubernetesResourceUtil
extends Object

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int KUBERNETES_DNS1123_LABEL_MAX_LENGTH  
    static Pattern KUBERNETES_DNS1123_LABEL_REGEX  

  • Method Summary

    Modifier and Type Method Description
    protected static String getAdditionalPropertyText​(Map<String,​Object> additionalProperties, String name)
    Used to get additional properties from Object's metadata
    static io.fabric8.kubernetes.api.model.OwnerReference getControllerUid​(io.fabric8.kubernetes.api.model.HasMetadata resource)  
    static String getKind​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Returns the kind of the entity
    static Map<String,​String> getLabels​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
    Returns the labels of the given metadata object or an empty map if the metadata or labels are null
    static String getName​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Returns name of the resource from it's Metadata
    static String getName​(io.fabric8.kubernetes.api.model.ObjectMeta entity)
    Returns name of the resource from it's Metadata
    static String getNamespace​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Getting namespace from Kubernetes Resource
    static String getNamespace​(io.fabric8.kubernetes.api.model.ObjectMeta entity)
    Null safe get operation for getting namespace from Kubernetes Resource's MetaData
    static Map<String,​String> getOrCreateAnnotations​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Null safe get for fetching annotations from MetaData of Kubernetes Resource
    static Map<String,​String> getOrCreateLabels​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Null safe get method for getting Labels of a Kubernetes Resource
    static io.fabric8.kubernetes.api.model.ObjectMeta getOrCreateMetadata​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Null safe operation for getting Metadata of a Kubernetes resource
    static String getQualifiedName​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Returns Qualified name for the specified Kubernetes Resource
    static String getResourceVersion​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Returns the resource version for the entity or null if it does not have one
    static boolean hasController​(io.fabric8.kubernetes.api.model.HasMetadata resource)
    Checks whether the resource has some controller(parent) or not.
    static boolean hasResourceVersion​(io.fabric8.kubernetes.api.model.HasMetadata entity)
    Returns true if this entity has a valid non blank resourceVersion in its metadata
    static boolean isValidLabelOrAnnotation​(Map<String,​String> map)
    Validates labels/annotations of Kubernetes resources
    static boolean isValidName​(String name)
    Validates name of Kubernetes Resource name, label or annotation based on Kubernetes regex
    static String sanitizeName​(String name)
    Returns an identifier from the given string that can be used as resource name.
    static void sortEventListBasedOnTimestamp​(List<io.fabric8.kubernetes.api.model.Event> eventList)  

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • getResourceVersion

      public static String getResourceVersion​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Returns the resource version for the entity or null if it does not have one
      Parameters:
      entity - entity provided
      Returns:
      returns resource version of provided entity

    • getKind

      public static String getKind​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Returns the kind of the entity
      Parameters:
      entity - provided entity
      Returns:
      returns kind of entity provided

    • getQualifiedName

      public static String getQualifiedName​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Returns Qualified name for the specified Kubernetes Resource
      Parameters:
      entity - Kubernetes resource
      Returns:
      returns qualified name

    • getName

      public static String getName​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Returns name of the resource from it's Metadata
      Parameters:
      entity - Kubernetes resource
      Returns:
      returns name of resource

    • hasResourceVersion

      public static boolean hasResourceVersion​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Returns true if this entity has a valid non blank resourceVersion in its metadata
      Parameters:
      entity - entity provided
      Returns:
      returns a boolean value indicating whether it has a valid non blank resourceVersion

    • getName

      public static String getName​(io.fabric8.kubernetes.api.model.ObjectMeta entity)
      Returns name of the resource from it's Metadata
      Parameters:
      entity - MetaData of kubernetes resource
      Returns:
      returns name of resource

    • getAdditionalPropertyText

      protected static String getAdditionalPropertyText​(Map<String,​Object> additionalProperties, String name)
      Used to get additional properties from Object's metadata
      Parameters:
      additionalProperties - additional properties
      name - name of resource
      Returns:
      returns additional property text

    • getNamespace

      public static String getNamespace​(io.fabric8.kubernetes.api.model.ObjectMeta entity)
      Null safe get operation for getting namespace from Kubernetes Resource's MetaData
      Parameters:
      entity - Kubernetes Resource
      Returns:
      returns namespace as plain string

    • getNamespace

      public static String getNamespace​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Getting namespace from Kubernetes Resource
      Parameters:
      entity - Kubernetes Resource
      Returns:
      returns namespace as plain string

    • getOrCreateAnnotations

      public static Map<String,​String> getOrCreateAnnotations​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Null safe get for fetching annotations from MetaData of Kubernetes Resource
      Parameters:
      entity - Kubernetes resource
      Returns:
      returns a hashmap containing annotations

    • sanitizeName

      public static String sanitizeName​(String name)
      Returns an identifier from the given string that can be used as resource name.
      Parameters:
      name - which needs to be sanitized
      Returns:
      sanitized name

    • getOrCreateLabels

      public static Map<String,​String> getOrCreateLabels​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Null safe get method for getting Labels of a Kubernetes Resource
      Parameters:
      entity - Kubernetes Resource
      Returns:
      returns a hashmap containing labels

    • getLabels

      public static Map<String,​String> getLabels​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      Returns the labels of the given metadata object or an empty map if the metadata or labels are null
      Parameters:
      metadata - ObjectMeta for resource's metadata
      Returns:
      returns labels as a hashmap

    • getOrCreateMetadata

      public static io.fabric8.kubernetes.api.model.ObjectMeta getOrCreateMetadata​(io.fabric8.kubernetes.api.model.HasMetadata entity)
      Null safe operation for getting Metadata of a Kubernetes resource
      Parameters:
      entity - Kubernetes Resource
      Returns:
      returns ObjectMeta as metadata

    • isValidName

      public static boolean isValidName​(String name)
      Validates name of Kubernetes Resource name, label or annotation based on Kubernetes regex
      Parameters:
      name - Name of resource/label/annotation
      Returns:
      returns a boolean value indicating whether it's valid or not

    • isValidLabelOrAnnotation

      public static boolean isValidLabelOrAnnotation​(Map<String,​String> map)
      Validates labels/annotations of Kubernetes resources
      Parameters:
      map - Label/Annotation of resource
      Returns:
      returns a boolean value inidicating whether it's valid or not

    • hasController

      public static boolean hasController​(io.fabric8.kubernetes.api.model.HasMetadata resource)
      Checks whether the resource has some controller(parent) or not.
      Parameters:
      resource - resource
      Returns:
      boolean value indicating whether it's a child or not.

    • getControllerUid

      public static io.fabric8.kubernetes.api.model.OwnerReference getControllerUid​(io.fabric8.kubernetes.api.model.HasMetadata resource)

    • sortEventListBasedOnTimestamp

      public static void sortEventListBasedOnTimestamp​(List<io.fabric8.kubernetes.api.model.Event> eventList)