aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/ThresholdCrossingAlertFields.java
blob: 340b78802b0bf0292a267abe7383b0514a27df1a (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 *  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.
 *  ============================LICENSE_END===========================================
 */

package org.openecomp.dcae.apod.analytics.model.domain.cef;

import lombok.Data;
import lombok.EqualsAndHashCode;

import java.util.List;

/**
 * Common Event Format - Fields Specific to threshold crossing alert events
 *
 * @author Rajiv Singla . Creation Date: 11/3/2016.
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class ThresholdCrossingAlertFields extends BaseCEFModel {

    private static final long serialVersionUID = 1L;

    /**
     * Additional Performance counters
     *
     * @param additionalParameters New value for Additional Performance counters
     * @return Additional Performance counters
     */
    private List<PerformanceCounter> additionalParameters;

    /**
     *  Event Action
     *
     *  @param alertAction New Event Action
     *  @return Event Action
     */
    private AlertAction alertAction;

    /**
     * Unique short alert description such as IF-SHUB-ERRDROP
     *
     * @param alertDescription New value for Unique short alert description
     * @return Unique short alert description
     */
    private String alertDescription;

    /**
     * Alert type
     *
     * @param alertType New value for Alert Type
     * @return Alert Type
     */
    private AlertType alertType;

    /**
     * Calculated API value (if applicable)
     *
     * @param alertValue New Calculated API value
     * @return Calculated API value (if applicable)
     */
    private String alertValue;

    /**
     * List of eventIds associated with the event being reported
     *
     * @param associatedAlertIdList New value for eventIds associated with the event
     * @return List of eventIds associated with the event being reported
     */
    private List<String> associatedAlertIdList;

    /**
     * Time when the performance collector picked up the data; with RFC 2822 compliant format:
     * ‘Sat, 13 Mar 2010 11:29:05 -0800’
     *
     * @param collectionTimestamp Set new value for time when the performance collector picked up the data
     * @return Time when the performance collector picked up the data
     */
    private String collectionTimestamp;

    /**
     * Specific performance collector instance used
     *
     * @param dataCollector New value for specific performance collector instance used
     * @return Specific performance collector instance used
     */
    private String dataCollector;

    /**
     * Type of network element - internal field
     *
     * @param elementType New value for type of network element - internal field
     * @return Type of network element - internal field
     */
    private String elementType;

    /**
     * Event severity or priority
     *
     * @param eventSeverity New value for event severity or priority
     * @return Event severity or priority
     */
    private EventSeverity eventSeverity;

    /**
     * Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’
     *
     * @param eventStartTimestamp New value for time closest to when the measurement was made
     * @return Time closest to when the measurement was made
     */
    private String eventStartTimestamp;

    /**
     * Physical or logical port or card (if applicable)
     *
     * @param interfaceName New value for Physical or logical port or card (if applicable)
     * @return Physical or logical port or card (if applicable)
     */
    private String interfaceName;

    /**
     * Network name - internal field
     *
     * @param networkService New value for network name - internal field
     * @return Network name - internal field
     */
    private String networkService;

    /**
     * Possible Root Cause (reserved for future use)
     *
     * @param possibleRootCause New value for possible root cause (reserved for future)
     * @return Possible Root Cause (reserved for future use)
     */
    private String possibleRootCause;

    /**
     * Version of the thresholdCrossingAlertFields block
     *
     * @param thresholdCrossingFieldsVersion New value for version of the thresholdCrossingAlertFields block
     * @return Version of the thresholdCrossingAlertFields block
     */
    private Integer thresholdCrossingFieldsVersion;


}