org.sonar.wsclient.services

Class TimeMachineQuery

java.lang.Object

org.sonar.wsclient.services.AbstractQuery<M>

org.sonar.wsclient.services.Query<TimeMachine>

org.sonar.wsclient.services.TimeMachineQuery

public class TimeMachineQuery
extends Query<TimeMachine>

Since:

2.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL

Fields inherited from class org.sonar.wsclient.services.AbstractQuery

DEFAULT_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
TimeMachineQuery(String resourceKeyOrId)

Method Summary

Methods

Modifier and Type	Method and Description
static TimeMachineQuery	createForMetrics(Resource resource, String... metricKeys)
static TimeMachineQuery	createForMetrics(String resourceKeyOrId, String... metricKeys)
Date	getFrom()
String[]	getMetrics()
Class<TimeMachine>	getModelClass()
Date	getTo()
String	getUrl() Must start with a slash, for example: /api/metrics
TimeMachineQuery	setCharacteristicKeys(String model, String... keys)
TimeMachineQuery	setFrom(Date from)
TimeMachineQuery	setMetrics(String... metrics)
TimeMachineQuery	setTo(Date to)

Methods inherited from class org.sonar.wsclient.services.AbstractQuery

appendUrlParameter, appendUrlParameter, appendUrlParameter, appendUrlParameter, encode, getBody, getLocale, getTimeoutMilliseconds, setLocale, setTimeoutMilliseconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

Constructor Detail

TimeMachineQuery

public TimeMachineQuery(String resourceKeyOrId)

Method Detail

getMetrics

public String[] getMetrics()

setMetrics

public TimeMachineQuery setMetrics(String... metrics)

getFrom

public Date getFrom()

setFrom

public TimeMachineQuery setFrom(Date from)

getTo

public Date getTo()

setTo

public TimeMachineQuery setTo(Date to)

setCharacteristicKeys

public TimeMachineQuery setCharacteristicKeys(String model,
                                     String... keys)

getUrl

public String getUrl()

Description copied from class: AbstractQuery

Must start with a slash, for example: /api/metrics

IMPORTANT: In implementations of this method we must use helper methods to construct URL.

Specified by:

getUrl in class AbstractQuery<TimeMachine>

See Also:

AbstractQuery.encode(String), AbstractQuery.appendUrlParameter(StringBuilder, String, Object), AbstractQuery.appendUrlParameter(StringBuilder, String, Object[]), AbstractQuery.appendUrlParameter(StringBuilder, String, Date, boolean)

getModelClass

public Class<TimeMachine> getModelClass()

Specified by:

getModelClass in class Query<TimeMachine>

createForMetrics

public static TimeMachineQuery createForMetrics(String resourceKeyOrId,
                                String... metricKeys)

createForMetrics

public static TimeMachineQuery createForMetrics(Resource resource,
                                String... metricKeys)