io.kubernetes.client.util

Class Yaml

java.lang.Object

io.kubernetes.client.util.Yaml

public class Yaml
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Yaml.CustomConstructor Defines constructor logic for custom types in this library.
static class	Yaml.CustomRepresenter

Constructor Summary

Constructors

Constructor and Description
Yaml()

Method Summary

Modifier and Type	Method and Description
static void	addModelMap(String apiGroupVersion, String kind, Class<?> clazz) Add a mapping from API Group/version/kind to a Class to use when calling load(...) .
static String	dump(Object object) Takes an API object and returns a YAML String representing that object.
static void	dump(Object object, Writer writer) Takes an API object and writes a YAML string representing that object to the writer.
static String	dumpAll(Iterator<? extends Object> data) Takes an Iterator of YAML API objects and returns a YAML string representing all of them
static void	dumpAll(Iterator<? extends Object> data, Writer output) Takes an Iterator of YAML API objects and writes a YAML String representing all of them.
static org.yaml.snakeyaml.Yaml	getSnakeYaml()
static Object	load(File f) Load an API object from a YAML file.
static Object	load(Reader reader) Load an API object from a stream of data.
static Object	load(String content) Load an API object from a YAML string representation.
static List<Object>	loadAll(File f) Load list of instantiated API objects from a YAML file.
static List<Object>	loadAll(Reader reader) Load list of instantiated API objects from a stream of data.
static List<Object>	loadAll(String content) Load list of instantiated API objects from a YAML string representation.
static <T> T	loadAs(File f, Class<T> clazz) Load an API object from a YAML file.
static <T> T	loadAs(Reader reader, Class<T> clazz) Load an API object from a YAML stream.
static <T> T	loadAs(String content, Class<T> clazz) Load an API object from a YAML string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Yaml

public Yaml()

Method Detail

addModelMap

public static void addModelMap(String apiGroupVersion,
                               String kind,
                               Class<?> clazz)

Add a mapping from API Group/version/kind to a Class to use when calling load(...) .

Shouldn't really be needed as most API Group/Version/Kind are loaded dynamically at startup.

load

public static Object load(String content)
                   throws IOException

Load an API object from a YAML string representation. Returns a concrete typed object (e.g. V1Pod)

Parameters:

content - The YAML content

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

load

public static Object load(File f)
                   throws IOException

Load an API object from a YAML file. Returns a concrete typed object (e.g. V1Pod)

Parameters:

f - The file to load.

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

load

public static Object load(Reader reader)
                   throws IOException

Load an API object from a stream of data. Returns a concrete typed object (e.g. V1Pod)

Parameters:

reader - The stream to load.

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

loadAs

public static <T> T loadAs(String content,
                           Class<T> clazz)

Load an API object from a YAML string representation. Returns a concrete typed object using the type specified.

Parameters:

content - The YAML content

clazz - The class of object to return.

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

loadAs

public static <T> T loadAs(File f,
                           Class<T> clazz)
                    throws IOException

Load an API object from a YAML file. Returns a concrete typed object using the type specified.

Parameters:

f - The YAML file

clazz - The class of object to return.

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

loadAs

public static <T> T loadAs(Reader reader,
                           Class<T> clazz)

Load an API object from a YAML stream. Returns a concrete typed object using the type specified.

Parameters:

reader - The YAML stream

clazz - The class of object to return.

Returns:

An instantiation of the object.

Throws:

IOException - If an error occurs while reading the YAML.

loadAll

public static List<Object> loadAll(String content)
                            throws IOException

Load list of instantiated API objects from a YAML string representation. Returns list of concrete typed objects (e.g. { V1Pod, V1SERVICE })

Order of API objects in list will be preserved according to order of objects in YAML string.

Parameters:

content - The YAML content

Returns:

List of instantiated objects.

Throws:

IOException - If an error occurs while reading the YAML.

loadAll

public static List<Object> loadAll(File f)
                            throws IOException

Load list of instantiated API objects from a YAML file. Returns list of concrete typed objects (e.g. { V1Pod, V1SERVICE })

Order of API objects in list will be preserved according to order of objects in YAML file.

Parameters:

f - The file to load.

Returns:

List of instantiated of the objects.

Throws:

IOException - If an error occurs while reading the YAML.

loadAll

public static List<Object> loadAll(Reader reader)
                            throws IOException

Load list of instantiated API objects from a stream of data. Returns list of concrete typed objects (e.g. { V1Pod, V1SERVICE })

Order of API objects in list will be preserved according to order of objects in stream of data.

Parameters:

reader - The stream to load.

Returns:

List of instantiated of the objects.

Throws:

IOException - If an error occurs while reading the YAML.

dump

public static String dump(Object object)

Takes an API object and returns a YAML String representing that object.

Parameters:

object - The API object to dump.

Returns:

A YAML String representing the API object.

dump

public static void dump(Object object,
                        Writer writer)

Takes an API object and writes a YAML string representing that object to the writer.

Parameters:

object - The API object to dump

writer - The writer to write the YAML to.

dumpAll

public static String dumpAll(Iterator<? extends Object> data)

Takes an Iterator of YAML API objects and returns a YAML string representing all of them

Parameters:

data - The list of YAML API objects

Returns:

A String representing the list of YAML API objects.

dumpAll

public static void dumpAll(Iterator<? extends Object> data,
                           Writer output)

Takes an Iterator of YAML API objects and writes a YAML String representing all of them.

Parameters:

data - The list of YAML API objects.

output - The writer to output the YAML String to.

getSnakeYaml

public static org.yaml.snakeyaml.Yaml getSnakeYaml()

Returns:

An instantiated SnakeYaml Object.