com.jakewharton.pingdom.entities.RawResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pingdom-java Show documentation

A Java wrapper around the Pingdom RESTful API and a simple DSL for easy interaction.

The newest version!

package com.jakewharton.pingdom.entities;

import java.util.Date;
import java.util.List;
import com.google.gson.annotations.Since;
import com.jakewharton.pingdom.PingdomEntity;
import com.jakewharton.pingdom.enumerations.CheckStatus;

/**
 * Represents a Pingdom raw results object.
 */
public final class RawResults implements PingdomEntity {
	private static final long serialVersionUID = 1337764235518032289L;

	/**
	 * Represents a Pingdom results object.
	 */
	public static final class Results implements PingdomEntity {
		private static final long serialVersionUID = -1523654956707062927L;
		
		@Since(2.0) private Integer probeId;
		@Since(2.0) private Date time;
		@Since(2.0) private CheckStatus status;
		@Since(2.0) private Integer responseTime;
		@Since(2.0) private String statusDesc;
		@Since(2.0) private String statusDescLong;
		@Since(2.0) private Integer analysisId;
		
		/**
		 * Probe identifier.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public Integer getProbeId() {
			return this.probeId;
		}
		
		/**
		 * Time when test was performed.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public Date getTime() {
			return this.time;
		}
		
		/**
		 * Result status.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public CheckStatus getStatus() {
			return this.status;
		}
		
		/**
		 * Response time (in milliseconds) (Will be 0 if no response was received).
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public Integer getResponseTime() {
			return this.responseTime;
		}
		
		/**
		 * Short status description.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public String getStatusDesc() {
			return this.statusDesc;
		}
		
		/**
		 * Long status description.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public String getStatusDescLong() {
			return this.statusDescLong;
		}
		
		/**
		 * Analysis identifier.
		 * 
		 * @return Value.
		 * @since 2.0
		 */
		public Integer getAnalysisId() {
			return this.analysisId;
		}
	}
	
	@Since(2.0) private List results;
	@Since(2.0) private List somethingIds;
	
	/**
	 * List of raw result data.
	 * 
	 * @return List of values.
	 * @since 2.0
	 */
	public List getResults() {
		return this.results;
	}
	
	/**
	 * For your convinience, a list of used probes that produced the showed
	 * results.
	 * 
	 * @return Value.
	 * @since 2.0
	 */
	public List getSomethingIds() {
		return this.somethingIds;
	}
}