Serialization (Fabric8 :: Kubernetes :: Java Client API 6.6.1 API)

java.lang.Object
- io.fabric8.kubernetes.client.utils.Serialization

public class Serialization
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static io.fabric8.kubernetes.model.jackson.UnmatchedFieldTypeModule UNMATCHED_FIELD_TYPE_MODULE

Fields
Modifier and Type	Field and Description
`static io.fabric8.kubernetes.model.jackson.UnmatchedFieldTypeModule`	`UNMATCHED_FIELD_TYPE_MODULE`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static <T> String`	`asJson(T object)` Returns a JSON representation of the given object.
`static <T> String`	`asYaml(T object)` Returns a YAML representation of the given object.
`static void`	`clearYamlMapper()` Deprecated. to be removed in later versions
`static <T> T`	`clone(T resource)` Create a copy of the resource via serialization.
`static com.fasterxml.jackson.databind.ObjectMapper`	`jsonMapper()` `ObjectMapper` singleton instance used internally by the Kubernetes client.
`static <T> T`	`unmarshal(InputStream is)` Unmarshals a stream.
`static <T> T`	`unmarshal(InputStream is, Class<T> type)` Unmarshals an `InputStream`.
`static <T> T`	`unmarshal(InputStream is, Class<T> type, Map<String,String> parameters)` Deprecated. please directly apply `Utils.interpolateString(String, Map)` instead of passing parameters here
`static <T> T`	`unmarshal(InputStream is, Map<String,String> parameters)` Deprecated. please directly apply `Utils.interpolateString(String, Map)` instead of passing parameters here
`static <T> T`	`unmarshal(InputStream is, com.fasterxml.jackson.databind.ObjectMapper mapper)` Unmarshals a stream.
`static <T> T`	`unmarshal(InputStream is, com.fasterxml.jackson.databind.ObjectMapper mapper, Map<String,String> parameters)` Deprecated. please directly apply `Utils.interpolateString(String, Map)` instead of passing parameters here
`static <T> T`	`unmarshal(InputStream is, com.fasterxml.jackson.core.type.TypeReference<T> type)` Unmarshals an `InputStream`.
`static <T> T`	`unmarshal(InputStream is, com.fasterxml.jackson.core.type.TypeReference<T> type, Map<String,String> parameters)` Deprecated. please directly apply `Utils.interpolateString(String, Map)` instead of passing parameters here
`static <T> T`	`unmarshal(String str)` Unmarshals a `String`
`static <T> T`	`unmarshal(String str, Class<T> type)` Unmarshals a `String`
`static <T> T`	`unmarshal(String str, Class<T> type, Map<String,String> parameters)` Deprecated. please directly apply `Utils.interpolateString(String, Map)` instead of passing parameters here
`static com.fasterxml.jackson.databind.ObjectMapper`	`yamlMapper()` Deprecated. use `asYaml(Object)` or one of the unmarshal methods

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNMATCHED_FIELD_TYPE_MODULE
```
public static final io.fabric8.kubernetes.model.jackson.UnmatchedFieldTypeModule UNMATCHED_FIELD_TYPE_MODULE
```
- Method Detail
  - jsonMapper
```
public static com.fasterxml.jackson.databind.ObjectMapper jsonMapper()
```
    ObjectMapper singleton instance used internally by the Kubernetes client.
    The ObjectMapper has an UnmatchedFieldTypeModule module registered. This module allows the client to work with Resources that contain properties that don't match the target field type. This is especially useful and necessary to work with OpenShift Templates.
    n.b. the use of this module gives precedence to properties present in the additionalProperties Map present in most KubernetesResource instances. If a property is both defined in the Map and in the original field, the one from the additionalProperties Map will be serialized.
  - yamlMapper
```
@Deprecated
public static com.fasterxml.jackson.databind.ObjectMapper yamlMapper()
```
    Deprecated. use asYaml(Object) or one of the unmarshal methods
    
    ObjectMapper singleton instance used internally by the Kubernetes client.
    The ObjectMapper has an UnmatchedFieldTypeModule module registered. This module allows the client to work with Resources that contain properties that don't match the target field type. This is especially useful and necessary to work with OpenShift Templates.
    n.b. the use of this module gives precedence to properties present in the additionalProperties Map present in most KubernetesResource instances. If a property is both defined in the Map and in the original field, the one from the additionalProperties Map will be serialized.
  - clearYamlMapper
```
@Deprecated
public static void clearYamlMapper()
```
    Deprecated. to be removed in later versions
    
    Allow application to clear out the YAML mapper in order to allow its garbage collection. This is useful because in a lot of cases the YAML mapper is only need at application startup when the client is created, so there is no reason to keep the very heavy (in terms of memory) mapper around indefinitely.
  - asJson
```
public static <T> String asJson(T object)
```
    Returns a JSON representation of the given object.
    If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that overrides a field of the provided object, the Map entry will take precedence upon serialization. Properties won't be duplicated.
    
    Type Parameters:
    
    T - the type of the object being serialized.
    
    Parameters:
    
    object - the object to serialize.
    
    Returns:
    
    a String containing a JSON representation of the provided object.
  - asYaml
```
public static <T> String asYaml(T object)
```
    Returns a YAML representation of the given object.
    If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that overrides a field of the provided object, the Map entry will take precedence upon serialization. Properties won't be duplicated.
    
    Type Parameters:
    
    T - the type of the object being serialized.
    
    Parameters:
    
    object - the object to serialize.
    
    Returns:
    
    a String containing a JSON representation of the provided object.
  - unmarshal
```
public static <T> T unmarshal(InputStream is)
```
    Unmarshals a stream.
    The type is assumed to be KubernetesResource
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    is - The InputStream.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
@Deprecated
public static <T> T unmarshal(InputStream is,
                                          Map<String,String> parameters)
```
    Deprecated. please directly apply Utils.interpolateString(String, Map) instead of passing parameters here
    
    Unmarshals a stream optionally performing placeholder substitution to the stream.
    The type is assumed to be KubernetesResource
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    is - The InputStream.
    
    parameters - A Map with parameters for placeholder substitution.
    
    Returns:
    
    returns returns de-serialized object
  - unmarshal
