org.cdk8s

Class Yaml

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.Yaml

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-22T00:23:08.210Z")
 @Stability(value=Stable)
public class Yaml
extends software.amazon.jsii.JsiiObject

YAML utilities.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Yaml(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Yaml(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static List<Object>	load(String urlOrFile) Downloads a set of YAML documents (k8s manifest for example) from a URL or a file and returns them as javascript objects.
static void	save(String filePath, List<? extends Object> docs) Saves a set of objects as a multi-document YAML file.
static String	stringify(Object doc) Stringify a document into yaml.
static String	tmp(List<? extends Object> docs) Saves a set of YAML documents into a temp file (in /tmp).

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Yaml

protected Yaml(software.amazon.jsii.JsiiObjectRef objRef)

Yaml

protected Yaml(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

load

@Stability(value=Stable)
 @NotNull
public static List<Object> load(@NotNull
                                                                   String urlOrFile)

Downloads a set of YAML documents (k8s manifest for example) from a URL or a file and returns them as javascript objects.

Empty documents are filtered out.

Parameters:

urlOrFile - a URL of a file path to load from. This parameter is required.

Returns:

an array of objects, each represents a document inside the YAML

save

@Stability(value=Stable)
public static void save(@NotNull
                                                 String filePath,
                                                 @NotNull
                                                 List<? extends Object> docs)

Saves a set of objects as a multi-document YAML file.

Parameters:

filePath - The output path. This parameter is required.

docs - The set of objects. This parameter is required.

stringify

@Stability(value=Stable)
 @NotNull
public static String stringify(@NotNull
                                                                  Object doc)

Stringify a document into yaml.

Parameters:

doc - An object. This parameter is required.

tmp

@Stability(value=Stable)
 @NotNull
public static String tmp(@NotNull
                                                            List<? extends Object> docs)

Saves a set of YAML documents into a temp file (in /tmp).

Parameters:

docs - the set of documents to save. This parameter is required.

Returns:

the path to the temporary file