Package io.fabric8.kubernetes.client

Interface ApiVisitor

public interface ApiVisitor

Used to perform operations across all resources known to the api server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApiVisitor.ApiVisitResult

Method Summary

Modifier and Type	Method	Description
default ApiVisitor.ApiVisitResult	visitApiGroup(String group)	Visit the api group.
default ApiVisitor.ApiVisitResult	visitApiGroupVersion(String group, String version)	Visit the group version.
ApiVisitor.ApiVisitResult	visitResource(String group, String version, APIResource apiResource, MixedOperation<GenericKubernetesResource,GenericKubernetesResourceList,Resource<GenericKubernetesResource>> operation)	Visit the resource.

Method Detail

visitApiGroup

default ApiVisitor.ApiVisitResult visitApiGroup(String group)

Visit the api group.

Parameters:

group - the group name, will be empty for the core group

Returns:

the result to control future actions. ApiVisitor.ApiVisitResult.SKIP will skip visiting all versions of this api group.

visitApiGroupVersion

default ApiVisitor.ApiVisitResult visitApiGroupVersion(String group,
                                                       String version)

Visit the group version. Use ApiVersionUtil to separate components if needed.

Parameters:

group - the group name, will be empty for the core group

Returns:

the result to control future actions. ApiVisitor.ApiVisitResult.SKIP will skip visiting all resources under this api group version.

visitResource

ApiVisitor.ApiVisitResult visitResource(String group,
                                        String version,
                                        APIResource apiResource,
                                        MixedOperation<GenericKubernetesResource,GenericKubernetesResourceList,Resource<GenericKubernetesResource>> operation)

Visit the resource.

Parameters:

group - the group name, will be empty for the core group. Generally used instead of APIResource.getGroup()

version - generally used instead of APIResource.getVersion()

apiResource - can be used to look at applicable verbs and other resource information

operation - the GenericKubernetesResource operation for the current resource. Will be in the namespace of the client by default.

Returns:

ApiVisitor.ApiVisitResult.TERMINATE to terminate. SKIP and CONTINUE will both continue visiting.