```
public static <T> T unmarshal(InputStream is,
                              com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Unmarshals a stream.
    The type is assumed to be KubernetesResource
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    is - The InputStream.
    
    mapper - The ObjectMapper to use.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
@Deprecated
public static <T> T unmarshal(InputStream is,
                                          com.fasterxml.jackson.databind.ObjectMapper mapper,
                                          Map<String,String> parameters)
```
    Deprecated. please directly apply Utils.interpolateString(String, Map) instead of passing parameters here
    
    Unmarshals a stream optionally performing placeholder substitution to the stream.
    The type is assumed to be KubernetesResource
    
    Type Parameters:
    
    T - The target type.
    
    Parameters:
    
    is - The InputStream.
    
    mapper - The ObjectMapper to use.
    
    parameters - A Map with parameters for placeholder substitution.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
public static <T> T unmarshal(String str)
```
    Unmarshals a String
    The type is assumed to be KubernetesResource
    
    Type Parameters:
    
    T - template argument denoting type
    
    Parameters:
    
    str - The String.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
public static <T> T unmarshal(String str,
                              Class<T> type)
```
    Unmarshals a String
    
    Type Parameters:
    
    T - template argument denoting type
    
    Parameters:
    
    str - The String.
    
    type - The target type.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
@Deprecated
public static <T> T unmarshal(String str,
                                          Class<T> type,
                                          Map<String,String> parameters)
```
    Deprecated. please directly apply Utils.interpolateString(String, Map) instead of passing parameters here
    
    Unmarshals a String optionally performing placeholder substitution to the String.
    
    Type Parameters:
    
    T - Template argument denoting type
    
    Parameters:
    
    str - The String.
    
    type - The target type.
    
    parameters - A hashmap containing parameters
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
public static <T> T unmarshal(InputStream is,
                              Class<T> type)
```
    Unmarshals an InputStream.
    
    Type Parameters:
    
    T - Template argument denoting type
    
    Parameters:
    
    is - The InputStream.
    
    type - The type.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
@Deprecated
public static <T> T unmarshal(InputStream is,
                                          Class<T> type,
                                          Map<String,String> parameters)
```
    Deprecated. please directly apply Utils.interpolateString(String, Map) instead of passing parameters here
    
    Unmarshals an InputStream optionally performing placeholder substitution to the stream.
    
    Type Parameters:
    
    T - Template argument denoting type
    
    Parameters:
    
    is - The InputStream.
    
    type - The type.
    
    parameters - A Map with parameters for placeholder substitution.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
public static <T> T unmarshal(InputStream is,
                              com.fasterxml.jackson.core.type.TypeReference<T> type)
```
    Unmarshals an InputStream.
    
    Type Parameters:
    
    T - Template argument denoting type
    
    Parameters:
    
    is - The InputStream.
    
    type - The TypeReference.
    
    Returns:
    
    returns de-serialized object
  - unmarshal
```
@Deprecated
public static <T> T unmarshal(InputStream is,
                                          com.fasterxml.jackson.core.type.TypeReference<T> type,
                                          Map<String,String> parameters)
```
    Deprecated. please directly apply Utils.interpolateString(String, Map) instead of passing parameters here
    
    Unmarshals an InputStream optionally performing placeholder substitution to the stream.
    
    Type Parameters:
    
    T - Template argument denoting type
    
    Parameters:
    
    is - The InputStream.
    
    type - The TypeReference.
    
    parameters - A Map with parameters for placeholder substitution.
    
    Returns:
    
    returns de-serialized object
  - clone
```
public static <T> T clone(T resource)
```
    Create a copy of the resource via serialization.
    
    Returns:
    
    a deep clone of the resource
    
    Throws:
    
    IllegalArgumentException - if the cloning cannot be performed

Class Serialization

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNMATCHED_FIELD_TYPE_MODULE

Method Detail

jsonMapper

yamlMapper

clearYamlMapper

asJson

asYaml

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

unmarshal

clone