/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.configuration;

import org.apache.flink.annotation.PublicEvolving;

import static org.apache.flink.configuration.ConfigOptions.key;

/**
 * The set of configuration options relating to Queryable State.
 */
@PublicEvolving
public class QueryableStateOptions {

	// ------------------------------------------------------------------------
	// Server Options
	// ------------------------------------------------------------------------

	/** Flag to indicate whether to start the queryable state server. */
	public static final ConfigOption<Boolean> SERVER_ENABLE =
			key("query.server.enable")
			.defaultValue(true);

	/** Port to bind KvState server to (0 => pick random available port). */
	public static final ConfigOption<Integer> SERVER_PORT =
			key("query.server.port")
			.defaultValue(0);

	/** Number of network (event loop) threads for the KvState server (0 => #slots). */
	public static final ConfigOption<Integer> SERVER_NETWORK_THREADS =
			key("query.server.network-threads")
			.defaultValue(0);

	/** Number of async query threads for the KvStateServerHandler (0 => #slots). */
	public static final ConfigOption<Integer> SERVER_ASYNC_QUERY_THREADS =
			key("query.server.query-threads")
			.defaultValue(0);

	// ------------------------------------------------------------------------
	// Client Options
	// ------------------------------------------------------------------------

	/** Number of network (event loop) threads for the KvState client (0 => Use number of available cores). */
	public static final ConfigOption<Integer> CLIENT_NETWORK_THREADS =
			key("query.client.network-threads")
			.defaultValue(0);

	/** Number of retries on location lookup failures. */
	public static final ConfigOption<Integer> CLIENT_LOOKUP_RETRIES =
			key("query.client.lookup.num-retries")
			.defaultValue(3);

	/** Retry delay on location lookup failures (millis). */
	public static final ConfigOption<Integer> CLIENT_LOOKUP_RETRY_DELAY =
			key("query.client.lookup.retry-delay")
			.defaultValue(1000);

	// ------------------------------------------------------------------------

	/** Not intended to be instantiated */
	private QueryableStateOptions() {
	}
}