entities/ran_function.proto

   1 /*
   2  * Copyright 2019 AT&T Intellectual Property
   3  * Copyright 2019 Nokia
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /*
  19  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  20  * platform project (RICP).
  21  */
  22
  23
  24 syntax = "proto3";
  25 package entities;
  26 import "google/protobuf/wrappers.proto";
  27
  28 message RanFunction {
  29     google.protobuf.UInt32Value ran_function_id = 1;
  30     RanFunctionDefinition ran_function_definition = 2;
  31     google.protobuf.UInt32Value ran_function_revision = 3;
  32 }
  33
  34 message RanFunctionDefinition {
  35     E2smGnbNrtRanFunctionDefinition e2sm_gnb_nrt_ran_function_definition = 1;
  36 }
  37
  38 message E2smGnbNrtRanFunctionDefinition {
  39     RanFunctionName ran_function_name = 1;
  40     repeated RicEventTriggerStyle ric_event_trigger_styles = 2;
  41     repeated RicReportStyle ric_report_styles = 3;
  42     repeated RicInsertStyle ric_insert_styles = 4;
  43     repeated RicControlStyle ric_control_styles = 5;
  44     repeated RicPolicyStyle ric_policy_styles = 6;
  45 }
  46
  47 message RanFunctionName {
  48     google.protobuf.StringValue ran_function_short_name = 1;
  49     google.protobuf.StringValue ran_function_e2sm_oid = 2;
  50     google.protobuf.StringValue ran_function_description = 3;
  51     oneof optional_ran_function_instance {
  52         uint32 ran_function_instance = 4;
  53     }
  54 }
  55
  56 message RicEventTriggerStyle {
  57     google.protobuf.UInt32Value ric_event_trigger_style_type = 1;
  58     google.protobuf.StringValue ric_event_trigger_style_name = 2;
  59     google.protobuf.UInt32Value ric_event_trigger_format_type = 3;
  60 }
  61
  62 enum RanParameterType {
  63     UNKNOWN_RAN_PARAMETER_TYPE = 0;
  64     INTEGER = 1;
  65     ENUMERATED = 2;
  66     BOOLEAN = 3;
  67     BIT_STRING = 4;
  68     OCTET_STRING = 5;
  69     PRINTABLE_STRING = 6;
  70 }
  71
  72 message RanParameterDef {
  73     google.protobuf.UInt32Value ran_parameter_id = 1;
  74     google.protobuf.StringValue ran_parameter_name = 2;
  75     RanParameterType ran_parameter_type = 3;
  76 }
  77
  78 message RicReportStyle {
  79     google.protobuf.UInt32Value ric_report_style_type = 1;
  80     google.protobuf.StringValue ric_report_style_name = 2;
  81     google.protobuf.UInt32Value ric_report_action_format_type = 3;
  82     repeated RanParameterDef ric_report_ran_parameter_defs = 4;
  83     google.protobuf.UInt32Value ric_indication_header_format_type = 5;
  84     google.protobuf.UInt32Value ric_indication_message_format_type = 6;
  85 }
  86
  87
  88 message RicInsertStyle {
  89     google.protobuf.UInt32Value ric_insert_style_type = 1;
  90     google.protobuf.StringValue ric_insert_style_name = 2;
  91     google.protobuf.UInt32Value ric_insert_action_format_type = 3;
  92     repeated RanParameterDef ric_insert_ran_parameter_defs = 4;
  93     google.protobuf.UInt32Value ric_indication_header_format_type = 5;
  94     google.protobuf.UInt32Value ric_indication_message_format_type = 6;
  95     google.protobuf.UInt32Value ric_call_process_id_format_type = 7;
  96 }
  97
  98 message RicControlStyle {
  99     google.protobuf.UInt32Value ric_control_style_type = 1;
 100     google.protobuf.StringValue ric_control_style_name = 2;
 101     google.protobuf.UInt32Value ric_control_header_format_type = 3;
 102     google.protobuf.UInt32Value ric_control_message_format_type = 4;
 103     google.protobuf.UInt32Value ric_call_process_id_format_type = 5;
 104 }
 105
 106 message RicPolicyStyle {
 107     google.protobuf.UInt32Value ric_policy_style_type = 1;
 108     google.protobuf.StringValue ric_policy_style_name = 2;
 109     google.protobuf.UInt32Value ric_policy_action_format_type = 3;
 110     repeated RanParameterDef ric_policy_ran_parameter_defs = 4;
 111 }