public String description()

in hyracks-fullstack/hyracks/hyracks-control/hyracks-control-common/src/main/java/org/apache/hyracks/control/common/controllers/NCConfig.java [146:263]


        public String description() {
            switch (this) {
                case ADDRESS:
                    return "Default IP Address to bind listeners on this NC.  All services will bind on this address "
                            + "unless a service-specific listen address is supplied.";
                case CLUSTER_LISTEN_ADDRESS:
                    return "IP Address to bind cluster listener on this NC";
                case PUBLIC_ADDRESS:
                    return "Default public address that other processes should use to contact this NC.  All services "
                            + "will advertise this address unless a service-specific public address is supplied.";
                case NCSERVICE_ADDRESS:
                    return "Address the CC should use to contact the NCService associated with this NC";
                case NCSERVICE_PORT:
                    return "Port the CC should use to contact the NCService associated with this NC (-1 to not use "
                            + "NCService to start this NC)";
                case CLUSTER_ADDRESS:
                    return "Cluster Controller address (required unless specified in config file)";
                case CLUSTER_PORT:
                    return "Cluster Controller port";
                case CLUSTER_LISTEN_PORT:
                    return "IP port to bind cluster listener";
                case CLUSTER_PUBLIC_ADDRESS:
                    return "Public IP Address to announce cluster listener";
                case CLUSTER_PUBLIC_PORT:
                    return "Public IP port to announce cluster listener";
                case NODE_ID:
                    return "Logical name of node controller unique within the cluster (required unless specified in "
                            + "config file)";
                case DATA_LISTEN_ADDRESS:
                    return "IP Address to bind data listener";
                case DATA_LISTEN_PORT:
                    return "IP port to bind data listener";
                case DATA_PUBLIC_ADDRESS:
                    return "Public IP Address to announce data listener";
                case DATA_PUBLIC_PORT:
                    return "Public IP port to announce data listener";
                case RESULT_LISTEN_ADDRESS:
                    return "IP Address to bind result distribution listener";
                case RESULT_LISTEN_PORT:
                    return "IP port to bind result distribution listener";
                case RESULT_PUBLIC_ADDRESS:
                    return "Public IP Address to announce result distribution listener";
                case RESULT_PUBLIC_PORT:
                    return "Public IP port to announce result distribution listener";
                case MESSAGING_LISTEN_ADDRESS:
                    return "IP Address to bind messaging listener";
                case MESSAGING_LISTEN_PORT:
                    return "IP port to bind messaging listener";
                case MESSAGING_PUBLIC_ADDRESS:
                    return "Public IP Address to announce messaging listener";
                case MESSAGING_PUBLIC_PORT:
                    return "Public IP port to announce messaging listener";
                case REPLICATION_PUBLIC_ADDRESS:
                    return "Public address to advertise for replication service";
                case REPLICATION_PUBLIC_PORT:
                    return "Public port to advertise for replication service";
                case REPLICATION_LISTEN_ADDRESS:
                    return "Replication bind address";
                case REPLICATION_LISTEN_PORT:
                    return "Port to listen on for replication service";
                case CLUSTER_CONNECT_RETRIES:
                    return "Number of attempts to retry contacting CC before giving up";
                case IODEVICES:
                    return "Comma separated list of IO Device mount points";
                case NET_THREAD_COUNT:
                    return "Number of threads to use for Network I/O";
                case NET_BUFFER_COUNT:
                    return "Number of network buffers per input/output channel";
                case RESULT_TTL:
                    return "Limits the amount of time results for asynchronous jobs should be retained by the system "
                            + "in milliseconds";
                case RESULT_SWEEP_THRESHOLD:
                    return "The duration within which an instance of the result cleanup should be invoked in "
                            + "milliseconds";
                case RESULT_MANAGER_MEMORY:
                    return "Memory usable for result caching at this Node Controller in bytes";
                case APP_CLASS:
                    return "Application NC Main Class";
                case NCSERVICE_PID:
                    return "PID of the NCService which launched this NCDriver";
                case COMMAND:
                    return "Command NCService should invoke to start the NCDriver";
                case JVM_ARGS:
                    return "JVM args to pass to the NCDriver";
                case TRACE_CATEGORIES:
                    return "Categories for tracing";
                case KEY_STORE_PATH:
                    return "A fully-qualified path to a key store file that will be used for secured connections";
                case TRUST_STORE_PATH:
                    return "A fully-qualified path to a trust store file that will be used for secured connections";
                case KEY_STORE_PASSWORD:
                    return "The password to the provided key store";
                case IO_WORKERS_PER_PARTITION:
                    return "Number of threads per partition used to write and read from storage";
                case IO_QUEUE_SIZE:
                    return "Length of the queue used for requests to write and read";
                case PYTHON_CMD:
                    return "Absolute path to python interpreter";
                case PYTHON_ADDITIONAL_PACKAGES:
                    return "List of additional paths, separated by a path separator character, to add to sys.path behind msgpack and library package paths";
                case PYTHON_USE_BUNDLED_MSGPACK:
                    return "True to include bundled msgpack on Python sys.path, false to use system-provided msgpack";
                case PYTHON_ARGS:
                    return "Python args to pass to Python interpreter";
                case PYTHON_CMD_AUTOLOCATE:
                    return "Whether or not to attempt to automatically set PYTHON_CMD to a usable interpreter";
                case PYTHON_ENV:
                    return "List of environment variables to set when invoking the Python interpreter for Python UDFs. E.g. FOO=1";
                case PYTHON_DS_PATH:
                    return "Path to systemd socket for fenced Python UDFs. Requires JDK17+, *nix operating system, and ";
                case CREDENTIAL_FILE:
                    return "Path to HTTP basic credentials";
                case ABORT_TASKS_TIMEOUT:
                    return "The maximum time to wait for the tasks to be aborted";
                default:
                    throw new IllegalStateException("Not yet implemented: " + this);
            }
        }