Package cm_api :: Package endpoints :: Module events
[hide private]
[frames] | no frames]

Source Code for Module cm_api.endpoints.events

 1  # Licensed to Cloudera, Inc. under one 
 2  # or more contributor license agreements.  See the NOTICE file 
 3  # distributed with this work for additional information 
 4  # regarding copyright ownership.  Cloudera, Inc. licenses this file 
 5  # to you under the Apache License, Version 2.0 (the 
 6  # "License"); you may not use this file except in compliance 
 7  # with the License.  You may obtain a copy of the License at 
 8  # 
 9  #     http://www.apache.org/licenses/LICENSE-2.0 
10  # 
11  # Unless required by applicable law or agreed to in writing, software 
12  # distributed under the License is distributed on an "AS IS" BASIS, 
13  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
14  # See the License for the specific language governing permissions and 
15  # limitations under the License. 
16   
17  from cm_api.endpoints.types import * 
18   
19  __docformat__ = "epytext" 
20   
21  EVENTS_PATH = "/events" 
22   
23 -def query_events(resource_root, query_str=None):
24 """ 25 Search for events. 26 @param query_str: Query string. 27 @return: A list of ApiEvent. 28 """ 29 params = None 30 if query_str: 31 params = dict(query=query_str) 32 return call(resource_root.get, EVENTS_PATH, ApiEventQueryResult, 33 params=params)
34
35 -def get_event(resource_root, event_id):
36 """ 37 Retrieve a particular event by ID. 38 @param event_id: The event ID. 39 @return: An ApiEvent. 40 """ 41 return call(resource_root.get, "%s/%s" % (EVENTS_PATH, event_id), ApiEvent)
42 43
44 -class ApiEvent(BaseApiObject):
45 _ATTRIBUTES = { 46 'id' : ROAttr(), 47 'content' : ROAttr(), 48 'timeOccurred' : ROAttr(datetime.datetime), 49 'timeReceived' : ROAttr(datetime.datetime), 50 'category' : ROAttr(), 51 'severity' : ROAttr(), 52 'alert' : ROAttr(), 53 'attributes' : ROAttr(), 54 }
55
56 -class ApiEventQueryResult(ApiList):
57 _ATTRIBUTES = { 58 'totalResults' : ROAttr(), 59 } 60 _MEMBER_CLASS = ApiEvent
61