com.spotify.styx.model.StyxConfig Maven / Gradle / Ivy

Go to download
/*
 * -\-\-
 * Spotify Styx Scheduler Service
 * --
 * Copyright (C) 2017 Spotify AB
 * --
 * Licensed 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 com.spotify.styx.model;

import io.norberg.automatter.AutoMatter;
import java.util.List;
import java.util.Optional;

@AutoMatter
public interface StyxConfig {

  /**
   * Get the id of the current docker runner id
   */
  String globalDockerRunnerId();

  /**
   * Get the global enabled flag for Styx.
   */
  boolean globalEnabled();

  /**
   * Get the debug flag for Styx.
   */
  boolean debugEnabled();

  /**
   * Get the flag for enabling resource sync at startup.
   */
  boolean resourcesSyncEnabled();

  /**
   * Get the flag for enabling bootstrap of activeWFI indexes at startup.
   */
  boolean bootstrapActiveWFIEnabled();

  /**
   * Controls whether workflow instance execution gating should be performed. If set to false,
   * instances will be executed without checking for blockers.
   */
  boolean executionGatingEnabled();

  /**
   * Get the global concurrency for Styx.
   */
  Optional globalConcurrency();

  /**
   * Get the per-second submission rate limit for Styx.
   */
  Optional submissionRateLimit();

  /**
   * Get client blacklist.
   */
  List clientBlacklist();

  static StyxConfigBuilder newBuilder() {
    return new StyxConfigBuilder();
  }
}