aboutsummaryrefslogtreecommitdiffstats
path: root/controller-server/src/main/java/com/yahoo/vespa/hosted/controller/routing/RoutingStatus.java
blob: de16089e735c94b34f5adea391af84f81016b027 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.routing;

import java.time.Instant;
import java.util.Objects;

/**
 * Represents the routing status of a {@link RoutingPolicy} or {@link ZoneRoutingPolicy}.
 *
 * This describes which agent last changed the routing status and at which time.
 *
 * This is immutable.
 *
 * @author mpolden
 */
public record RoutingStatus(Value value, Agent agent, Instant changedAt) {

    public static final RoutingStatus DEFAULT = new RoutingStatus(Value.in, Agent.system, Instant.EPOCH);

    /** DO NOT USE. Public for serialization purposes */
    public RoutingStatus {
        Objects.requireNonNull(value, "value must be non-null");
        Objects.requireNonNull(agent, "agent must be non-null");
        Objects.requireNonNull(changedAt, "changedAt must be non-null");
    }

    /**
     * The wanted value of this. The system will try to set this value, but there are constraints that may lead to
     * the effective value not matching this. See {@link RoutingPolicies}.
     */
    public Value value() {
        return value;
    }

    /** The agent who last changed this */
    public Agent agent() {
        return agent;
    }

    /** The time this was last changed */
    public Instant changedAt() {
        return changedAt;
    }

    @Override
    public String toString() {
        return "status " + value + ", changed by " + agent + " @ " + changedAt;
    }

    public static RoutingStatus create(Value value, Agent agent, Instant instant) {
        return new RoutingStatus(value, agent, instant);
    }

    // Used in serialization. Do not change.
    public enum Value {
        /** Status is determined by health checks **/
        in,

        /** Status is explicitly set to out */
        out,
    }

    /** Agents that can change the state of global routing */
    public enum Agent {
        operator,
        tenant,
        system,
        unknown, // For compatibility old values from /routing/v1 on config server, which may contain a specific username.
    }

}