com.openshift.restclient.capability.resources

Interface IPodLogRetrieval

All Superinterfaces:

ICapability

All Known Implementing Classes:

OpenShiftBinaryPodLogRetrieval

public interface IPodLogRetrieval
extends ICapability

Author:

Jeff Cantrill

Method Summary

Modifier and Type	Method and Description
InputStream	getLogs(boolean follow, IBinaryCapability.OpenShiftBinaryOption... options) Return the logs from the pod, optionally following them.
InputStream	getLogs(boolean follow, String container, IBinaryCapability.OpenShiftBinaryOption... options) Return the logs from the pod, optionally following them
void	stop() Stop retrieving logs for all containers
void	stop(String container) Stop retrieving logs for a specific container

Methods inherited from interface com.openshift.restclient.capability.ICapability

getName, isSupported

Method Detail

getLogs

InputStream getLogs(boolean follow,
                    IBinaryCapability.OpenShiftBinaryOption... options)

Return the logs from the pod, optionally following them.

Parameters:

follow - true if following. Default: false

options - the options to pass to the underlying oc command

Returns:

the log output stream

getLogs

InputStream getLogs(boolean follow,
                    String container,
                    IBinaryCapability.OpenShiftBinaryOption... options)

Return the logs from the pod, optionally following them

Parameters:

follow - true; if following, Default: false

container - the name of the container in the pod to get logs uses the first container if empty

options - the options to pass to the underlying oc command

Returns:

the log output stream

stop

void stop()

Stop retrieving logs for all containers

stop

void stop(String container)

Stop retrieving logs for a specific container

Parameters:

container - the name of the container