This repository was archived by the owner on Jul 20, 2024. It is now read-only.
forked from splunk/splunk-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFiredAlert.java
More file actions
148 lines (133 loc) · 4.13 KB
/
FiredAlert.java
File metadata and controls
148 lines (133 loc) · 4.13 KB
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
/*
* Copyright 2012 Splunk, Inc.
*
* 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.
*/
package com.splunk;
import java.util.Date;
/**
* The {@code FiredAlert} class represents a fired alert.
*/
public class FiredAlert extends Entity {
/**
* Class constructor.
*
* @param service The connected {@code Service} instance.
* @param path The fired alert endpoint.
*/
FiredAlert(Service service, String path) {
super(service, path);
}
/**
* Returns this alert's actions (such as notifying by email, running a
* script, adding to RSS, tracking in Alert Manager, and enabling
* summary indexing).
*
* @return The alert actions, or {@code null} if not available.
*/
public String[] getAction() {
return getStringArray("actions", null);
}
/**
* Returns this alert's type.
*
* @return The alert type, or {@code null} if not available.
*/
public String getAlertType() {
return getString("alert_type", null);
}
/**
* Returns the rendered expiration time for this alert.
* This method is available in Splunk 4.3 and later.
*
* @return This alert's rendered expiration time, or {@code null} if not
* available.
*/
public String getExpirationTime() {
return getString("expiration_time_rendered", null);
}
/**
* Returns the rendered expiration time for this alert,
* parsed as a Date object.
* This method is available in Splunk 4.3 and later.
*
* @return This alert's rendered expiration time, or {@code null} if not
* available.
*/
public Date getParsedExpirationTime() {
return getDate("expiration_time_rendered", null);
}
/**
* Returns the saved search for this alert.
*
* @return The saved search name, or {@code null} if not available.
*/
public String getSavedSearchName() {
return getString("savedsearch_name", null);
}
/**
* Returns this alert's severity on a scale of 1 to 10, with 1 being the
* highest severity.
*
* @return This alert's severity, or -1 if the value is not specified.
*/
public int getSeverity() {
return getInteger("severity", -1);
}
/**
* Returns this alert's search ID (SID).
*
* @return This alert's SID, or {@code null} if not available.
*/
public String getSid() {
return getString("sid", null);
}
/**
* Returns the count of triggered alerts.
* This method is available in Splunk 4.3 and later.
*
* @return The number of triggered alerts, or -1 if not specified.
*/
public int getTriggeredAlertCount() {
return getInteger("triggered_alerts", -1);
}
/**
* Returns the time this alert was triggered.
*
* @return This alert's trigger time, or {@code null} if not available.
*/
public Date getTriggerTime() {
return getDate("trigger_time", null);
}
/**
* Returns this alert's rendered trigger time.
* This method is available in Splunk 4.3 and later.
*
* @return This alert's trigger time, or {@code null} if not available.
*/
public Date getTriggerTimeRendered() {
return getDate("trigger_time_rendered", null);
}
/**
* Indicates whether the result is a set of events (digest) or a single
* event (per result).
*
* This method is available in Splunk 4.3 and later.
*
* @return {@code true} if the result is a digest, {@code false} if per
* result.
*/
public boolean isDigestMode() {
return getBoolean("digest_mode", false);
}
}