Package org.sonarqube.ws.client.measures

Class ComponentTreeRequest

java.lang.Object

org.sonarqube.ws.client.measures.ComponentTreeRequest

@Generated("sonar-ws-generator")
public class ComponentTreeRequest
extends Object

This is part of the internal API. This is a POST request.

Since:

5.4

See Also:

• Further information about this action online (including a response example)

Constructor Summary

Constructors

Constructor	Description
ComponentTreeRequest()

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalFields()
String	getAsc()
String	getBaseComponentId()
String	getBranch()
String	getComponent()
String	getDeveloperId()
String	getDeveloperKey()
List<String>	getMetricKeys()
String	getMetricPeriodSort()
String	getMetricSort()
String	getMetricSortFilter()
String	getP()
String	getPs()
String	getPullRequest()
String	getQ()
List<String>	getQualifiers()
List<String>	getS()
String	getStrategy()
ComponentTreeRequest	setAdditionalFields(List<String> additionalFields)	Example value: "periods,metrics" Possible values: "metrics" "periods"
ComponentTreeRequest	setAsc(String asc)	Possible values: "true" "false" "yes" "no"
ComponentTreeRequest	setBaseComponentId(String baseComponentId)	Deprecated. since 6.6
ComponentTreeRequest	setBranch(String branch)	This is part of the internal API.
ComponentTreeRequest	setComponent(String component)	Example value: "my_project"
ComponentTreeRequest	setDeveloperId(String developerId)	Deprecated. since 6.4
ComponentTreeRequest	setDeveloperKey(String developerKey)	Deprecated. since 6.4
ComponentTreeRequest	setMetricKeys(List<String> metricKeys)	This is a mandatory parameter.
ComponentTreeRequest	setMetricPeriodSort(String metricPeriodSort)	Possible values: "1"
ComponentTreeRequest	setMetricSort(String metricSort)	Example value: "ncloc"
ComponentTreeRequest	setMetricSortFilter(String metricSortFilter)	Possible values: "all" "withMeasuresOnly"
ComponentTreeRequest	setP(String p)	Example value: "42"
ComponentTreeRequest	setPs(String ps)	Example value: "20"
ComponentTreeRequest	setPullRequest(String pullRequest)	This is part of the internal API.
ComponentTreeRequest	setQ(String q)	Example value: "FILE_NAM"
ComponentTreeRequest	setQualifiers(List<String> qualifiers)	Possible values: "BRC" "DIR" "FIL" "TRK" "UTS"
ComponentTreeRequest	setS(List<String> s)	Example value: "name,path" Possible values: "metric" "metricPeriod" "name" "path" "qualifier"
ComponentTreeRequest	setStrategy(String strategy)	Possible values: "all" "children" "leaves"

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentTreeRequest

public ComponentTreeRequest()

Method Details

setAdditionalFields

public ComponentTreeRequest setAdditionalFields(List<String> additionalFields)

Example value: "periods,metrics" Possible values:

• "metrics"
• "periods"

getAdditionalFields

public List<String> getAdditionalFields()

setAsc

public ComponentTreeRequest setAsc(String asc)

Possible values:

• "true"
• "false"
• "yes"
• "no"

getAsc

public String getAsc()

setBaseComponentId

@Deprecated
public ComponentTreeRequest setBaseComponentId(String baseComponentId)

Deprecated.

since 6.6

Example value: "AU-TpxcA-iU5OvuD2FLz"

getBaseComponentId

public String getBaseComponentId()

setBranch

public ComponentTreeRequest setBranch(String branch)

This is part of the internal API. Example value: "feature/my_branch"

getBranch

public String getBranch()

setComponent

public ComponentTreeRequest setComponent(String component)

Example value: "my_project"

getComponent

public String getComponent()

setDeveloperId

@Deprecated
public ComponentTreeRequest setDeveloperId(String developerId)

Deprecated.

since 6.4

getDeveloperId

public String getDeveloperId()

setDeveloperKey

@Deprecated
public ComponentTreeRequest setDeveloperKey(String developerKey)

Deprecated.

since 6.4

getDeveloperKey

public String getDeveloperKey()

setMetricKeys

public ComponentTreeRequest setMetricKeys(List<String> metricKeys)

This is a mandatory parameter. Example value: "ncloc,complexity,violations"

getMetricKeys

public List<String> getMetricKeys()

setMetricPeriodSort

public ComponentTreeRequest setMetricPeriodSort(String metricPeriodSort)

Possible values:

• "1"

getMetricPeriodSort

public String getMetricPeriodSort()

setMetricSort

public ComponentTreeRequest setMetricSort(String metricSort)

Example value: "ncloc"

getMetricSort

public String getMetricSort()

setMetricSortFilter

public ComponentTreeRequest setMetricSortFilter(String metricSortFilter)

Possible values:

• "all"
• "withMeasuresOnly"

getMetricSortFilter

public String getMetricSortFilter()

setP

public ComponentTreeRequest setP(String p)

Example value: "42"

getP

public String getP()

setPs

public ComponentTreeRequest setPs(String ps)

Example value: "20"

getPs

public String getPs()

setPullRequest

public ComponentTreeRequest setPullRequest(String pullRequest)

This is part of the internal API. Example value: "5461"

getPullRequest

public String getPullRequest()

setQ

public ComponentTreeRequest setQ(String q)

Example value: "FILE_NAM"

getQ

public String getQ()

setQualifiers

public ComponentTreeRequest setQualifiers(List<String> qualifiers)

Possible values:

• "BRC"
• "DIR"
• "FIL"
• "TRK"
• "UTS"

getQualifiers

public List<String> getQualifiers()

setS

public ComponentTreeRequest setS(List<String> s)

Example value: "name,path" Possible values:

• "metric"
• "metricPeriod"
• "name"
• "path"
• "qualifier"

getS

public List<String> getS()

setStrategy

public ComponentTreeRequest setStrategy(String strategy)

Possible values:

• "all"
• "children"
• "leaves"

getStrategy

public String getStrategy()