io.micronaut.kubernetes.client.v1

Interface KubernetesOperations

All Known Subinterfaces:

KubernetesClient

public interface KubernetesOperations

Defines the HTTP requests to query the Kubernetes API.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

See Also:

Kubernetes API overview

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<ConfigMap>	createConfigMap(java.lang.String namespace, ConfigMap configMap) Create the specified ConfigMap.
org.reactivestreams.Publisher<Pod>	createPod(java.lang.String namespace, Pod pod) Returns the created Pod in the given namespace.
org.reactivestreams.Publisher<Secret>	createSecret(java.lang.String namespace, Secret secret) Create the specified Secret.
org.reactivestreams.Publisher<ConfigMap>	deleteConfigMap(java.lang.String namespace, java.lang.String configMapName) Delete the specified ConfigMap.
org.reactivestreams.Publisher<Pod>	deletePod(java.lang.String namespace, java.lang.String podName) Returns the deleted Pod in the given namespace.
org.reactivestreams.Publisher<Secret>	deleteSecret(java.lang.String namespace, java.lang.String secretName) Delete the specified Secret.
org.reactivestreams.Publisher<ConfigMap>	getConfigMap(java.lang.String namespace, java.lang.String configMapName) Read the specified ConfigMap.
org.reactivestreams.Publisher<Endpoints>	getEndpoints(java.lang.String namespace, java.lang.String serviceName) Read the specified Endpoints.
org.reactivestreams.Publisher<Pod>	getPod(java.lang.String namespace, java.lang.String podName) Returns a Pod of the given name in the given namespace.
org.reactivestreams.Publisher<Secret>	getSecret(java.lang.String namespace, java.lang.String secretName) Returns a Secret of the given namespace.
org.reactivestreams.Publisher<Service>	getService(java.lang.String namespace, java.lang.String serviceName) Read the specified Service.
default org.reactivestreams.Publisher<ConfigMapList>	listConfigMaps(java.lang.String namespace)
org.reactivestreams.Publisher<ConfigMapList>	listConfigMaps(java.lang.String namespace, java.lang.String labelSelector) List objects of kind ConfigMap.
org.reactivestreams.Publisher<EndpointsList>	listEndpoints(java.lang.String namespace, java.lang.String labelSelector) List endpoints in the given namespace.
default org.reactivestreams.Publisher<PodList>	listPods(java.lang.String namespace)
org.reactivestreams.Publisher<PodList>	listPods(java.lang.String namespace, java.lang.String labelSelector) List pods in the given namespace.
default org.reactivestreams.Publisher<SecretList>	listSecrets(java.lang.String namespace)
org.reactivestreams.Publisher<SecretList>	listSecrets(java.lang.String namespace, java.lang.String labelSelector) List objects of kind Secret.
org.reactivestreams.Publisher<ServiceList>	listServices(java.lang.String namespace, java.lang.String labelSelector) List services in the specified namespace.
org.reactivestreams.Publisher<ConfigMap>	replaceConfigMap(java.lang.String namespace, java.lang.String configMapName, ConfigMap configMap) Replace the specified ConfigMap.
org.reactivestreams.Publisher<Secret>	replaceSecret(java.lang.String namespace, java.lang.String secretName, Secret secret) Replace the specified Secret.
org.reactivestreams.Publisher<ConfigMapWatchEvent>	watchConfigMaps(java.lang.String namespace, java.lang.Long resourceVersion, java.lang.String labelSelector) Watch objects of kind ConfigMap.
org.reactivestreams.Publisher<SecretWatchEvent>	watchSecrets(java.lang.String namespace, java.lang.Long resourceVersion, java.lang.String labelSelector) Watch objects of kind Secret.

Method Detail

listServices

@Get(value="/namespaces/{namespace}/services?labelSelector={labelSelector}")
org.reactivestreams.Publisher<ServiceList> listServices(java.lang.String namespace,
                                                                                                                                     @Nullable
                                                                                                                                     java.lang.String labelSelector)

List services in the specified namespace.

Parameters:

namespace - Object name and auth scope, such as for teams and projects

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

A list of services

getService

@Get(value="/namespaces/{namespace}/services/{serviceName}")
org.reactivestreams.Publisher<Service> getService(java.lang.String namespace,
                                                                                                               java.lang.String serviceName)

