package
0.33.0-alpha.2
Repository: https://github.com/kubernetes/cli-runtime.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
EnhanceListError augments errors typically returned by List operations with additional context, making sure to retain the StatusError type when applicable.
ExpandPathsToFileVisitors will return a slice of FileVisitors that will handle files from the provided path.
FileVisitorForSTDIN return a special FileVisitor just for STDIN.
No description provided by the author
FilterNamespace omits the namespace if the object is not namespace scoped.
FollowContinue handles the continue parameter returned by the API server when using list chunking.
HasNames returns true if the provided args contain resource names.
No description provided by the author
TODO: expand this to include other errors.
No description provided by the author
NewClientWithOptions wraps the provided RESTClient and invokes each transform on each newly created request.
No description provided by the author
NewDecoratedVisitor will create a visitor that invokes the provided visitor functions before the user supplied visitor function is invoked, giving them the opportunity to mutate the Info object or terminate early with an error.
No description provided by the author
NewFallbackQueryParamVerifier returns a new Verifier which will invoke the initial/primary Verifier.
No description provided by the author
NewFlattenListVisitor creates a visitor that will expand list style runtime.Objects into individual items and then visit them individually.
NewHelper creates a Helper from a ResourceMapping.
NewLocalBuilder returns a builder that is configured not to create REST clients and avoids asking the server for results.
No description provided by the author
No description provided by the author
NewQueryParamVerifierV3 returns a pointer to the created queryParamVerifier3 struct, which implements the Verifier interface.
NewSelector creates a resource selector which hides details of getting items by their label selector.
NewStreamVisitor is a helper function that is useful when we want to change the fields of the struct but keep calls the same.
RequireNamespace will either set a namespace if none is provided on the Info object, or if the namespace is set and does not match the provided value, returns an error.
RetrieveLatest updates the Object on each Info by invoking a standard client Get.
RetrieveLazy updates the object if it has not been loaded yet.
SetNamespace ensures that every Info object visited will have a namespace set.
SplitResourceArgument splits the argument with commas and returns unique strings in the original order.
UnstructuredPlusDefaultContentConfig returns a rest.ContentConfig for dynamic types.
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
# Variables
FakeCategoryExpander is for testing only.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Builder provides convenience functions for taking arguments and parameters from the command line and converting them to a list of resources to iterate over using the Visitor interface.
No description provided by the author
ContinueOnErrorVisitor visits each item and, if an error occurs on any individual item, returns an aggregate error after all items are visited.
DecoratedVisitor will invoke the decorators in order prior to invoking the visitor function passed to Visit.
No description provided by the author
FileVisitor is wrapping around a StreamVisitor, to handle open/close files.
No description provided by the author
FlattenListVisitor flattens any objects that runtime.ExtractList recognizes as a list - has an "Items" public field that is a slice of runtime.Objects or objects satisfying that interface - into multiple Infos.
Helper provides methods for retrieving or mutating a RESTful resource.
Info contains temporary info to execute a REST call, or show the results of an already completed REST call.
KustomizeVisitor handles kustomization.yaml files.
QueryParamVerifier verifies if a given group-version-kind supports a given VerifiableQueryParam against the current server.
Result contains helper methods for dealing with the outcome of a Builder.
Selector is a Visitor for resources that match a label selector.
StreamVisitor reads objects from an io.Reader and walks them.
URLVisitor downloads the contents of a URL, and if successful, returns an info object representing the downloaded object.
# Interfaces
ContentValidator is an interface that knows how to validate an API object serialized to a byte array.
CRDFinder keeps a cache of known CRDs and finds a given GVK in the list.
ResourceMapping allows an object to return the resource mapping associated with the resource or resources it represents.
RESTClient is a client helper for dealing with RESTful resources in a generic way.
No description provided by the author
Verifier is the generic verifier interface used for testing QueryParamVerifier.
Visitor lets clients walk a list of resources.
Watchable describes a resource that can be watched for changes that occur on the server, beginning after the provided resource version.
# Type aliases
No description provided by the author
No description provided by the author
CRDGetter is a function that can download the list of GVK for all CRDs.
EagerVisitorList implements Visit for the sub visitors it contains.
ErrMatchFunc can be used to filter errors that may not be true failures.
No description provided by the author
No description provided by the author
No description provided by the author
RequestTransform is a function that is given a chance to modify the outgoing request.
No description provided by the author
VerifiableQueryParam is a query parameter who's enablement on the apiserver can be determined by evaluating the OpenAPI for a specific GVK.
VisitorFunc implements the Visitor interface for a matching function.
VisitorList implements Visit for the sub visitors it contains.