com.huawei.openstack4j.model.telemetry.Event Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	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.huawei.openstack4j.model.telemetry;

import java.util.List;

import com.huawei.openstack4j.model.ModelEntity;

/**
 * Event represents the state of an object in an OpenStack service
 * at a point in time when something of interest has occurred
 * 
 * @author Miroslav Lacina
 */
public interface Event extends ModelEntity {

    /**
     * @return a dotted string defining what event occurred
     */
    String getEventType();

    /**
     * @return a timestamp of when the event occurred on the source system
     */
    String getGenerated();

    /**
     * @return a UUID for this event
     */
    String getMessageId();

    /**
     * @return event’s Traits which contain most of the details of the event
     */
    List getTraits();

}