Index

C D E F H I L M N O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

C

CANT_CREATE - Static variable in class org.elasticsearch.cli.ExitCodes

CliToolProvider - Interface in org.elasticsearch.cli

An interface for command line tools to be instantiated and run.

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) - 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

create() - Method in interface org.elasticsearch.cli.CliToolProvider

Constructs the CLI instance to be run.

D

DATA_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes

description - Variable in class org.elasticsearch.cli.Command

A description of the command, used in the help output.

E

envVars() - Method in record class org.elasticsearch.cli.ProcessInfo

Returns the value of the envVars record component.

equals(Object) - Method in record class org.elasticsearch.cli.ProcessInfo

Indicates whether some other object is "equal to" this one.

execute(Terminal, OptionSet, ProcessInfo) - Method in class org.elasticsearch.cli.Command

Executes this command.

execute(Terminal, OptionSet, ProcessInfo) - Method in class org.elasticsearch.cli.MultiCommand

exit(int) - Static method in class org.elasticsearch.cli.Command

exitCode - Variable in exception class 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.

F

fromSystem() - Static method in record class org.elasticsearch.cli.ProcessInfo

Return process info for the current JVM.

H

hashCode() - Method in record class org.elasticsearch.cli.ProcessInfo

Returns a hash code value for this object.

I

IO_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes

L

load(Map<String, String>, String, String) - Static method in interface org.elasticsearch.cli.CliToolProvider

Loads a tool provider from the Elasticsearch distribution.

M

main(String[], Terminal, ProcessInfo) - Method in class org.elasticsearch.cli.Command

Parses options for this command from args and executes it.

mainWithoutErrorHandling(String[], Terminal, ProcessInfo) - Method in class org.elasticsearch.cli.Command

Executes the command, but all errors are thrown.

MultiCommand - Class in org.elasticsearch.cli

A cli tool which is made up of multiple subcommands.

MultiCommand(String) - Constructor for class org.elasticsearch.cli.MultiCommand

Construct the multi-command with the specified command description and runnable to execute before main is invoked.

N

name() - Method in interface org.elasticsearch.cli.CliToolProvider

Returns the name of the tool provider.

NO_HOST - Static variable in class org.elasticsearch.cli.ExitCodes

NO_INPUT - Static variable in class org.elasticsearch.cli.ExitCodes

NO_USER - Static variable in class org.elasticsearch.cli.ExitCodes

NOOP - Static variable in class org.elasticsearch.cli.ExitCodes

NOPERM - Static variable in class org.elasticsearch.cli.ExitCodes

O

OK - Static variable in class org.elasticsearch.cli.ExitCodes

org.elasticsearch.cli - module org.elasticsearch.cli

Elasticsearch Command Line Interface.

org.elasticsearch.cli - package org.elasticsearch.cli

P

parseOptions(String[]) - Method in class org.elasticsearch.cli.Command

Parse command line arguments for this command.

parser - Variable in class org.elasticsearch.cli.Command

The option parser for this command.

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

printUserException(Terminal, UserException) - Method in class org.elasticsearch.cli.Command

printUserException(Terminal, UserException) - Method in class org.elasticsearch.cli.MultiCommand

ProcessInfo - Record Class in org.elasticsearch.cli

A holder for information about a CLI process.

ProcessInfo(Map<String, String>, Map<String, String>, Path) - Constructor for record class org.elasticsearch.cli.ProcessInfo

Creates an instance of a ProcessInfo record class.

PROTOCOL - Static variable in class org.elasticsearch.cli.ExitCodes

S

subcommands - Variable in class org.elasticsearch.cli.MultiCommand

sysprops() - Method in record class org.elasticsearch.cli.ProcessInfo

Returns the value of the sysprops record component.

T

TEMP_FAILURE - Static variable in class org.elasticsearch.cli.ExitCodes

toString() - Method in record class org.elasticsearch.cli.ProcessInfo

Returns a string representation of this record class.

U

UNAVAILABLE - Static variable in class org.elasticsearch.cli.ExitCodes

USAGE - Static variable in class org.elasticsearch.cli.ExitCodes

UserException - Exception Class in org.elasticsearch.cli

An exception representing a user fixable problem in Command usage.

UserException(int, String) - Constructor for exception class org.elasticsearch.cli.UserException

Constructs a UserException with an exit status and message to show the user.

UserException(int, String, Throwable) - Constructor for exception class org.elasticsearch.cli.UserException

Constructs a new user exception with specified exit status, message, and underlying cause.

W

workingDir() - Method in record class org.elasticsearch.cli.ProcessInfo

Returns the value of the workingDir record component.

C D E F H I L M N O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form