com.codedx.client.model

Class DisplayTagState

java.lang.Object

com.codedx.client.model.DisplayTagState

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-12-07T19:30:21.793Z")
public class DisplayTagState
extends java.lang.Object

DisplayTagState

Constructor Summary

Constructors

Constructor and Description
DisplayTagState()

Method Summary

Modifier and Type	Method and Description
DisplayTagState	binary(java.lang.String binary)
DisplayTagState	buildMeta(java.lang.String buildMeta)
DisplayTagState	enabled(java.lang.Boolean enabled)
DisplayTagState	enabledReason(java.lang.String enabledReason)
boolean	equals(java.lang.Object o)
java.lang.String	getBinary() if the file appears to be a zip file that includes compiled \"binary\" files, the value of this field will be the name of the platform on which they run (e.g.
java.lang.String	getBuildMeta() if the file appears to be a zip file that includes some kind of build metadata (e.g.
java.lang.String	getEnabledReason() a string, either \"user\", or \"rule-config\".
java.lang.String	getId() a semi-random identifier which can be assumed to be unique within the context of an Analysis Prep.
java.lang.String	getSource() if the file appears to be a zip file that includes source files, the value of this field will be the name of the language of that source (e.g.
java.lang.String	getToolInput() if the file appears to be usable as an input to a tool that Code Dx can automatically run, the value of this field will be that tool.
java.lang.String	getToolOutput() if the file appears to be an output of a tool (i.e.
int	hashCode()
DisplayTagState	id(java.lang.String id)
java.lang.Boolean	isEnabled() a boolean, indicating whether the tag is enabled.
void	setBinary(java.lang.String binary)
void	setBuildMeta(java.lang.String buildMeta)
void	setEnabled(java.lang.Boolean enabled)
void	setEnabledReason(java.lang.String enabledReason)
void	setId(java.lang.String id)
void	setSource(java.lang.String source)
void	setToolInput(java.lang.String toolInput)
void	setToolOutput(java.lang.String toolOutput)
DisplayTagState	source(java.lang.String source)
DisplayTagState	toolInput(java.lang.String toolInput)
DisplayTagState	toolOutput(java.lang.String toolOutput)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DisplayTagState

public DisplayTagState()

Method Detail

source

public DisplayTagState source(java.lang.String source)

getSource

public java.lang.String getSource()

if the file appears to be a zip file that includes source files, the value of this field will be the name of the language of that source (e.g. \"C#\")

Returns:

source

setSource

public void setSource(java.lang.String source)

binary

public DisplayTagState binary(java.lang.String binary)

getBinary

public java.lang.String getBinary()

if the file appears to be a zip file that includes compiled \"binary\" files, the value of this field will be the name of the platform on which they run (e.g. \"CLR\")

Returns:

binary

setBinary

public void setBinary(java.lang.String binary)

buildMeta

public DisplayTagState buildMeta(java.lang.String buildMeta)

getBuildMeta

public java.lang.String getBuildMeta()

if the file appears to be a zip file that includes some kind of build metadata (e.g. an npm package.json file), the value of this field will be a string describing what type of file was found

Returns:

buildMeta

setBuildMeta

public void setBuildMeta(java.lang.String buildMeta)

toolOutput

public DisplayTagState toolOutput(java.lang.String toolOutput)

getToolOutput

public java.lang.String getToolOutput()

if the file appears to be an output of a tool (i.e. a file containing Findings), the value of this field will be the name of that tool.

Returns:

toolOutput

setToolOutput

public void setToolOutput(java.lang.String toolOutput)

toolInput

public DisplayTagState toolInput(java.lang.String toolInput)

getToolInput

public java.lang.String getToolInput()

if the file appears to be usable as an input to a tool that Code Dx can automatically run, the value of this field will be that tool.

Returns:

toolInput

setToolInput

public void setToolInput(java.lang.String toolInput)

id

public DisplayTagState id(java.lang.String id)

getId

public java.lang.String getId()

a semi-random identifier which can be assumed to be unique within the context of an Analysis Prep. This identifier can be used when constructing URLs to interact with a specific Display Tag State.

Returns:

id

setId

public void setId(java.lang.String id)

enabled

public DisplayTagState enabled(java.lang.Boolean enabled)

isEnabled

public java.lang.Boolean isEnabled()

a boolean, indicating whether the tag is enabled. If not enabled, the content described by the tag will be treated as if it wasn't there. In the case of toolInput, that could mean that the particular tool would not be run.

Returns:

enabled

setEnabled

public void setEnabled(java.lang.Boolean enabled)

enabledReason

public DisplayTagState enabledReason(java.lang.String enabledReason)

getEnabledReason

public java.lang.String getEnabledReason()

a string, either \"user\", or \"rule-config\". If the associated project has disabled a particular tool by configuration, toolInput tags for that tool will be disabled by \"rule-config\". If the API is used to enable or disable a tag, it will be disabled by \"user\".

Returns:

enabledReason

setEnabledReason

public void setEnabledReason(java.lang.String enabledReason)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object