Index (elasticsearch-cli 7.4.2 API)

A

addShutdownHook() - Method in class org.elasticsearch.cli.Command: Return whether or not to install the shutdown hook to cleanup resources on exit.

CANT_CREATE - Static variable in class org.elasticsearch.cli.ExitCodes
close() - Method in class org.elasticsearch.cli.Command
close() - Method in class org.elasticsearch.cli.MultiCommand
CODE_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes
Command - Class in org.elasticsearch.cli: An action to execute within a cli.
Command(String, Runnable) - Constructor for class org.elasticsearch.cli.Command: Construct the command with the specified command description and runnable to execute before main is invoked.
CONFIG - Static variable in class org.elasticsearch.cli.ExitCodes

DATA_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes
DEFAULT - Static variable in class org.elasticsearch.cli.Terminal: The default terminal implementation, which will be a console if available, or stdout/stderr if not.
description - Variable in class org.elasticsearch.cli.Command: A description of the command, used in the help output.

errorPrint(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal: Prints a line to the terminal's standard error at Terminal.Verbosity.NORMAL verbosity level, without a newline.
errorPrintln(String) - Method in class org.elasticsearch.cli.Terminal: Prints a line to the terminal's standard error at Terminal.Verbosity.NORMAL verbosity level.
errorPrintln(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal: Prints a line to the terminal's standard error at verbosity level.
execute(Terminal, OptionSet) - Method in class org.elasticsearch.cli.Command: Executes this command.
execute(Terminal, OptionSet) - Method in class org.elasticsearch.cli.MultiCommand
exit(int) - Static method in class org.elasticsearch.cli.Command
exitCode - Variable in exception org.elasticsearch.cli.UserException: The exist status the cli should use when catching this user error.
ExitCodes - Class in org.elasticsearch.cli: POSIX exit codes.

getErrorWriter() - Method in class org.elasticsearch.cli.Terminal: Returns a Writer which can be used to write to the terminal directly using standard error.
getWriter() - Method in class org.elasticsearch.cli.Terminal: Returns a Writer which can be used to write to the terminal directly using standard output.

IO_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes
isPrintable(Terminal.Verbosity) - Method in class org.elasticsearch.cli.Terminal: Checks if is enough verbosity level to be printed

main(String[], Terminal) - Method in class org.elasticsearch.cli.Command: Parses options for this command from args and executes it.
MultiCommand - Class in org.elasticsearch.cli: A cli tool which is made up of multiple subcommands.
MultiCommand(String, Runnable) - Constructor for class org.elasticsearch.cli.MultiCommand: Construct the multi-command with the specified command description and runnable to execute before main is invoked.

parser - Variable in class org.elasticsearch.cli.Command: The option parser for this command.
print(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal: Prints message to the terminal's standard output at verbosity level, without a newline.
printAdditionalHelp(Terminal) - Method in class org.elasticsearch.cli.Command: Prints additional help information, specific to the command
printAdditionalHelp(Terminal) - Method in class org.elasticsearch.cli.MultiCommand
println(String) - Method in class org.elasticsearch.cli.Terminal: Prints a line to the terminal at Terminal.Verbosity.NORMAL verbosity level.
println(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal: Prints a line to the terminal at verbosity level.
promptYesNo(String, boolean) - Method in class org.elasticsearch.cli.Terminal: Prompt for a yes or no answer from the user.
PROTOCOL - Static variable in class org.elasticsearch.cli.ExitCodes

readSecret(String) - Method in class org.elasticsearch.cli.Terminal: Reads password text from the terminal input.
readText(String) - Method in class org.elasticsearch.cli.Terminal: Reads clear text from the terminal input.
reason() - Method in annotation type org.elasticsearch.cli.SuppressForbidden

setVerbosity(Terminal.Verbosity) - Method in class org.elasticsearch.cli.Terminal: Sets the verbosity of the terminal.
SILENT - org.elasticsearch.cli.Terminal.Verbosity
subcommands - Variable in class org.elasticsearch.cli.MultiCommand
SuppressForbidden - Annotation Type in org.elasticsearch.cli: Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.

TEMP_FAILURE - Static variable in class org.elasticsearch.cli.ExitCodes
Terminal - Class in org.elasticsearch.cli: A Terminal wraps access to reading input and writing output for a cli.
Terminal(String) - Constructor for class org.elasticsearch.cli.Terminal
Terminal.Verbosity - Enum in org.elasticsearch.cli: Defines the available verbosity levels of messages to be printed.

UNAVAILABLE - Static variable in class org.elasticsearch.cli.ExitCodes
USAGE - Static variable in class org.elasticsearch.cli.ExitCodes
UserException - Exception in org.elasticsearch.cli: An exception representing a user fixable problem in Command usage.
UserException(int, String) - Constructor for exception org.elasticsearch.cli.UserException: Constructs a UserException with an exit status and message to show the user.
UserException(int, String, Throwable) - Constructor for exception org.elasticsearch.cli.UserException: Constructs a new user exception with specified exit status, message, and underlying cause.

valueOf(String) - Static method in enum org.elasticsearch.cli.Terminal.Verbosity: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.elasticsearch.cli.Terminal.Verbosity: Returns an array containing the constants of this enum type, in the order they are declared.
VERBOSE - org.elasticsearch.cli.Terminal.Verbosity