forecaster.proto

// Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (https://tfs.etsi.org/)
//
// 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.

syntax = "proto3";
package forecaster;

import "context.proto";

service ForecasterService {
  rpc ComputeTopologyForecast(ForecastTopology) returns (ListLinkCapacity) {}
  rpc ComputeLinkForecast    (context.LinkId    ) returns (LinkCapacity    ) {}
}

message ForecastRequest {
  oneof uuid {
    context.TopologyId topology_id = 1;
    context.LinkId link_id = 2;
  }

  context.TopogyId topology_id             = 1;
  float            forecast_window_seconds = 2;
}


message SingleForecast {
  context.Timestamp timestamp= 1;
  double value = 2;    
}

message Forecast {
  oneof uuid {
    context.TopologyId topologyId= 1;
    context.LinkId linkId = 2;
  }
  repeated SingleForecast forecast = 3;
}

enum AvailabilityPredictionEnum {
  FORECASTED_AVAILABILITY = 0;
  FORECASTED_UNAVAILABILITY = 1;
}

message ForecastPrediction {
  AvailabilityPredictionEnum prediction = 1;
}



message LinkCapacity {
  context.LinkId link_id                  = 1;
  float          total_capacity_gbps      = 2;
  float          current_capacity_gbps    = 3;
  float          forecasted_capacity_gbps = 4;
}

message ListLinkCapacity {
  repeated LinkCapacity forecasted_link_capacities = 1;
}