aboutsummaryrefslogtreecommitdiffstats
path: root/cmso-topology/src/main/java/org/onap/optf/cmso/topology/service/rs/models/ConstraintElements.java
blob: b3ff906c71321903b68d53d56d9d0ce72da696c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*******************************************************************************
 *
 * Copyright © 2019 AT&T Intellectual Property.
 *
 * 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.
 *
 *
 * Unless otherwise specified, all documentation contained herein is licensed under the Creative
 * Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * https://creativecommons.org/licenses/by/4.0/
 *
 * Unless required by applicable law or agreed to in writing, documentation 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.
 ******************************************************************************/

package org.onap.optf.cmso.topology.service.rs.models;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.List;

@ApiModel(value = "Topology Constraint ELements",
                description = "Constraining Element Information returned from TopologyRequuest.")
public class ConstraintElements implements Serializable {
    private static final long serialVersionUID = 1L;

    public enum AvailabilityMatrixScope {
        NONE, GLOBAL, ELEMENT,
    }

    @ApiModelProperty(value = "Element identifier")
    private String elementId;

    @ApiModelProperty(value = "Type of constraint.")
    private String constraintType;

    @ApiModelProperty(
                    value = "If more than one instance of constraintType,"
                                    + " minimum number of available instances required."
                                    + " Useful for identifying availableBackup elements, service paths.")
    private Integer constraintTypeMinimum = 1;

    @ApiModelProperty(value = "Availability matrix name. Availability matrix will not be passed to optimizer engine."
                    + " Generally useful for global concurrency type constraints.")
    private String optimizerAvailabilityMatrixName;

    @ApiModelProperty(value = "Availability matrix scope global  or scoped per elementId.")
    private AvailabilityMatrixScope availabilityMatrixScope = AvailabilityMatrixScope.NONE;

    @ApiModelProperty(value = "Availability matrix is aggregated into element availability marrix.")
    private boolean elementAvailabilityAggreagation = true;

    @ApiModelProperty(value = "Elements ")
    private List<String> elements;

    public String getElementId() {
        return elementId;
    }

    public void setElementId(String elementId) {
        this.elementId = elementId;
    }

    public String getConstraintType() {
        return constraintType;
    }

    public void setConstraintType(String constraintType) {
        this.constraintType = constraintType;
    }

    public Integer getConstraintTypeMinimum() {
        return constraintTypeMinimum;
    }

    public void setConstraintTypeMinimum(Integer constraintTypeMinimum) {
        this.constraintTypeMinimum = constraintTypeMinimum;
    }

    public String getOptimizerAvailabilityMatrixName() {
        return optimizerAvailabilityMatrixName;
    }

    public void setOptimizerAvailabilityMatrixName(String optimizerAvailabilityMatrixName) {
        this.optimizerAvailabilityMatrixName = optimizerAvailabilityMatrixName;
    }

    public List<String> getElements() {
        return elements;
    }

    public void setElements(List<String> elements) {
        this.elements = elements;
    }

    public AvailabilityMatrixScope getAvailabilityMatrixScope() {
        return availabilityMatrixScope;
    }

    public void setAvailabilityMatrixScope(AvailabilityMatrixScope availabilityMatrixScope) {
        this.availabilityMatrixScope = availabilityMatrixScope;
    }

    public boolean isElementAvailabilityAggreagation() {
        return elementAvailabilityAggreagation;
    }

    public void setElementAvailabilityAggreagation(boolean elementAvailabilityAggreagation) {
        this.elementAvailabilityAggreagation = elementAvailabilityAggreagation;
    }



}