io.kubernetes.client

Class Attach

java.lang.Object

io.kubernetes.client.Attach

public class Attach
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attach.AttachResult AttachResult contains the result of an Attach call, it includes streams for stdout stderr and stdin.
class	Attach.ConnectionBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Attach.AttachResult	attach(String namespace, String name, boolean stdin) Attach to a running AttachResult in a container.
Attach.AttachResult	attach(String namespace, String name, String container, boolean stdin, boolean tty) Attach to a running AttachResult in a container.
Attach.AttachResult	attach(io.kubernetes.client.openapi.models.V1Pod pod, boolean stdin) Attach to a running AttachResult in a container.
Attach.AttachResult	attach(io.kubernetes.client.openapi.models.V1Pod pod, boolean stdin, boolean tty) Attach to a running AttachResult in a container.
Attach.AttachResult	attach(io.kubernetes.client.openapi.models.V1Pod pod, String container, boolean stdin, boolean tty) Attach to a running AttachResult in a container.
io.kubernetes.client.openapi.ApiClient	getApiClient() Get the API client for these Attach operations.
Attach.ConnectionBuilder	newConnectionBuilder(String namespace, String name) Setup a Builder for the given namespace and name
void	setApiClient(io.kubernetes.client.openapi.ApiClient apiClient) Set the API client for subsequent Attach operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attach

public Attach()

Simple Attach API constructor, uses default configuration

Attach

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

Attach 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 Attach 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 Attach operations.

Parameters:

apiClient - The new API client to use.

newConnectionBuilder

public Attach.ConnectionBuilder newConnectionBuilder(String namespace,
                                                     String name)

Setup a Builder for the given namespace and name

Parameters:

namespace - The namespace of the Pod

name - The name of the Pod

attach

public Attach.AttachResult attach(String namespace,
                                  String name,
                                  boolean stdin)
                           throws io.kubernetes.client.openapi.ApiException,
                                  IOException

Attach to a running AttachResult 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

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

Throws:

io.kubernetes.client.openapi.ApiException

IOException

attach

public Attach.AttachResult attach(io.kubernetes.client.openapi.models.V1Pod pod,
                                  boolean stdin)
                           throws io.kubernetes.client.openapi.ApiException,
                                  IOException

Attach to a running AttachResult 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.

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

Throws:

io.kubernetes.client.openapi.ApiException

IOException

attach

public Attach.AttachResult attach(io.kubernetes.client.openapi.models.V1Pod pod,
                                  boolean stdin,
                                  boolean tty)
                           throws io.kubernetes.client.openapi.ApiException,
                                  IOException

Attach to a running AttachResult 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.

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

tty - If true, stdin is a tty.

Throws:

io.kubernetes.client.openapi.ApiException

IOException

attach

public Attach.AttachResult attach(io.kubernetes.client.openapi.models.V1Pod pod,
                                  String container,
                                  boolean stdin,
                                  boolean tty)
                           throws io.kubernetes.client.openapi.ApiException,
                                  IOException

Attach to a running AttachResult 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.

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

attach

public Attach.AttachResult attach(String namespace,
                                  String name,
                                  String container,
                                  boolean stdin,
                                  boolean tty)
                           throws io.kubernetes.client.openapi.ApiException,
                                  IOException

Attach to a running AttachResult 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

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