/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2024 Nordix Foundation
 *  ================================================================================
 *  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.
 *
 *  SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.cps.ncmp.api.models.datajob;

import java.util.List;

/**
 * Holds information of read data job operation.
 * 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>
 *
 * @param path        Identifier of a managed object (MO) on a network element. Defines the resource on which operation
 *                    is executed. Url Encoded Fully Distinguished Name (FDN).
 * @param op          Describes the operation to execute. The value can only be "read".
 * @param operationId Unique identifier of the operation within the request.
 * @param attributes  Specifies the attributes of the resources that are returned.
 * @param fields      Specifies the attribute fields of the resources that are returned. This should be used if an
 *                    attribute is a struct and only a subset of its fields should be returned.
 * @param filter      This filters the managed Objects.
 * @param scopeType   This selects MOs depending on relationships with Base Managed Object.
 *                    e.g. "BASE_ONLY", "BASE_ALL", "BASE_NTH_LEVEL" etc.
 * @param scopeLevel  Defines the level for objects to be returned for certain scopeTypes. The base level is zero.
 */
public record ReadOperation(String path, String op, String operationId, List<String> attributes, List<String> fields,
                            String filter, String scopeType, int scopeLevel) {
}