Read the specified Service.

Parameters:

namespace - Object name and auth scope, such as for teams and projects

serviceName - The name of the service

Returns:

A Service

See Also:

Service v1 core - Read operations - Read

listEndpoints

@Get(value="/namespaces/{namespace}/endpoints?labelSelector={labelSelector}")
org.reactivestreams.Publisher<EndpointsList> listEndpoints(java.lang.String namespace,
                                                                                                                                         @Nullable
                                                                                                                                         java.lang.String labelSelector)

List endpoints in the given namespace.

Parameters:

namespace - Object name and auth scope, such as for teams and projects

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

A list of endpoints

getEndpoints

@Get(value="/namespaces/{namespace}/endpoints/{serviceName}")
org.reactivestreams.Publisher<Endpoints> getEndpoints(java.lang.String namespace,
                                                                                                                    java.lang.String serviceName)

Read the specified Endpoints.

Parameters:

namespace - object name and auth scope, such as for teams and projects

serviceName - name of the endpoints

Returns:

Endpoints

See Also:

Endpoints v1 core - Read operations

listConfigMaps

@Get(value="/namespaces/{namespace}/configmaps?labelSelector={labelSelector}")
org.reactivestreams.Publisher<ConfigMapList> listConfigMaps(java.lang.String namespace,
                                                                                                                                           @Nullable
                                                                                                                                           java.lang.String labelSelector)

List objects of kind ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

a ConfigMapList

listConfigMaps

default org.reactivestreams.Publisher<ConfigMapList> listConfigMaps(java.lang.String namespace)

Parameters:

namespace - object name and auth scope, such as for teams and projects

Returns:

a ConfigMapList of the given namespace

watchConfigMaps

@Get(value="/watch/namespaces/{namespace}/configmaps?resourceVersion={resourceVersion}&labelSelector={labelSelector}")
 @Consumes(value={"application/x-json-stream","application/json"})
org.reactivestreams.Publisher<ConfigMapWatchEvent> watchConfigMaps(java.lang.String namespace,
                                                                                                                                                                                                                                                             java.lang.Long resourceVersion,
                                                                                                                                                                                                                                                             @Nullable
                                                                                                                                                                                                                                                             java.lang.String labelSelector)

Watch objects of kind ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

resourceVersion - the resource version to receive events from. If set to 0, Kubernetes will send all events

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

a ConfigMapList

getConfigMap

@Get(value="/namespaces/{namespace}/configmaps/{configMapName}")
org.reactivestreams.Publisher<ConfigMap> getConfigMap(java.lang.String namespace,
                                                                                                                       java.lang.String configMapName)

Read the specified ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

configMapName - name of the ConfigMap

Returns:

a ConfigMap

createConfigMap

@Post(value="/namespaces/{namespace}/configmaps")
org.reactivestreams.Publisher<ConfigMap> createConfigMap(java.lang.String namespace,
                                                                                                           @Body
                                                                                                           ConfigMap configMap)

Create the specified ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

configMap - to create

Returns:

a ConfigMap

replaceConfigMap

@Put(value="/namespaces/{namespace}/configmaps/{configMapName}")
org.reactivestreams.Publisher<ConfigMap> replaceConfigMap(java.lang.String namespace,
                                                                                                                           java.lang.String configMapName,
                                                                                                                           @Body
                                                                                                                           ConfigMap configMap)

Replace the specified ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

configMapName - name of the ConfigMap

configMap - to replace

Returns:

a ConfigMap

deleteConfigMap

@Delete(value="/namespaces/{namespace}/configmaps/{configMapName}")
org.reactivestreams.Publisher<ConfigMap> deleteConfigMap(java.lang.String namespace,
                                                                                                                             java.lang.String configMapName)

Delete the specified ConfigMap.

Parameters:

namespace - object name and auth scope, such as for teams and projects

configMapName - name of the ConfigMap

Returns:

a ConfigMap

listSecrets

@Get(value="/namespaces/{namespace}/secrets?labelSelector={labelSelector}")
org.reactivestreams.Publisher<SecretList> listSecrets(java.lang.String namespace,
                                                                                                                                  @Nullable
                                                                                                                                  java.lang.String labelSelector)

List objects of kind Secret.

Parameters:

