cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/models/datajob/ReadOperation.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Nordix Foundation
   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  *  SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.models.datajob;
  22
  23 import java.util.List;
  24
  25 /**
  26  * Holds information of read data job operation.
  27  * based on <a href="https://www.etsi.org/deliver/etsi_ts/128500_128599/128532/16.04.00_60/ts_128532v160400p.pdf">ETSI TS 128 532 V16.4.0 (2020-08)</a>
  28  *
  29  * @param path        Identifier of a managed object (MO) on a network element. Defines the resource on which operation
  30  *                    is executed. Url Encoded Fully Distinguished Name (FDN).
  31  * @param op          Describes the operation to execute. The value can only be "read".
  32  * @param operationId Unique identifier of the operation within the request.
  33  * @param attributes  Specifies the attributes of the resources that are returned.
  34  * @param fields      Specifies the attribute fields of the resources that are returned. This should be used if an
  35  *                    attribute is a struct and only a subset of its fields should be returned.
  36  * @param filter      This filters the managed Objects.
  37  * @param scopeType   This selects MOs depending on relationships with Base Managed Object.
  38  *                    e.g. "BASE_ONLY", "BASE_ALL", "BASE_NTH_LEVEL" etc.
  39  * @param scopeLevel  Defines the level for objects to be returned for certain scopeTypes. The base level is zero.
  40  */
  41 public record ReadOperation(String path, String op, String operationId, List<String> attributes, List<String> fields,
  42                             String filter, String scopeType, int scopeLevel) {
  43 }