io.fabric8.kubernetes.client

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

All Known Implementing Classes:

APIServiceHandler, CertificateSigningRequestHandler, CertificateSigningRequestHandler, ClusterRoleBindingHandler, ClusterRoleHandler, ComponentStatusHandler, ConfigMapHandler, ControllerRevisionHandler, CronJobHandler, CronJobHandler, CSIDriverHandler, CSIDriverHandler, CSINodeHandler, CSINodeHandler, CSIStorageCapacityHandler, CustomResourceDefinitionHandler, CustomResourceDefinitionHandler, DaemonSetHandler, DaemonSetHandler, DeploymentHandler, DeploymentHandler, EndpointsHandler, EndpointSliceHandler, EndpointSliceHandler, EventHandler, EventHandler, EventHandler, FlowSchemaHandler, HorizontalPodAutoscalerHandler, HorizontalPodAutoscalerHandler, HorizontalPodAutoscalerHandler, IngressClassHandler, IngressClassHandler, IngressHandler, IngressHandler, IngressHandler, JobHandler, KubernetesListHandler, LeaseHandler, LimitRangeHandler, MutatingWebhookConfigurationHandler, MutatingWebhookConfigurationHandler, NamespaceHandler, NetworkPolicyHandler, NetworkPolicyHandler, NodeHandler, NodeMetricsHandler, PersistentVolumeClaimHandler, PersistentVolumeHandler, PodDisruptionBudgetHandler, PodDisruptionBudgetHandler, PodHandler, PodMetricsHandler, PodSecurityPolicyHandler, PodTemplateHandler, PriorityClassHandler, PriorityClassHandler, PriorityLevelConfigurationHandler, ReplicaSetHandler, ReplicaSetHandler, ReplicationControllerHandler, ResourceQuotaHandler, RoleBindingHandler, RoleHandler, RuntimeClassHandler, RuntimeClassHandler, RuntimeClassHandler, SecretHandler, ServiceAccountHandler, ServiceHandler, StatefulSetHandler, StorageClassHandler, ValidatingWebhookConfigurationHandler, ValidatingWebhookConfigurationHandler, VolumeAttachmentHandler

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceHandler.Key

Method Summary

Modifier and Type	Method and Description
default T	create(okhttp3.OkHttpClient client, Config config, String namespace, T item, boolean dryRun) Create the specified resource
default Boolean	delete(okhttp3.OkHttpClient client, Config config, String namespace, io.fabric8.kubernetes.api.model.DeletionPropagation propagationPolicy, long gracePeriodSeconds, T item, boolean dryRun) Delete the specified resource (if exists).
V	edit(T item) Edit the specified resource.
String	getApiVersion()
String	getKind()
default T	reload(okhttp3.OkHttpClient client, Config config, String namespace, T item) Reload the specified resource (if exists).
default T	replace(okhttp3.OkHttpClient client, Config config, String namespace, T item, boolean dryRun) Replace the specified resource
Resource<T>	resource(okhttp3.OkHttpClient client, Config config, String namespace, T item) Gets the Resource for the given item
default T	waitUntilCondition(okhttp3.OkHttpClient client, Config config, String namespace, T item, Predicate<T> condition, long amount, TimeUnit timeUnit) Waits until the specified condition is true.
default T	waitUntilReady(okhttp3.OkHttpClient client, Config config, String namespace, T item, long amount, TimeUnit timeUnit) Waits until the specified resource is Ready.
default Watch	watch(okhttp3.OkHttpClient client, Config config, String namespace, T item, io.fabric8.kubernetes.api.model.ListOptions listOptions, Watcher<T> watcher) Watches the specified resource for changes
default Watch	watch(okhttp3.OkHttpClient client, Config config, String namespace, T item, String resourceVersion, Watcher<T> watcher) Watches the specified resource for changes.
default 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()

getApiVersion

String getApiVersion()

create

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

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.

dryRun - Enable dry run

Returns:

The created resource.

replace

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

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.

dryRun - Enable dry run

Returns:

The replaced resource.

reload

default 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

default Boolean delete(okhttp3.OkHttpClient client,
                       Config config,
                       String namespace,
                       io.fabric8.kubernetes.api.model.DeletionPropagation propagationPolicy,
                       long gracePeriodSeconds,
                       T item,
                       boolean dryRun)

Delete the specified resource (if exists).

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

propagationPolicy - Whether and how garbage collection will be performed.

gracePeriodSeconds - The duration in seconds before the object should be deleted.

item - The resource to delete.

dryRun - enable dry run

Returns:

The true if the resource was successfully deleted.

watch

default 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 Watch

watch

default 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.

resourceVersion - The resourceVersion of object

watcher - The Watcher to use.

Returns:

The Watch

watch

default Watch watch(okhttp3.OkHttpClient client,
                    Config config,
                    String namespace,
                    T item,
                    io.fabric8.kubernetes.api.model.ListOptions listOptions,
                    Watcher<T> watcher)

Watches the specified resource for changes

Parameters:

client - An instance of http client.

config - The client config.

namespace - The target namespace.

item - The resource to delete.

listOptions - The ListOptions for available options

watcher - The Watcher to use.

Returns:

The Watch

waitUntilReady

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

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.

waitUntilCondition

default T waitUntilCondition(okhttp3.OkHttpClient client,
                             Config config,
                             String namespace,
                             T item,
                             Predicate<T> condition,
                             long amount,
                             TimeUnit timeUnit)

Waits until the specified condition is true.

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.

condition - The condition to wait for

Returns:

The true if the resource was successfully deleted.

resource

Resource<T> resource(okhttp3.OkHttpClient client,
                     Config config,
                     String namespace,
                     T item)

Gets the Resource for the given item

Parameters:

client - An instance of the http client.

config - The client config.

namespace - The target namespace.

item - The resource to wait.

Returns:

The true if the resource was successfully deleted.