Index (opensearch-cli 2.18.0 API)

A C D E F G I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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

C

CANT_CREATE - Static variable in class org.opensearch.cli.ExitCodes: can't create (user) output file
close() - Method in class org.opensearch.cli.Command
close() - Method in class org.opensearch.cli.MultiCommand
CODE_ERROR - Static variable in class org.opensearch.cli.ExitCodes: internal software error
Command - Class in org.opensearch.cli: An action to execute within a cli.
Command(String, Runnable) - Constructor for class org.opensearch.cli.Command: Construct the command with the specified command description and runnable to execute before main is invoked.
CONFIG - Static variable in class org.opensearch.cli.ExitCodes: configuration error

D

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

E

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

F

flush() - Method in class org.opensearch.cli.Terminal: Flushes the terminal's standard output and standard error.

G

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

I

IO_ERROR - Static variable in class org.opensearch.cli.ExitCodes: input/output error
isPrintable(Terminal.Verbosity) - Method in class org.opensearch.cli.Terminal: Checks if given Terminal.Verbosity level is high enough to be printed at the level defined by Terminal.verbosity

M

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

N

NO_HOST - Static variable in class org.opensearch.cli.ExitCodes: host name unknown
NO_INPUT - Static variable in class org.opensearch.cli.ExitCodes: cannot open input
NO_USER - Static variable in class org.opensearch.cli.ExitCodes: addressee unknown
NOPERM - Static variable in class org.opensearch.cli.ExitCodes: permission denied
NORMAL - Enum constant in enum org.opensearch.cli.Terminal.Verbosity: printed when no options are given to cli

O

OK - Static variable in class org.opensearch.cli.ExitCodes: No error
org.opensearch.cli - package org.opensearch.cli

P

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

R

readLineToCharArray(Reader, int) - Static method in class org.opensearch.cli.Terminal: Read from the reader until we find a newline.
readSecret(String) - Method in class org.opensearch.cli.Terminal: Reads secret text from the terminal input with echoing disabled.
readSecret(String, int) - Method in class org.opensearch.cli.Terminal: Read secret text from terminal input with echoing disabled, up to a maximum length.
readText(String) - Method in class org.opensearch.cli.Terminal: Reads clear text from the terminal input.
reason() - Element in annotation type org.opensearch.cli.SuppressForbidden

S

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

T

TEMP_FAILURE - Static variable in class org.opensearch.cli.ExitCodes: temp failure; user is invited to retry
Terminal - Class in org.opensearch.cli: A Terminal wraps access to reading input and writing output for a cli.
Terminal(String) - Constructor for class org.opensearch.cli.Terminal: Constructs a new terminal with the given line separator.
Terminal.Verbosity - Enum in org.opensearch.cli: Defines the available verbosity levels of messages to be printed.

U

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

V

valueOf(String) - Static method in enum org.opensearch.cli.Terminal.Verbosity: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.opensearch.cli.Terminal.Verbosity: Returns an array containing the constants of this enum type, in the order they are declared.
VERBOSE - Enum constant in enum org.opensearch.cli.Terminal.Verbosity: printed only when cli is passed verbose option

A C D E F G I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form