Package org.sonarqube.ws.client.measures

Class ComponentRequest

java.lang.Object

org.sonarqube.ws.client.measures.ComponentRequest

@Generated("sonar-ws-generator")
public class ComponentRequest
extends java.lang.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
ComponentRequest()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAdditionalFields()
java.lang.String	getBranch()
java.lang.String	getComponent()
java.lang.String	getComponentId()
java.lang.String	getDeveloperId()
java.lang.String	getDeveloperKey()
java.util.List<java.lang.String>	getMetricKeys()
java.lang.String	getPullRequest()
ComponentRequest	setAdditionalFields(java.util.List<java.lang.String> additionalFields)	Example value: "periods,metrics" Possible values: "metrics" "periods"
ComponentRequest	setBranch(java.lang.String branch)	This is part of the internal API.
ComponentRequest	setComponent(java.lang.String component)	Example value: "my_project"
ComponentRequest	setComponentId(java.lang.String componentId)	Deprecated. since 6.6
ComponentRequest	setDeveloperId(java.lang.String developerId)	Deprecated. since 6.4
ComponentRequest	setDeveloperKey(java.lang.String developerKey)	Deprecated. since 6.4
ComponentRequest	setMetricKeys(java.util.List<java.lang.String> metricKeys)	This is a mandatory parameter.
ComponentRequest	setPullRequest(java.lang.String pullRequest)	This is part of the internal API.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentRequest

public ComponentRequest()

Method Detail

setAdditionalFields

public ComponentRequest setAdditionalFields(java.util.List<java.lang.String> additionalFields)

Example value: "periods,metrics" Possible values:

• "metrics"
• "periods"

getAdditionalFields

public java.util.List<java.lang.String> getAdditionalFields()

setBranch

public ComponentRequest setBranch(java.lang.String branch)

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

getBranch

public java.lang.String getBranch()

setComponent

public ComponentRequest setComponent(java.lang.String component)

Example value: "my_project"

getComponent

public java.lang.String getComponent()

setComponentId

@Deprecated
public ComponentRequest setComponentId(java.lang.String componentId)

Deprecated.

since 6.6

Example value: "AU-Tpxb--iU5OvuD2FLy"

getComponentId

public java.lang.String getComponentId()

setDeveloperId

@Deprecated
public ComponentRequest setDeveloperId(java.lang.String developerId)

Deprecated.

since 6.4

getDeveloperId

public java.lang.String getDeveloperId()

setDeveloperKey

@Deprecated
public ComponentRequest setDeveloperKey(java.lang.String developerKey)

Deprecated.

since 6.4

getDeveloperKey

public java.lang.String getDeveloperKey()

setMetricKeys

public ComponentRequest setMetricKeys(java.util.List<java.lang.String> metricKeys)

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

getMetricKeys

public java.util.List<java.lang.String> getMetricKeys()

setPullRequest

public ComponentRequest setPullRequest(java.lang.String pullRequest)

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

getPullRequest

public java.lang.String getPullRequest()