io.kubernetes.client

Class Exec

java.lang.Object

io.kubernetes.client.Exec

Direct Known Subclasses:

Copy

public class Exec
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Exec.ExecProcess
class	Exec.ExecutionBuilder

Constructor Summary

Constructors

Constructor and Description
Exec() Simple Exec API constructor, uses default configuration
Exec(io.kubernetes.client.openapi.ApiClient apiClient) Exec API Constructor

Method Summary

Modifier and Type	Method and Description
Process	exec(String namespace, String name, String[] command, boolean stdin) Execute a command in a container.
Process	exec(String namespace, String name, String[] command, boolean stdin, boolean tty) Execute a command in a container.
Process	exec(String namespace, String name, String[] command, String container, boolean stdin, boolean tty) Execute a command in a container.
Process	exec(io.kubernetes.client.openapi.models.V1Pod pod, String[] command, boolean stdin) Execute a command in a container.
Process	exec(io.kubernetes.client.openapi.models.V1Pod pod, String[] command, boolean stdin, boolean tty) Execute a command in a container.
Process	exec(io.kubernetes.client.openapi.models.V1Pod pod, String[] command, String container, boolean stdin, boolean tty) Execute a command in a container.
io.kubernetes.client.openapi.ApiClient	getApiClient() Get the API client for these exec operations.
Exec.ExecutionBuilder	newExecutionBuilder(String namespace, String name, String[] command) Setup a Builder for the given namespace, name and command
void	setApiClient(io.kubernetes.client.openapi.ApiClient apiClient) Set the API client for subsequent exec operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Exec

public Exec()

Simple Exec API constructor, uses default configuration

Exec

public Exec(io.kubernetes.client.openapi.ApiClient apiClient)

Exec API Constructor

Parameters:

apiClient - The api client to use.

Method Detail

getApiClient

public io.kubernetes.client.openapi.ApiClient getApiClient()

Get the API client for these exec operations.

Returns:

The API client that will be used.

setApiClient

public void setApiClient(io.kubernetes.client.openapi.ApiClient apiClient)

Set the API client for subsequent exec operations.

Parameters:

apiClient - The new API client to use.

newExecutionBuilder

public Exec.ExecutionBuilder newExecutionBuilder(String namespace,
                                                 String name,
                                                 String[] command)

Setup a Builder for the given namespace, name and command

Parameters:

namespace - The namespace of the Pod

name - The name of the Pod

command - The command to run

exec

public Process exec(String namespace,
                    String name,
                    String[] command,
                    boolean stdin)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

namespace - The namespace of the Pod

name - The name of the Pod

command - The command to run

stdin - If true, pass a stdin stream into the container

Throws:

io.kubernetes.client.openapi.ApiException

IOException

exec

public Process exec(io.kubernetes.client.openapi.models.V1Pod pod,
                    String[] command,
                    boolean stdin)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

pod - The pod where the command is run.

command - The command to run

stdin - If true, pass a stdin stream into the container

Throws:

io.kubernetes.client.openapi.ApiException

IOException

exec

public Process exec(String namespace,
                    String name,
                    String[] command,
                    boolean stdin,
                    boolean tty)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

namespace - The namespace of the Pod

name - The name of the Pod

command - The command to run

stdin - If true, pass a stdin stream into the container

tty - If true, stdin is a tty.

Throws:

io.kubernetes.client.openapi.ApiException

IOException

exec

public Process exec(io.kubernetes.client.openapi.models.V1Pod pod,
                    String[] command,
                    boolean stdin,
                    boolean tty)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

pod - The pod where the command is run.

command - The command to run

stdin - If true, pass a stdin stream into the container

tty - If true, stdin is a tty.

Throws:

io.kubernetes.client.openapi.ApiException

IOException

exec

public Process exec(io.kubernetes.client.openapi.models.V1Pod pod,
                    String[] command,
                    String container,
                    boolean stdin,
                    boolean tty)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

pod - The pod where the command is run.

command - The command to run

container - The container in the Pod where the command is run.

stdin - If true, pass a stdin stream into the container.

tty - If true, stdin is a TTY (only applies if stdin is true)

Throws:

io.kubernetes.client.openapi.ApiException

IOException

exec

public Process exec(String namespace,
                    String name,
                    String[] command,
                    String container,
                    boolean stdin,
                    boolean tty)
             throws io.kubernetes.client.openapi.ApiException,
                    IOException

Execute a command in a container. If there are multiple containers in the pod, uses the first container in the Pod.

Parameters:

namespace - The namespace of the Pod

name - The name of the Pod

command - The command to run

container - The container in the Pod where the command is run.

stdin - If true, pass a stdin stream into the container.

tty - If true, stdin is a TTY (only applies if stdin is true)

Throws:

io.kubernetes.client.openapi.ApiException

IOException