package
0.0.0-20210318211101-2bc12df73e84
Repository: https://github.com/puppetlabs/wash.git
Documentation: pkg.go.dev
# Packages
Package aws presents a filesystem hierarchy for AWS resources.
Package docker presents a filesystem hierarchy for Docker resources.
No description provided by the author
Package gcp presents a filesystem hierarchy for Google Cloud Platform resources.
Package kubernetes presents a filesystem hierarchy for Kubernetes resources.
No description provided by the author
# Functions
Actions returns all of the available Wash actions as a map of <action_name> => <action_object>.
Attributes returns the entry's attributes.
BooleanSchema represents a boolean's schema (bool).
CachedOp caches the given op's result for the duration specified by the ttl.
ClearCacheFor removes entries from the cache that match or are children of the provided path.
CName returns the entry's canonical name, which is what Wash uses to
construct the entry's path.
Delete deletes the given entry.
DeleteAction represents the delete action.
DeleteWithAnalytics is a wrapper to plugin.Delete.
Exec execs the command on the given entry.
ExecAction represents the exec action.
ExecWithAnalytics is a wrapper to e#Exec.
FindEntry returns the child of start found by following the segments, or an error if it cannot be found.
ID returns the entry's ID, which is just its path rooted at Wash's mountpoint.
InitCache initializes the cache.
InitInteractive is used by Wash commands to set option-specific overrides.
IntegerSchema represents an integer's schema (int).
IsInteractive returns true if Wash is running as an interactive session.
IsInvalidInputErr returns true if err is an InvalidInputErr error object.
IsPrefetched returns whether an entry has data that was added during creation that it would like to have updated.
List lists the parent's children.
ListAction represents the list action.
ListWithAnalytics is a wrapper to plugin.List.
Metadata returns the entry's metadata.
Name returns the entry's name as it was passed into
plugin.NewEntry.
NewEntry creates a new entry.
NewEntrySchema returns a new EntrySchema object with the specified label.
NewExecCommand creates a new ExecCommandImpl object whose lifetime is tied to the passed-in execution context.
NewMetadataJSONFile creates a new MetadataJSONFile.
NewRegistry creates a new plugin registry object.
NumberSchema represents a number's schema (float64).
PartialMetadata returns the entry's partial metadata, a subset of the entry's metadata that is typically provided by the plugin API's List endpoint.
Prompt prints the supplied message, then waits for input on stdin.
Read reads up to size bits of the entry's content starting at the given offset.
ReadAction represents the read action.
ReadWithAnalytics is a wrapper to plugin.Read.
Schema returns the entry's schema.
SchemaGraph returns e's schema graph.
SetTestCache sets the cache to the provided mock.
Signal signals the entry with the specified signal.
SignalAction represents the signal action.
SignalWithAnalytics is a wrapper to plugin.Signal.
Size returns the size of readable data for an entry.
Stream streams the entry's content for updates.
StreamAction represents the stream action.
StreamWithAnalytics is a wrapper to s#Stream.
StringSchema represents a string's schema (string).
SupportedActionsOf returns all of the given entry's supported actions.
TimeSchema represents the schema of a time.Time object.
ToJSONObject serializes v to a JSON object.
TrackTime helper is useful for timing functions.
TypeID returns the entry's type ID.
UnsetTestCache unsets the test cache.
Write sends the supplied buffer to the entry.
WriteAction represents the append action.
WriteWithAnalytics is a wrapper to w#Write.
# Constants
Defines different method signatures.
Defines different method signatures.
ListOp represents Parent#List.
MetadataOp represents Entry#Metadata.
Defines specific Shell classes you can configure.
Defines specific Shell classes you can configure.
ReadOp represents Readable/BlockReadable#Read.
Enumerates packet types.
Enumerates packet types.
Defines specific Shell classes you can configure.
Defines different method signatures.
# Variables
DefaultTimeout is the default timeout for prefetching.
# Structs
Action represents a Wash action.
CleanupReader is a wrapper for an io.ReadCloser that performs cleanup when closed.
DuplicateCNameErr represents a duplicate cname error, which occurs when at least two children have the same cname.
EntryAttributes represents an entry's attributes.
EntryBase implements Entry, making it easy to create new entries.
EntryMap is a thread-safe map of <entry_cname> => <entry_object>.
EntrySchema represents an entry's schema.
ExecCommandImpl implements the plugin.ExecCommand interface.
ExecOptions is a struct we can add new features to that must be serializable to JSON.
ExecOutputChunk is a struct containing a chunk of the Exec'ed cmd's output.
InvalidInputErr indicates that the method invocation received invalid input (e.g.
MetadataJSONFile represents a metadata.json file that contains another entry's metadata.
OS contains information about the operating system of a compute-like entry.
OutputStream represents stdout/stderr.
Registry represents the plugin registry.
SignalSchema represents a given signal/signal group's schema.
# Interfaces
BlockReadable is an entry with data that can be read in blocks.
Deletable is an entry that can be deleted.
Entry is the interface for things that are representable by Wash's filesystem.
Execable is an entry that can have a command run on it.
ExecCommand represents a command that was invoked by a call to Exec.
HasWrappedTypes is an interface that's used by the EntrySchema#SetMeta*Schema methods to return the right metadata schema for wrapped types.
Parent is an entry with children.
Readable is an entry with data that can be read.
Root represents the plugin root.
Signalable is an entry that can be signaled.
Streamable is an entry that returns a stream of updates.
Writable is an entry that we can write new data to.
# Type aliases
ExecPacketType identifies the packet type.
JSONObject is a typedef to a map[string]interface{} object.
JSONSchema represents a JSON schema.
MethodSignature defines what method signature is supported for a method.
SchemaMap represents a map of <type> => <JSON schema>.
Shell describes a command shell.