Package com.google.jenkins.plugins.k8sengine

Class Manifests

java.lang.Object

com.google.jenkins.plugins.k8sengine.Manifests

public class Manifests
extends Object

Utility library for loading Kubernetes manifests files from a FilePath into a list of descriptive wrappers, Manifests.ManifestObject.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Manifests.ManifestObject	ManifestObject wrapper that encapsulates an object spec loaded from a supplied manifest.

Method Summary

Modifier and Type	Method	Description
static Manifests	fromFile(FilePath file)	Factory method for single FilePath.
static Manifests	fromFileList(List<FilePath> files)	Factory method for list of FilePath objects.
List<Manifests.ManifestObject>	getObjectManifests()
List<Manifests.ManifestObject>	getObjectManifestsOfKinds(Set<String> includedKinds)	Get the list of Manifests.ManifestObject that match the given kind.
void	write()	Writes the contents of this Manifests's objects back to their corresponding files.

Methods inherited from class java.lang.Object

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

Method Detail

fromFile

public static Manifests fromFile(FilePath file)
                          throws IOException,
                                 InterruptedException

Factory method for single FilePath.

Parameters:

file - The FilePath containing the manifests.

Returns:

A Manifests object containing the individual manifests contained at the file path.

Throws:

IOException - If an error occurred while loading the file.

InterruptedException - If a threading error occurred while loading the file.

fromFileList

public static Manifests fromFileList(List<FilePath> files)
                              throws IOException,
                                     InterruptedException

Factory method for list of FilePath objects.

Parameters:

files - The list of FilePath objects containing the manifests.

Returns:

Manifests object constructed based on the list of FilePath's.

Throws:

IOException - If an error occurred while loading the file.

InterruptedException - If a threading error occurred while loading the file.

getObjectManifests

public List<Manifests.ManifestObject> getObjectManifests()

Returns:

The Manifests.ManifestObject's that were loaded.

getObjectManifestsOfKinds

public List<Manifests.ManifestObject> getObjectManifestsOfKinds(Set<String> includedKinds)

Get the list of Manifests.ManifestObject that match the given kind.

Parameters:

includedKinds - The kinds of Kubernetes objects to include in the list.

Returns:

The manifest objects that match the included kinds.

write

public void write()
           throws InterruptedException,
                  IOException

Writes the contents of this Manifests's objects back to their corresponding files.

Throws:

InterruptedException - If an error occurred while dumping to YAML.

IOException - If an error occurred while writing the file contents.