namespace - object name and auth scope, such as for teams and projects

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

a SecretList

watchSecrets

@Get(value="/watch/namespaces/{namespace}/secrets?resourceVersion={resourceVersion}&labelSelector={labelSelector}")
 @Consumes(value={"application/x-json-stream","application/json"})
org.reactivestreams.Publisher<SecretWatchEvent> watchSecrets(java.lang.String namespace,
                                                                                                                                                                                                                                                    java.lang.Long resourceVersion,
                                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                                    java.lang.String labelSelector)

Watch objects of kind Secret.

Parameters:

namespace - object name and auth scope, such as for teams and projects

resourceVersion - the resource version to receive events from. If set to 0, Kubernetes will send all events

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

a ConfigMapList

listSecrets

default org.reactivestreams.Publisher<SecretList> listSecrets(java.lang.String namespace)

Parameters:

namespace - object name and auth scope, such as for teams and projects

Returns:

a SecretList

getSecret

@Get(value="/namespaces/{namespace}/secrets/{secretName}")
org.reactivestreams.Publisher<Secret> getSecret(java.lang.String namespace,
                                                                                                           java.lang.String secretName)

Returns a Secret of the given namespace.

Parameters:

namespace - object name and auth scope, such as for teams and projects

secretName - the secret name

Returns:

A Secret instance

createSecret

@Post(value="/namespaces/{namespace}/secrets/")
org.reactivestreams.Publisher<Secret> createSecret(java.lang.String namespace,
                                                                                                   @Body
                                                                                                   Secret secret)

Create the specified Secret.

Parameters:

namespace - object name and auth scope, such as for teams and projects

secret - the secret

Returns:

A Secret instance

replaceSecret

@Put(value="/namespaces/{namespace}/secrets/{secretName}")
org.reactivestreams.Publisher<Secret> replaceSecret(java.lang.String namespace,
                                                                                                               java.lang.String secretName,
                                                                                                               @Body
                                                                                                               Secret secret)

Replace the specified Secret.

Parameters:

namespace - object name and auth scope, such as for teams and projects

secretName - the secret name

secret - the secret to replace

Returns:

A Secret instance

deleteSecret

@Delete(value="/namespaces/{namespace}/secrets/{secretName}")
org.reactivestreams.Publisher<Secret> deleteSecret(java.lang.String namespace,
                                                                                                                 java.lang.String secretName)

Delete the specified Secret.

Parameters:

namespace - object name and auth scope, such as for teams and projects

secretName - the secret name

Returns:

A Secret instance

getPod

@Get(value="/namespaces/{namespace}/pods/{podName}")
org.reactivestreams.Publisher<Pod> getPod(java.lang.String namespace,
                                                                                               java.lang.String podName)

Returns a Pod of the given name in the given namespace.

Parameters:

namespace - object name and auth scope, such as for teams and projects

podName - the pod name

Returns:

A Pod instance

listPods

@Get(value="/namespaces/{namespace}/pods?labelSelector={labelSelector}")
org.reactivestreams.Publisher<PodList> listPods(java.lang.String namespace,
                                                                                                                         @Nullable
                                                                                                                         java.lang.String labelSelector)

List pods in the given namespace.

Parameters:

namespace - Object name and auth scope, such as for teams and projects

labelSelector - A selector to restrict the list of returned objects by their labels

Returns:

a PodList of the given namespace

listPods

default org.reactivestreams.Publisher<PodList> listPods(java.lang.String namespace)

Parameters:

namespace - object name and auth scope, such as for teams and projects

Returns:

a PodList of the given namespace

createPod

@Post(value="/namespaces/{namespace}/pods")
org.reactivestreams.Publisher<Pod> createPod(java.lang.String namespace,
                                                                                         @Body
                                                                                         Pod pod)

Returns the created Pod in the given namespace.

Parameters:

namespace - object name and auth scope, such as for teams and projects

pod - the pod to create

Returns:

A Pod instance

deletePod

@Delete(value="/namespaces/{namespace}/pods/{podName}")
org.reactivestreams.Publisher<Pod> deletePod(java.lang.String namespace,
                                                                                                     java.lang.String podName)

Returns the deleted Pod in the given namespace.

Parameters:

namespace - object name and auth scope, such as for teams and projects

podName - the pod name

Returns:

A Pod instance