esp_sdk 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +1 -0
- data/CHANGELOG.md +6 -1
- data/Gemfile.lock +11 -1
- data/README.md +287 -28
- data/bin/esp +15 -0
- data/esp_sdk.gemspec +2 -0
- data/lib/esp/aws_clients.rb +60 -0
- data/lib/esp/commands/add_external_account.rb +57 -0
- data/lib/esp/commands/commands_tasks.rb +106 -0
- data/lib/esp/commands/console.rb +68 -0
- data/lib/esp/extensions/active_resource/formats/json_api_format.rb +12 -4
- data/lib/esp/extensions/active_resource/paginated_collection.rb +5 -5
- data/lib/esp/extensions/active_resource/validations.rb +1 -1
- data/lib/esp/external_account_creator.rb +77 -0
- data/lib/esp/resources/alert.rb +30 -34
- data/lib/esp/resources/cloud_trail_event.rb +5 -0
- data/lib/esp/resources/contact_request.rb +6 -5
- data/lib/esp/resources/custom_signature.rb +32 -56
- data/lib/esp/resources/dashboard.rb +8 -1
- data/lib/esp/resources/external_account.rb +27 -19
- data/lib/esp/resources/organization.rb +27 -3
- data/lib/esp/resources/region.rb +15 -3
- data/lib/esp/resources/report.rb +28 -24
- data/lib/esp/resources/resource.rb +26 -10
- data/lib/esp/resources/service.rb +5 -0
- data/lib/esp/resources/signature.rb +28 -12
- data/lib/esp/resources/stat.rb +21 -2
- data/lib/esp/resources/stat_custom_signature.rb +30 -4
- data/lib/esp/resources/stat_region.rb +29 -3
- data/lib/esp/resources/stat_service.rb +29 -3
- data/lib/esp/resources/stat_signature.rb +29 -3
- data/lib/esp/resources/sub_organization.rb +27 -3
- data/lib/esp/resources/suppression/region.rb +14 -32
- data/lib/esp/resources/suppression/signature.rb +14 -40
- data/lib/esp/resources/suppression/unique_identifier.rb +8 -6
- data/lib/esp/resources/suppression.rb +43 -5
- data/lib/esp/resources/tag.rb +5 -0
- data/lib/esp/resources/team.rb +33 -9
- data/lib/esp/resources/user.rb +29 -3
- data/lib/esp/version.rb +1 -1
- data/lib/esp.rb +25 -5
- data/test/esp/aws_clients_test.rb +101 -0
- data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +26 -12
- data/test/esp/extensions/active_resource/paginated_collection_test.rb +93 -72
- data/test/esp/extensions/active_resource/validations_test.rb +2 -12
- data/test/esp/external_account_creator_test.rb +153 -0
- data/test/esp/resources/alert_test.rb +71 -33
- data/test/esp/resources/cloud_trail_event_test.rb +9 -1
- data/test/esp/resources/contact_request_test.rb +8 -0
- data/test/esp/resources/custom_signature_test.rb +8 -0
- data/test/esp/resources/dashboard_test.rb +8 -0
- data/test/esp/resources/external_account_test.rb +8 -0
- data/test/esp/resources/metadata_test.rb +1 -1
- data/test/esp/resources/organization_test.rb +8 -0
- data/test/esp/resources/region_test.rb +12 -4
- data/test/esp/resources/report_test.rb +13 -4
- data/test/esp/resources/resource_test.rb +208 -64
- data/test/esp/resources/service_test.rb +8 -0
- data/test/esp/resources/signature_test.rb +15 -9
- data/test/esp/resources/stat_custom_signature_test.rb +9 -1
- data/test/esp/resources/stat_region_test.rb +23 -1
- data/test/esp/resources/stat_service_test.rb +23 -1
- data/test/esp/resources/stat_signature_test.rb +23 -1
- data/test/esp/resources/stat_test.rb +52 -8
- data/test/esp/resources/sub_organization_test.rb +8 -0
- data/test/esp/resources/suppression/region_test.rb +10 -2
- data/test/esp/resources/suppression/signature_test.rb +10 -2
- data/test/esp/resources/suppression/unique_identifier_test.rb +10 -2
- data/test/esp/resources/suppression_test.rb +74 -14
- data/test/esp/resources/tag_test.rb +9 -1
- data/test/esp/resources/team_test.rb +8 -0
- data/test/esp/resources/user_test.rb +49 -19
- data/test/esp_test.rb +19 -1
- data/test/factories/alerts.rb +70 -0
- data/test/factories/organizations.rb +2 -2
- data/test/factories/regions.rb +1 -1
- data/test/factories/sub_organizations.rb +1 -1
- data/test/factories/suppressions.rb +109 -3
- data/test/factories/users.rb +65 -2
- data/test/test_helper.rb +9 -8
- metadata +41 -69
- data/bin/esp_console +0 -67
- data/rdoc/ActiveResource/Formats.html +0 -178
- data/rdoc/ActiveResource/PaginatedCollection.html +0 -912
- data/rdoc/ActiveResource.html +0 -182
- data/rdoc/ESP/Alert.html +0 -808
- data/rdoc/ESP/CloudTrailEvent.html +0 -377
- data/rdoc/ESP/ContactRequest.html +0 -368
- data/rdoc/ESP/CustomSignature.html +0 -748
- data/rdoc/ESP/Dashboard.html +0 -357
- data/rdoc/ESP/ExternalAccount.html +0 -567
- data/rdoc/ESP/Metadata.html +0 -411
- data/rdoc/ESP/Organization.html +0 -592
- data/rdoc/ESP/Region.html +0 -401
- data/rdoc/ESP/Report.html +0 -624
- data/rdoc/ESP/Service.html +0 -382
- data/rdoc/ESP/Signature.html +0 -557
- data/rdoc/ESP/Stat.html +0 -1780
- data/rdoc/ESP/StatCustomSignature.html +0 -1601
- data/rdoc/ESP/StatRegion.html +0 -1600
- data/rdoc/ESP/StatService.html +0 -1600
- data/rdoc/ESP/StatSignature.html +0 -1600
- data/rdoc/ESP/SubOrganization.html +0 -542
- data/rdoc/ESP/Suppression/Region.html +0 -456
- data/rdoc/ESP/Suppression/Signature.html +0 -472
- data/rdoc/ESP/Suppression/UniqueIdentifier.html +0 -419
- data/rdoc/ESP/Suppression.html +0 -651
- data/rdoc/ESP/Tag.html +0 -373
- data/rdoc/ESP/Team.html +0 -586
- data/rdoc/ESP/User.html +0 -485
- data/rdoc/ESP.html +0 -549
- data/rdoc/README_md.html +0 -503
- data/rdoc/created.rid +0 -31
- data/rdoc/images/add.png +0 -0
- data/rdoc/images/arrow_up.png +0 -0
- data/rdoc/images/brick.png +0 -0
- data/rdoc/images/brick_link.png +0 -0
- data/rdoc/images/bug.png +0 -0
- data/rdoc/images/bullet_black.png +0 -0
- data/rdoc/images/bullet_toggle_minus.png +0 -0
- data/rdoc/images/bullet_toggle_plus.png +0 -0
- data/rdoc/images/date.png +0 -0
- data/rdoc/images/delete.png +0 -0
- data/rdoc/images/find.png +0 -0
- data/rdoc/images/loadingAnimation.gif +0 -0
- data/rdoc/images/macFFBgHack.png +0 -0
- data/rdoc/images/package.png +0 -0
- data/rdoc/images/page_green.png +0 -0
- data/rdoc/images/page_white_text.png +0 -0
- data/rdoc/images/page_white_width.png +0 -0
- data/rdoc/images/plugin.png +0 -0
- data/rdoc/images/ruby.png +0 -0
- data/rdoc/images/tag_blue.png +0 -0
- data/rdoc/images/tag_green.png +0 -0
- data/rdoc/images/transparent.png +0 -0
- data/rdoc/images/wrench.png +0 -0
- data/rdoc/images/wrench_orange.png +0 -0
- data/rdoc/images/zoom.png +0 -0
- data/rdoc/index.html +0 -136
- data/rdoc/js/darkfish.js +0 -155
- data/rdoc/js/jquery.js +0 -4
- data/rdoc/js/navigation.js +0 -142
- data/rdoc/js/search.js +0 -94
- data/rdoc/js/search_index.js +0 -1
- data/rdoc/js/searcher.js +0 -228
- data/rdoc/rdoc.css +0 -595
- data/rdoc/table_of_contents.html +0 -942
data/rdoc/ESP/Alert.html
DELETED
|
@@ -1,808 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
-
|
|
7
|
-
<title>class ESP::Alert - ESPSDK</title>
|
|
8
|
-
|
|
9
|
-
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
|
10
|
-
|
|
11
|
-
<script type="text/javascript">
|
|
12
|
-
var rdoc_rel_prefix = "../";
|
|
13
|
-
</script>
|
|
14
|
-
|
|
15
|
-
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
16
|
-
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
|
17
|
-
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
|
18
|
-
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
|
19
|
-
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
|
20
|
-
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<body id="top" class="class">
|
|
24
|
-
<nav id="metadata">
|
|
25
|
-
<nav id="home-section" class="section">
|
|
26
|
-
<h3 class="section-header">
|
|
27
|
-
<a href="../index.html">Home</a>
|
|
28
|
-
<a href="../table_of_contents.html#classes">Classes</a>
|
|
29
|
-
<a href="../table_of_contents.html#methods">Methods</a>
|
|
30
|
-
</h3>
|
|
31
|
-
</nav>
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
-
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
-
<h3 class="section-header">
|
|
37
|
-
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
-
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
-
</h3>
|
|
40
|
-
</form>
|
|
41
|
-
|
|
42
|
-
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
-
</nav>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
<div id="file-metadata">
|
|
49
|
-
<nav id="file-list-section" class="section">
|
|
50
|
-
<h3 class="section-header">Defined In</h3>
|
|
51
|
-
<ul>
|
|
52
|
-
<li>lib/esp/resources/alert.rb
|
|
53
|
-
</ul>
|
|
54
|
-
</nav>
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
</div>
|
|
58
|
-
|
|
59
|
-
<div id="class-metadata">
|
|
60
|
-
|
|
61
|
-
<nav id="parent-class-section" class="section">
|
|
62
|
-
<h3 class="section-header">Parent</h3>
|
|
63
|
-
|
|
64
|
-
<p class="link">ESP::Resource
|
|
65
|
-
|
|
66
|
-
</nav>
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
<!-- Method Quickref -->
|
|
71
|
-
<nav id="method-list-section" class="section">
|
|
72
|
-
<h3 class="section-header">Methods</h3>
|
|
73
|
-
|
|
74
|
-
<ul class="link-list">
|
|
75
|
-
|
|
76
|
-
<li class="calls-super" ><a href="#method-c-find">::find</a>
|
|
77
|
-
|
|
78
|
-
<li ><a href="#method-c-for_report">::for_report</a>
|
|
79
|
-
|
|
80
|
-
<li ><a href="#method-i-cloud_trail_events">#cloud_trail_events</a>
|
|
81
|
-
|
|
82
|
-
<li ><a href="#method-i-custom_signature">#custom_signature</a>
|
|
83
|
-
|
|
84
|
-
<li ><a href="#method-i-destroy">#destroy</a>
|
|
85
|
-
|
|
86
|
-
<li ><a href="#method-i-external_account">#external_account</a>
|
|
87
|
-
|
|
88
|
-
<li ><a href="#method-i-metadata">#metadata</a>
|
|
89
|
-
|
|
90
|
-
<li ><a href="#method-i-region">#region</a>
|
|
91
|
-
|
|
92
|
-
<li ><a href="#method-i-save">#save</a>
|
|
93
|
-
|
|
94
|
-
<li ><a href="#method-i-signature">#signature</a>
|
|
95
|
-
|
|
96
|
-
<li ><a href="#method-i-suppress_region">#suppress_region</a>
|
|
97
|
-
|
|
98
|
-
<li ><a href="#method-i-suppress_signature">#suppress_signature</a>
|
|
99
|
-
|
|
100
|
-
<li ><a href="#method-i-suppress_unique_identifier">#suppress_unique_identifier</a>
|
|
101
|
-
|
|
102
|
-
<li ><a href="#method-i-suppression">#suppression</a>
|
|
103
|
-
|
|
104
|
-
<li ><a href="#method-i-tags">#tags</a>
|
|
105
|
-
|
|
106
|
-
</ul>
|
|
107
|
-
</nav>
|
|
108
|
-
|
|
109
|
-
</div>
|
|
110
|
-
|
|
111
|
-
<div id="project-metadata">
|
|
112
|
-
<nav id="fileindex-section" class="section project-section">
|
|
113
|
-
<h3 class="section-header">Pages</h3>
|
|
114
|
-
|
|
115
|
-
<ul>
|
|
116
|
-
|
|
117
|
-
<li class="file"><a href="../README_md.html">README</a>
|
|
118
|
-
|
|
119
|
-
</ul>
|
|
120
|
-
</nav>
|
|
121
|
-
|
|
122
|
-
<nav id="classindex-section" class="section project-section">
|
|
123
|
-
<h3 class="section-header">Class and Module Index</h3>
|
|
124
|
-
|
|
125
|
-
<ul class="link-list">
|
|
126
|
-
|
|
127
|
-
<li><a href="../ActiveResource.html">ActiveResource</a>
|
|
128
|
-
|
|
129
|
-
<li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
|
|
130
|
-
|
|
131
|
-
<li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
|
|
132
|
-
|
|
133
|
-
<li><a href="../ESP.html">ESP</a>
|
|
134
|
-
|
|
135
|
-
<li><a href="../ESP/Alert.html">ESP::Alert</a>
|
|
136
|
-
|
|
137
|
-
<li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
|
|
138
|
-
|
|
139
|
-
<li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
|
|
140
|
-
|
|
141
|
-
<li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
|
|
142
|
-
|
|
143
|
-
<li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
|
|
144
|
-
|
|
145
|
-
<li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
|
|
146
|
-
|
|
147
|
-
<li><a href="../ESP/Metadata.html">ESP::Metadata</a>
|
|
148
|
-
|
|
149
|
-
<li><a href="../ESP/Organization.html">ESP::Organization</a>
|
|
150
|
-
|
|
151
|
-
<li><a href="../ESP/Region.html">ESP::Region</a>
|
|
152
|
-
|
|
153
|
-
<li><a href="../ESP/Report.html">ESP::Report</a>
|
|
154
|
-
|
|
155
|
-
<li><a href="../ESP/Service.html">ESP::Service</a>
|
|
156
|
-
|
|
157
|
-
<li><a href="../ESP/Signature.html">ESP::Signature</a>
|
|
158
|
-
|
|
159
|
-
<li><a href="../ESP/Stat.html">ESP::Stat</a>
|
|
160
|
-
|
|
161
|
-
<li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
|
|
162
|
-
|
|
163
|
-
<li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
|
|
164
|
-
|
|
165
|
-
<li><a href="../ESP/StatService.html">ESP::StatService</a>
|
|
166
|
-
|
|
167
|
-
<li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
|
|
168
|
-
|
|
169
|
-
<li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
|
|
170
|
-
|
|
171
|
-
<li><a href="../ESP/Suppression.html">ESP::Suppression</a>
|
|
172
|
-
|
|
173
|
-
<li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
|
|
174
|
-
|
|
175
|
-
<li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
|
|
176
|
-
|
|
177
|
-
<li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
|
|
178
|
-
|
|
179
|
-
<li><a href="../ESP/Tag.html">ESP::Tag</a>
|
|
180
|
-
|
|
181
|
-
<li><a href="../ESP/Team.html">ESP::Team</a>
|
|
182
|
-
|
|
183
|
-
<li><a href="../ESP/User.html">ESP::User</a>
|
|
184
|
-
|
|
185
|
-
</ul>
|
|
186
|
-
</nav>
|
|
187
|
-
|
|
188
|
-
</div>
|
|
189
|
-
</nav>
|
|
190
|
-
|
|
191
|
-
<div id="documentation">
|
|
192
|
-
<h1 class="class">class ESP::Alert</h1>
|
|
193
|
-
|
|
194
|
-
<div id="description" class="description">
|
|
195
|
-
|
|
196
|
-
</div><!-- description -->
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
<!-- Methods -->
|
|
211
|
-
|
|
212
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
213
|
-
<h3 class="section-header">Public Class Methods</h3>
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
<div id="method-c-find" class="method-detail ">
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
<div class="method-heading">
|
|
220
|
-
<span class="method-callseq">
|
|
221
|
-
find(id)
|
|
222
|
-
</span>
|
|
223
|
-
|
|
224
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
225
|
-
|
|
226
|
-
</div>
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
<div class="method-description">
|
|
231
|
-
|
|
232
|
-
<p>Find an <a href="Alert.html">Alert</a> by id</p>
|
|
233
|
-
|
|
234
|
-
<h4 id="method-c-find-label-Parameter">Parameter<span><a href="#method-c-find-label-Parameter">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
235
|
-
|
|
236
|
-
<p><code>id</code> | Required | The ID of the alert to retrieve</p>
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
<div class="method-calls-super">
|
|
240
|
-
Calls superclass method
|
|
241
|
-
|
|
242
|
-
</div>
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
<div class="method-source-code" id="find-source">
|
|
247
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 96</span>
|
|
248
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">find</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
|
|
249
|
-
<span class="ruby-identifier">scope</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>)
|
|
250
|
-
<span class="ruby-identifier">options</span> = (<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>) <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">with_indifferent_access</span>
|
|
251
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">super</span>(<span class="ruby-identifier">scope</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">scope</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Numeric</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:from</span>].<span class="ruby-identifier">present?</span>
|
|
252
|
-
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:params</span>, {}).<span class="ruby-identifier">with_indifferent_access</span>
|
|
253
|
-
<span class="ruby-identifier">report_id</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:report_id</span>)
|
|
254
|
-
<span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">report_id</span>, <span class="ruby-identifier">params</span>)
|
|
255
|
-
<span class="ruby-keyword">end</span></pre>
|
|
256
|
-
</div><!-- find-source -->
|
|
257
|
-
|
|
258
|
-
</div>
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
</div><!-- find-method -->
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
<div id="method-c-for_report" class="method-detail ">
|
|
267
|
-
|
|
268
|
-
<div class="method-heading">
|
|
269
|
-
<span class="method-name">for_report</span><span
|
|
270
|
-
class="method-args">(report_id = nil, arguments = {})</span>
|
|
271
|
-
|
|
272
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
273
|
-
|
|
274
|
-
</div>
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
<div class="method-description">
|
|
278
|
-
|
|
279
|
-
<p>Returns a paginated collection of alerts for the given report_id
|
|
280
|
-
Convenience method to use instead of <a
|
|
281
|
-
href="Alert.html#method-c-find">::find</a> since a report_id is required to
|
|
282
|
-
return alerts.</p>
|
|
283
|
-
|
|
284
|
-
<h4 id="method-c-for_report-label-Parameters">Parameters<span><a href="#method-c-for_report-label-Parameters">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
285
|
-
|
|
286
|
-
<p><code>report_id</code> | Required | The ID of the report to retrieve alerts
|
|
287
|
-
for</p>
|
|
288
|
-
|
|
289
|
-
<p><code>arguments</code> | Not Required | An optional hash of search criteria
|
|
290
|
-
to filter the returned collection</p>
|
|
291
|
-
|
|
292
|
-
<h5 id="method-c-for_report-label-Valid+Arguments">Valid Arguments<span><a href="#method-c-for_report-label-Valid+Arguments">¶</a> <a href="#documentation">↑</a></span></h5>
|
|
293
|
-
|
|
294
|
-
<p><code>region_id</code> | Not Required | Return only alerts for this region.</p>
|
|
295
|
-
|
|
296
|
-
<p><code>status</code> | Not Required | Return only alerts for the give
|
|
297
|
-
status(es). Valid values are fail, warn, error, pass, info</p>
|
|
298
|
-
|
|
299
|
-
<p><code>first_seen</code> | Not Required | Return only alerts that have
|
|
300
|
-
started within a number of hours of the report. For example, first_seen of
|
|
301
|
-
3 will return alerts that started showing up within the last 3 hours of the
|
|
302
|
-
report.</p>
|
|
303
|
-
|
|
304
|
-
<p><code>suppressed</code> | Not Required | Return only suppressed alerts</p>
|
|
305
|
-
|
|
306
|
-
<p><code>team_id</code> | Not Required | Return only alerts for the given
|
|
307
|
-
team.</p>
|
|
308
|
-
|
|
309
|
-
<p><code>external_account_id</code> | Not Required | Return only alerts for
|
|
310
|
-
the given external id.</p>
|
|
311
|
-
|
|
312
|
-
<p><code>service_id</code> | Not Required | Return only alerts on signatures
|
|
313
|
-
with the given service.</p>
|
|
314
|
-
|
|
315
|
-
<p><code>signature_severity</code> | Not Required | Return only alerts for
|
|
316
|
-
signatures with the given risk_level. Valid values are Low, Medium, High</p>
|
|
317
|
-
|
|
318
|
-
<p><code>signature_name</code> | Not Required | Return only alerts for
|
|
319
|
-
signatures with the given name.</p>
|
|
320
|
-
|
|
321
|
-
<p><code>resource</code> | Not Required | Return only alerts for the given
|
|
322
|
-
resource or tag.</p>
|
|
323
|
-
|
|
324
|
-
<p><code>signature_identifier</code> | Not Required | Return only alerts for
|
|
325
|
-
signatures with the given identifier.</p>
|
|
326
|
-
|
|
327
|
-
<h4 id="method-c-for_report-label-Example">Example<span><a href="#method-c-for_report-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
328
|
-
|
|
329
|
-
<pre>alerts = ESP::Alert.for_report(54, status: 'fail', signature_severity: 'High')</pre>
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
<div class="method-source-code" id="for_report-source">
|
|
335
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 82</span>
|
|
336
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">report_id</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">arguments</span> = {})
|
|
337
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must supply a report id."</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">report_id</span>.<span class="ruby-identifier">present?</span>
|
|
338
|
-
<span class="ruby-identifier">from</span> = <span class="ruby-node">"#{prefix}reports/#{report_id}/alerts.json"</span>
|
|
339
|
-
<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> <span class="ruby-identifier">arguments</span>)
|
|
340
|
-
<span class="ruby-keyword">end</span></pre>
|
|
341
|
-
</div><!-- for_report-source -->
|
|
342
|
-
|
|
343
|
-
</div>
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
</div><!-- for_report-method -->
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
</section><!-- public-class-method-details -->
|
|
352
|
-
|
|
353
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
354
|
-
<h3 class="section-header">Public Instance Methods</h3>
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
<div id="method-i-cloud_trail_events" class="method-detail ">
|
|
358
|
-
|
|
359
|
-
<div class="method-heading">
|
|
360
|
-
<span class="method-name">cloud_trail_events</span><span
|
|
361
|
-
class="method-args">()</span>
|
|
362
|
-
|
|
363
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
364
|
-
|
|
365
|
-
</div>
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
<div class="method-description">
|
|
369
|
-
|
|
370
|
-
<p>Returns the cloud trail events associated with this alert. These may be
|
|
371
|
-
added up to 10 minutes after the alert was created</p>
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
<div class="method-source-code" id="cloud_trail_events-source">
|
|
377
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 25</span>
|
|
378
|
-
<span class="ruby-identifier">has_many</span> <span class="ruby-value">:cloud_trail_events</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::CloudTrailEvent'</span>
|
|
379
|
-
</pre>
|
|
380
|
-
</div><!-- cloud_trail_events-source -->
|
|
381
|
-
|
|
382
|
-
</div>
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
</div><!-- cloud_trail_events-method -->
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
<div id="method-i-custom_signature" class="method-detail ">
|
|
391
|
-
|
|
392
|
-
<div class="method-heading">
|
|
393
|
-
<span class="method-name">custom_signature</span><span
|
|
394
|
-
class="method-args">()</span>
|
|
395
|
-
|
|
396
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
397
|
-
|
|
398
|
-
</div>
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
<div class="method-description">
|
|
402
|
-
|
|
403
|
-
<p>Returns the custom signature associated with this alert. Either a
|
|
404
|
-
signature or custom signature but not both will be present.</p>
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
<div class="method-source-code" id="custom_signature-source">
|
|
410
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 17</span>
|
|
411
|
-
<span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:custom_signature</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::CustomSignature'</span>
|
|
412
|
-
</pre>
|
|
413
|
-
</div><!-- custom_signature-source -->
|
|
414
|
-
|
|
415
|
-
</div>
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
</div><!-- custom_signature-method -->
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
<div id="method-i-destroy" class="method-detail ">
|
|
424
|
-
|
|
425
|
-
<div class="method-heading">
|
|
426
|
-
<span class="method-name">destroy</span><span
|
|
427
|
-
class="method-args">()</span>
|
|
428
|
-
|
|
429
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
430
|
-
|
|
431
|
-
</div>
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
<div class="method-description">
|
|
435
|
-
|
|
436
|
-
<p>Not Implemented. You cannot destroy a an <a href="Alert.html">Alert</a>.</p>
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
<div class="method-source-code" id="destroy-source">
|
|
442
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 43</span>
|
|
443
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
|
|
444
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
|
|
445
|
-
<span class="ruby-keyword">end</span></pre>
|
|
446
|
-
</div><!-- destroy-source -->
|
|
447
|
-
|
|
448
|
-
</div>
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
</div><!-- destroy-method -->
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
<div id="method-i-external_account" class="method-detail ">
|
|
457
|
-
|
|
458
|
-
<div class="method-heading">
|
|
459
|
-
<span class="method-name">external_account</span><span
|
|
460
|
-
class="method-args">()</span>
|
|
461
|
-
|
|
462
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
463
|
-
|
|
464
|
-
</div>
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
<div class="method-description">
|
|
468
|
-
|
|
469
|
-
<p>Returns the external account associated with this alert.</p>
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
<div class="method-source-code" id="external_account-source">
|
|
475
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 5</span>
|
|
476
|
-
<span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:external_account</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::ExternalAccount'</span>
|
|
477
|
-
</pre>
|
|
478
|
-
</div><!-- external_account-source -->
|
|
479
|
-
|
|
480
|
-
</div>
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
</div><!-- external_account-method -->
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
<div id="method-i-metadata" class="method-detail ">
|
|
489
|
-
|
|
490
|
-
<div class="method-heading">
|
|
491
|
-
<span class="method-name">metadata</span><span
|
|
492
|
-
class="method-args">()</span>
|
|
493
|
-
|
|
494
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
495
|
-
|
|
496
|
-
</div>
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
<div class="method-description">
|
|
500
|
-
|
|
501
|
-
<p>Returns the metadata associated with this alert.</p>
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
<div class="method-source-code" id="metadata-source">
|
|
507
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 33</span>
|
|
508
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">metadata</span>
|
|
509
|
-
<span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">Metadata</span>.<span class="ruby-identifier">for_alert</span>(<span class="ruby-identifier">id</span>)
|
|
510
|
-
<span class="ruby-keyword">end</span></pre>
|
|
511
|
-
</div><!-- metadata-source -->
|
|
512
|
-
|
|
513
|
-
</div>
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
</div><!-- metadata-method -->
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
<div id="method-i-region" class="method-detail ">
|
|
522
|
-
|
|
523
|
-
<div class="method-heading">
|
|
524
|
-
<span class="method-name">region</span><span
|
|
525
|
-
class="method-args">()</span>
|
|
526
|
-
|
|
527
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
528
|
-
|
|
529
|
-
</div>
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
<div class="method-description">
|
|
533
|
-
|
|
534
|
-
<p>Returns the region associated with this alert.</p>
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
<div class="method-source-code" id="region-source">
|
|
540
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 9</span>
|
|
541
|
-
<span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:region</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::Region'</span>
|
|
542
|
-
</pre>
|
|
543
|
-
</div><!-- region-source -->
|
|
544
|
-
|
|
545
|
-
</div>
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
</div><!-- region-method -->
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
<div id="method-i-save" class="method-detail ">
|
|
554
|
-
|
|
555
|
-
<div class="method-heading">
|
|
556
|
-
<span class="method-name">save</span><span
|
|
557
|
-
class="method-args">()</span>
|
|
558
|
-
|
|
559
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
560
|
-
|
|
561
|
-
</div>
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
<div class="method-description">
|
|
565
|
-
|
|
566
|
-
<p>Not Implemented. You cannot create or update an <a
|
|
567
|
-
href="Alert.html">Alert</a>.</p>
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
<div class="method-source-code" id="save-source">
|
|
573
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 38</span>
|
|
574
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>
|
|
575
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
|
|
576
|
-
<span class="ruby-keyword">end</span></pre>
|
|
577
|
-
</div><!-- save-source -->
|
|
578
|
-
|
|
579
|
-
</div>
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
</div><!-- save-method -->
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
<div id="method-i-signature" class="method-detail ">
|
|
588
|
-
|
|
589
|
-
<div class="method-heading">
|
|
590
|
-
<span class="method-name">signature</span><span
|
|
591
|
-
class="method-args">()</span>
|
|
592
|
-
|
|
593
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
594
|
-
|
|
595
|
-
</div>
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
<div class="method-description">
|
|
599
|
-
|
|
600
|
-
<p>Returns the region associated with this alert. Either a signature or
|
|
601
|
-
custom signature but not both will be present.</p>
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
<div class="method-source-code" id="signature-source">
|
|
607
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 13</span>
|
|
608
|
-
<span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:signature</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::Signature'</span>
|
|
609
|
-
</pre>
|
|
610
|
-
</div><!-- signature-source -->
|
|
611
|
-
|
|
612
|
-
</div>
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
</div><!-- signature-method -->
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
<div id="method-i-suppress_region" class="method-detail ">
|
|
621
|
-
|
|
622
|
-
<div class="method-heading">
|
|
623
|
-
<span class="method-name">suppress_region</span><span
|
|
624
|
-
class="method-args">(reason = nil)</span>
|
|
625
|
-
|
|
626
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
627
|
-
|
|
628
|
-
</div>
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
<div class="method-description">
|
|
632
|
-
|
|
633
|
-
<p>Suppress the region associated with this alert.</p>
|
|
634
|
-
|
|
635
|
-
<h4 id="method-i-suppress_region-label-Parameter">Parameter<span><a href="#method-i-suppress_region-label-Parameter">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
636
|
-
|
|
637
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
<div class="method-source-code" id="suppress_region-source">
|
|
643
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 117</span>
|
|
644
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_region</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
|
645
|
-
<span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">Region</span>, <span class="ruby-identifier">reason</span>)
|
|
646
|
-
<span class="ruby-keyword">end</span></pre>
|
|
647
|
-
</div><!-- suppress_region-source -->
|
|
648
|
-
|
|
649
|
-
</div>
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
</div><!-- suppress_region-method -->
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
<div id="method-i-suppress_signature" class="method-detail ">
|
|
658
|
-
|
|
659
|
-
<div class="method-heading">
|
|
660
|
-
<span class="method-name">suppress_signature</span><span
|
|
661
|
-
class="method-args">(reason = nil)</span>
|
|
662
|
-
|
|
663
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
664
|
-
|
|
665
|
-
</div>
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
<div class="method-description">
|
|
669
|
-
|
|
670
|
-
<p>Suppress the signature associated with this alert.</p>
|
|
671
|
-
|
|
672
|
-
<h4 id="method-i-suppress_signature-label-Parameter">Parameter<span><a href="#method-i-suppress_signature-label-Parameter">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
673
|
-
|
|
674
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
<div class="method-source-code" id="suppress_signature-source">
|
|
680
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 109</span>
|
|
681
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_signature</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
|
682
|
-
<span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">Signature</span>, <span class="ruby-identifier">reason</span>)
|
|
683
|
-
<span class="ruby-keyword">end</span></pre>
|
|
684
|
-
</div><!-- suppress_signature-source -->
|
|
685
|
-
|
|
686
|
-
</div>
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
</div><!-- suppress_signature-method -->
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
<div id="method-i-suppress_unique_identifier" class="method-detail ">
|
|
695
|
-
|
|
696
|
-
<div class="method-heading">
|
|
697
|
-
<span class="method-name">suppress_unique_identifier</span><span
|
|
698
|
-
class="method-args">(reason = nil)</span>
|
|
699
|
-
|
|
700
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
701
|
-
|
|
702
|
-
</div>
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
<div class="method-description">
|
|
706
|
-
|
|
707
|
-
<p>Suppress the unique identifier associated with this alert.</p>
|
|
708
|
-
|
|
709
|
-
<h4 id="method-i-suppress_unique_identifier-label-Parameter">Parameter<span><a href="#method-i-suppress_unique_identifier-label-Parameter">¶</a> <a href="#documentation">↑</a></span></h4>
|
|
710
|
-
|
|
711
|
-
<p><code>reason</code> | Required | The reason for creating the suppression.</p>
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
<div class="method-source-code" id="suppress_unique_identifier-source">
|
|
717
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 125</span>
|
|
718
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_unique_identifier</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
|
719
|
-
<span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">UniqueIdentifier</span>, <span class="ruby-identifier">reason</span>)
|
|
720
|
-
<span class="ruby-keyword">end</span></pre>
|
|
721
|
-
</div><!-- suppress_unique_identifier-source -->
|
|
722
|
-
|
|
723
|
-
</div>
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
</div><!-- suppress_unique_identifier-method -->
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
<div id="method-i-suppression" class="method-detail ">
|
|
732
|
-
|
|
733
|
-
<div class="method-heading">
|
|
734
|
-
<span class="method-name">suppression</span><span
|
|
735
|
-
class="method-args">()</span>
|
|
736
|
-
|
|
737
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
738
|
-
|
|
739
|
-
</div>
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
<div class="method-description">
|
|
743
|
-
|
|
744
|
-
<p>Returns the suppression associated with this alert. If present the alert
|
|
745
|
-
was suppressed.</p>
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
<div class="method-source-code" id="suppression-source">
|
|
751
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 21</span>
|
|
752
|
-
<span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:suppression</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::Suppression'</span>
|
|
753
|
-
</pre>
|
|
754
|
-
</div><!-- suppression-source -->
|
|
755
|
-
|
|
756
|
-
</div>
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
</div><!-- suppression-method -->
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
<div id="method-i-tags" class="method-detail ">
|
|
765
|
-
|
|
766
|
-
<div class="method-heading">
|
|
767
|
-
<span class="method-name">tags</span><span
|
|
768
|
-
class="method-args">()</span>
|
|
769
|
-
|
|
770
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
771
|
-
|
|
772
|
-
</div>
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
<div class="method-description">
|
|
776
|
-
|
|
777
|
-
<p>Returns the tags associated with this alert.</p>
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
<div class="method-source-code" id="tags-source">
|
|
783
|
-
<pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 29</span>
|
|
784
|
-
<span class="ruby-identifier">has_many</span> <span class="ruby-value">:tags</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">'ESP::Tag'</span>
|
|
785
|
-
</pre>
|
|
786
|
-
</div><!-- tags-source -->
|
|
787
|
-
|
|
788
|
-
</div>
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
</div><!-- tags-method -->
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
</section><!-- public-instance-method-details -->
|
|
797
|
-
|
|
798
|
-
</section><!-- 5Buntitled-5D -->
|
|
799
|
-
|
|
800
|
-
</div><!-- documentation -->
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
<footer id="validator-badges">
|
|
804
|
-
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
805
|
-
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
|
|
806
|
-
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
807
|
-
</footer>
|
|
808
|
-
|