io.kubernetes.client.util

Class Watch<T>

java.lang.Object

io.kubernetes.client.util.Watch<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Watch.Response<T>>, Iterator<Watch.Response<T>>

public class Watch<T>
extends Object
implements Iterable<Watch.Response<T>>, Iterator<Watch.Response<T>>, Closeable, AutoCloseable

Watch class implements watch mechansim of kubernetes. For every list API call with a watch parameter you should be able to pass its call to this class and watch changes to that list. For example CoreV1Api.listNamespace has watch parameter, so you can create a call using CoreV1Api.listNamespaceCall and set watch to True and watch the changes to namespaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Watch.Response<T> Response class holds a watch response that has a `type` that can be ADDED, MODIFIED, DELETED and ERROR.

Method Summary

Modifier and Type	Method and Description
void	close()
static <T> Watch<T>	createWatch(io.kubernetes.client.ApiClient client, com.squareup.okhttp.Call call, Type watchType) Creates a watch on a TYPENAME (T) using an API Client and a Call object.
boolean	hasNext()
Iterator<Watch.Response<T>>	iterator()
Watch.Response<T>	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

createWatch

public static <T> Watch<T> createWatch(io.kubernetes.client.ApiClient client,
                                       com.squareup.okhttp.Call call,
                                       Type watchType)
                                throws io.kubernetes.client.ApiException

Creates a watch on a TYPENAME (T) using an API Client and a Call object.

Type Parameters:

T - TYPENAME.

Parameters:

client - the API client

call - the call object returned by api.{ListOperation}Call(...) method. Make sure watch flag is set in the call.

watchType - The type of the WatchResponse<T>. Use something like new TypeToken<Watch.Response<TYPENAME>>(){}.getType()

Returns:

Watch object on TYPENAME

Throws:

io.kubernetes.client.ApiException - on IO exceptions.

next

public Watch.Response<T> next()

Specified by:

next in interface Iterator<Watch.Response<T>>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Watch.Response<T>>

iterator

public Iterator<Watch.Response<T>> iterator()

Specified by:

iterator in interface Iterable<Watch.Response<T>>

remove

public void remove()

Specified by:

remove in interface Iterator<Watch.Response<T>>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException