io.alauda.kubernetes.client

Interface ResourceHandler<T,V extends io.alauda.kubernetes.api.builder.VisitableBuilder<T,V>>

All Known Implementing Classes:

ConfigMapHandler, CustomResourceDefinitionHandler, DaemonSetHandler, DeploymentHandler, EndpointsHandler, EventHandler, HorizontalPodAutoscalerHandler, IngressHandler, JobHandler, KubernetesListHandler, LimitRangeHandler, NamespaceHandler, NetworkPolicyHandler, NodeHandler, PersistentVolumeClaimHandler, PersistentVolumeHandler, PodHandler, PodSecurityPolicyHandler, ReplicaSetHandler, ReplicationControllerHandler, ResourceQuotaHandler, SecretHandler, SecurityContextConstraintsHandler, ServiceAccountHandler, ServiceHandler, StatefulSetHandler, StorageClassHandler, ThirdPartyResourceHandler

public interface ResourceHandler<T,V extends io.alauda.kubernetes.api.builder.VisitableBuilder<T,V>>

Method Summary

Modifier and Type	Method and Description
T	create(okhttp3.OkHttpClient client, Config config, String namespace, T item) Create the specified resource.
Boolean	delete(okhttp3.OkHttpClient client, Config config, String namespace, T item) Delete the specified resource (if exists).
V	edit(T item) Edit the specified resource.
String	getKind()
T	reload(okhttp3.OkHttpClient client, Config config, String namespace, T item) Reload the specified resource (if exists).
T	replace(okhttp3.OkHttpClient client, Config config, String namespace, T item) Replace the specified resource.
T	waitUntilReady(okhttp3.OkHttpClient client, Config config, String namespace, T item, long amount, TimeUnit timeUnit) Waits until the specified resource is Ready.
Watch	watch(okhttp3.OkHttpClient client, Config config, String namespace, T item, String resourceVersion, Watcher<T> watcher) Watches the specified resource for changes.
Watch	watch(okhttp3.OkHttpClient client, Config config, String namespace, T item, Watcher<T> watcher) Watches the specified resource for changes.

Method Detail

getKind

String getKind()

create

T create(okhttp3.OkHttpClient client,
         Config config,
         String namespace,
         T item)

Create the specified resource.

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to create.

Returns:

The created resource.

replace

T replace(okhttp3.OkHttpClient client,
          Config config,
          String namespace,
          T item)

Replace the specified resource.

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to replace.

Returns:

The created resource.

reload

T reload(okhttp3.OkHttpClient client,
         Config config,
         String namespace,
         T item)

Reload the specified resource (if exists).

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to reload.

Returns:

The reloaded resource.

edit

V edit(T item)

Edit the specified resource.

Parameters:

item - The resource to edit.

Returns:

The resource editor.

delete

Boolean delete(okhttp3.OkHttpClient client,
               Config config,
               String namespace,
               T item)

Delete the specified resource (if exists).

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to delete.

Returns:

The true if the resource was successfully deleted.

watch

Watch watch(okhttp3.OkHttpClient client,
            Config config,
            String namespace,
            T item,
            Watcher<T> watcher)

Watches the specified resource for changes.

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to delete.

watcher - The Watcher to use.

Returns:

The true if the resource was successfully deleted.

watch

Watch watch(okhttp3.OkHttpClient client,
            Config config,
            String namespace,
            T item,
            String resourceVersion,
            Watcher<T> watcher)

Watches the specified resource for changes.

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to delete.

watcher - The Watcher to use.

Returns:

The true if the resource was successfully deleted.

waitUntilReady

T waitUntilReady(okhttp3.OkHttpClient client,
                 Config config,
                 String namespace,
                 T item,
                 long amount,
                 TimeUnit timeUnit)
          throws InterruptedException

Waits until the specified resource is Ready. For resources that 'readiness' is not applicable the method is equivalent to get.

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to wait.

amount - The amount of time to wait

timeUnit - The wait TimeUnit.

Returns:

The true if the resource was successfully deleted.

Throws:

InterruptedException