clustercontroller-utils/src/main/java/com/yahoo/vespa/clustercontroller/utils/staterestapi/StateRestAPI.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.clustercontroller.utils.staterestapi;

import com.yahoo.vespa.clustercontroller.utils.staterestapi.errors.StateRestApiException;
import com.yahoo.vespa.clustercontroller.utils.staterestapi.requests.SetUnitStateRequest;
import com.yahoo.vespa.clustercontroller.utils.staterestapi.requests.UnitStateRequest;
import com.yahoo.vespa.clustercontroller.utils.staterestapi.response.SetResponse;
import com.yahoo.vespa.clustercontroller.utils.staterestapi.response.UnitResponse;

/**
 * Interface to implement for backends that want to have a State Rest API.
 */
public interface StateRestAPI {

    UnitResponse getState(UnitStateRequest request) throws StateRestApiException;

    SetResponse setUnitState(SetUnitStateRequest request) throws StateRestApiException;

}