public String description()

in hyracks-fullstack/hyracks/hyracks-control/hyracks-control-common/src/main/java/org/apache/hyracks/control/common/controllers/CCConfig.java [139:225]


        public String description() {
            switch (this) {
                case APP_CLASS:
                    return "Application CC main class";
                case ADDRESS:
                    return "Default bind address for all services on this cluster controller";
                case PUBLIC_ADDRESS:
                    return "Default public address that other processes should use to contact this cluster controller. "
                            + "All services will advertise this address unless a service-specific public address is "
                            + "supplied.";
                case CLUSTER_LISTEN_ADDRESS:
                    return "Sets the IP Address to listen for connections from NCs";
                case CLUSTER_LISTEN_PORT:
                    return "Sets the port to listen for connections from node controllers";
                case CLUSTER_PUBLIC_ADDRESS:
                    return "Address that NCs should use to contact this CC";
                case CLUSTER_PUBLIC_PORT:
                    return "Port that NCs should use to contact this CC";
                case CLIENT_LISTEN_ADDRESS:
                    return "Sets the IP Address to listen for connections from clients";
                case CLIENT_LISTEN_PORT:
                    return "Sets the port to listen for connections from clients";
                case CLIENT_PUBLIC_ADDRESS:
                    return "The IP Address which clients should use to connect";
                case CLIENT_PUBLIC_PORT:
                    return "The port which clients should use to connect";
                case CONSOLE_LISTEN_ADDRESS:
                    return "Sets the listen address for the Cluster Controller";
                case CONSOLE_LISTEN_PORT:
                    return "Sets the http port for the Cluster Controller)";
                case CONSOLE_PUBLIC_ADDRESS:
                    return "Sets the address on which to contact the http console for the Cluster Controller";
                case CONSOLE_PUBLIC_PORT:
                    return "Sets the port on which to contact the http console for the Cluster Controller)";
                case HEARTBEAT_PERIOD:
                    return "Sets the time duration between two heartbeats from each node controller in milliseconds";
                case HEARTBEAT_MAX_MISSES:
                    return "Sets the maximum number of missed heartbeats before a node can be considered dead";
                case DEAD_NODE_SWEEP_THRESHOLD:
                    return "Sets the frequency (in milliseconds) to process nodes that can be considered dead";
                case PROFILE_DUMP_PERIOD:
                    return "Sets the time duration between two profile dumps from each node controller in "
                            + "milliseconds; 0 to disable";
                case JOB_HISTORY_SIZE:
                    return "Limits the number of historical jobs remembered by the system to the specified value";
                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 ROOT_DIR:
                    return "Sets the root folder used for file operations";
                case CLUSTER_TOPOLOGY:
                    return "Sets the XML file that defines the cluster topology";
                case JOB_QUEUE_CLASS:
                    return "Specify the implementation class name for the job queue";
                case JOB_QUEUE_CAPACITY:
                    return "The maximum number of jobs to queue before rejecting new jobs";
                case JOB_MANAGER_CLASS:
                    return "Specify the implementation class name for the job manager";
                case ENFORCE_FRAME_WRITER_PROTOCOL:
                    return "A flag indicating if runtime should enforce frame writer protocol and detect "
                            + "bad behaving operators";
                case CORES_MULTIPLIER:
                    return "the factor to multiply by the number of cores to determine maximum query concurrent "
                            + "execution level";
                case CONTROLLER_ID:
                    return "The 16-bit (0-65535) id of this Cluster Controller";
                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 CREDENTIAL_FILE:
                    return "Path to HTTP basic credentials";
                case GLOBAL_TXN_LOG_DIR:
                    return "Directory to store global transaction logs";
                case GLOBAL_TXN_COMMIT_TIMEOUT:
                    return "Timeout for Commit";
                case GLOBAL_TXN_ROLLBACK_TIMEOUT:
                    return "Timeout for Rollback";
                default:
                    throw new IllegalStateException("NYI: " + this);
            }
        }