aboutsummaryrefslogtreecommitdiffstats
path: root/config-provisioning/src/main/java/com/yahoo/config/provision/zone/ZoneFilter.java
blob: 8847f742a48936e72a531050463f4ab3ba2643a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.provision.zone;

/**
 * A ZoneId list which can be filtered in various ways; elements can be accessed after at least one filter.
 *
 * The methods here return instances of {@link ZoneList}, which extends ZoneFilter, but with accessors and additional filters.
 * This forces the developer to consider which of the filters in this class to apply, prior to accessing any zones.
 * Note: Do not add further filters, as this is only meant for the levels of configuration of the zone, not other properties.
 *
 * @author jonmv
 */
public interface ZoneFilter {

    /** Negates the next filter. */
    ZoneFilter not();

    /** All zones defined in code, including those not yet set up. */
    ZoneList all();

    /** Zones where config servers are up and running. */
    ZoneList reachable();

    /** Zones which are upgraded by the controller. */
    ZoneList controllerUpgraded();

    /** Zones for use by tenants. */
    ZoneList publiclyVisible();

}