org.apache.flink.client.cli.ClientOptions Maven / Gradle / Ivy

Go to download
/*
 * 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.client.cli;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ConfigOptions;
import org.apache.flink.configuration.DeploymentOptions;
import org.apache.flink.configuration.description.Description;
import org.apache.flink.configuration.description.TextElement;

import java.time.Duration;

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

/** Describes a client configuration parameter. */
@PublicEvolving
public class ClientOptions {

    public static final ConfigOption CLIENT_TIMEOUT =
            ConfigOptions.key("client.timeout")
                    .durationType()
                    .defaultValue(Duration.ofSeconds(60))
                    .withDeprecatedKeys(
                            "akka.client.timeout") // the deprecated AkkaOptions.CLIENT_TIMEOUT
                    .withDescription("Timeout on the client side.");

    public static final ConfigOption CLIENT_RETRY_PERIOD =
            ConfigOptions.key("client.retry-period")
                    .durationType()
                    .defaultValue(Duration.ofMillis(2000))
                    .withDescription(
                            "The interval (in ms) between consecutive retries of failed attempts to execute "
                                    + "commands through the CLI or Flink's clients, wherever retry is supported (default 2sec).");

    /** Timeout for job client to report its heartbeat. */
    public static final ConfigOption CLIENT_HEARTBEAT_TIMEOUT =
            key("client.heartbeat.timeout")
                    .durationType()
                    .defaultValue(Duration.ofMillis(180000L))
                    .withDescription(
                            Description.builder()
                                    .text(
                                            "Cancel the job if the dispatcher hasn't received the client's"
                                                    + " heartbeat after timeout when '%s' and '%s' are both true.",
                                            TextElement.text(DeploymentOptions.ATTACHED.key()),
                                            TextElement.text(
                                                    DeploymentOptions.SHUTDOWN_IF_ATTACHED.key()))
                                    .build());

    /** Time interval for job client to report its heartbeat. */
    public static final ConfigOption CLIENT_HEARTBEAT_INTERVAL =
            key("client.heartbeat.interval")
                    .durationType()
                    .defaultValue(Duration.ofMillis(30000L))
                    .withDescription(
                            Description.builder()
                                    .text(
                                            "Time interval for job client to report its heartbeat "
                                                    + "when '%s' and '%s' are both true. Cancel the job if timeout configured by '%s'.",
                                            TextElement.text(DeploymentOptions.ATTACHED.key()),
                                            TextElement.text(
                                                    DeploymentOptions.SHUTDOWN_IF_ATTACHED.key()),
                                            TextElement.text(CLIENT_HEARTBEAT_TIMEOUT.key()))
                                    .build());
}