com.datadog.api.client.v2.model

Class CIAppPipelineEventStep

java.lang.Object

com.datadog.api.client.v2.model.CIAppPipelineEventStep

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class CIAppPipelineEventStep
extends Object

Details of a CI step.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_END
static String	JSON_PROPERTY_ERROR
static String	JSON_PROPERTY_GIT
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_JOB_ID
static String	JSON_PROPERTY_JOB_NAME
static String	JSON_PROPERTY_LEVEL
static String	JSON_PROPERTY_METRICS
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_NODE
static String	JSON_PROPERTY_PARAMETERS
static String	JSON_PROPERTY_PIPELINE_NAME
static String	JSON_PROPERTY_PIPELINE_UNIQUE_ID
static String	JSON_PROPERTY_STAGE_ID
static String	JSON_PROPERTY_STAGE_NAME
static String	JSON_PROPERTY_START
static String	JSON_PROPERTY_STATUS
static String	JSON_PROPERTY_TAGS
static String	JSON_PROPERTY_URL
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
CIAppPipelineEventStep()
CIAppPipelineEventStep(OffsetDateTime end, String id, CIAppPipelineEventStepLevel level, String name, String pipelineName, String pipelineUniqueId, OffsetDateTime start, CIAppPipelineEventStepStatus status)

Method Summary

Modifier and Type	Method and Description
CIAppPipelineEventStep	addMetricsItem(String metricsItem)
CIAppPipelineEventStep	addTagsItem(String tagsItem)
CIAppPipelineEventStep	end(OffsetDateTime end)
boolean	equals(Object o) Return true if this CIAppPipelineEventStep object is equal to o.
CIAppPipelineEventStep	error(CIAppCIError error)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
OffsetDateTime	getEnd() Time when the step run finished.
org.openapitools.jackson.nullable.JsonNullable<CIAppCIError>	getError_JsonNullable()
CIAppCIError	getError() Contains information of the CI error.
org.openapitools.jackson.nullable.JsonNullable<CIAppGitInfo>	getGit_JsonNullable()
CIAppGitInfo	getGit() If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.
String	getId() UUID for the step.
org.openapitools.jackson.nullable.JsonNullable<String>	getJobId_JsonNullable()
String	getJobId() The parent job UUID (if applicable).
org.openapitools.jackson.nullable.JsonNullable<String>	getJobName_JsonNullable()
String	getJobName() The parent job name (if applicable).
CIAppPipelineEventStepLevel	getLevel() Used to distinguish between pipelines, stages, jobs and steps.
org.openapitools.jackson.nullable.JsonNullable<List<String>>	getMetrics_JsonNullable()
List<String>	getMetrics() A list of user-defined metrics.
String	getName() The name for the step.
org.openapitools.jackson.nullable.JsonNullable<CIAppHostInfo>	getNode_JsonNullable()
CIAppHostInfo	getNode() Contains information of the host running the pipeline, stage, job, or step.
org.openapitools.jackson.nullable.JsonNullable<Map<String,String>>	getParameters_JsonNullable()
Map<String,String>	getParameters() A map of key-value parameters or environment variables that were defined for the pipeline.
String	getPipelineName() The parent pipeline name.
String	getPipelineUniqueId() The parent pipeline UUID.
org.openapitools.jackson.nullable.JsonNullable<String>	getStageId_JsonNullable()
String	getStageId() The parent stage UUID (if applicable).
org.openapitools.jackson.nullable.JsonNullable<String>	getStageName_JsonNullable()
String	getStageName() The parent stage name (if applicable).
OffsetDateTime	getStart() Time when the step run started.
CIAppPipelineEventStepStatus	getStatus() The final status of the step.
org.openapitools.jackson.nullable.JsonNullable<List<String>>	getTags_JsonNullable()
List<String>	getTags() A list of user-defined tags.
org.openapitools.jackson.nullable.JsonNullable<String>	getUrl_JsonNullable()
String	getUrl() The URL to look at the step in the CI provider UI.
CIAppPipelineEventStep	git(CIAppGitInfo git)
int	hashCode()
CIAppPipelineEventStep	id(String id)
CIAppPipelineEventStep	jobId(String jobId)
CIAppPipelineEventStep	jobName(String jobName)
CIAppPipelineEventStep	level(CIAppPipelineEventStepLevel level)
CIAppPipelineEventStep	metrics(List<String> metrics)
CIAppPipelineEventStep	name(String name)
CIAppPipelineEventStep	node(CIAppHostInfo node)
CIAppPipelineEventStep	parameters(Map<String,String> parameters)
CIAppPipelineEventStep	pipelineName(String pipelineName)
CIAppPipelineEventStep	pipelineUniqueId(String pipelineUniqueId)
CIAppPipelineEventStep	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
CIAppPipelineEventStep	putParametersItem(String key, String parametersItem)
void	setEnd(OffsetDateTime end)
void	setError_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppCIError> error)
void	setError(CIAppCIError error)
void	setGit_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppGitInfo> git)
void	setGit(CIAppGitInfo git)
void	setId(String id)
void	setJobId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobId)
void	setJobId(String jobId)
void	setJobName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobName)
void	setJobName(String jobName)
void	setLevel(CIAppPipelineEventStepLevel level)
void	setMetrics_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> metrics)
void	setMetrics(List<String> metrics)
void	setName(String name)
void	setNode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppHostInfo> node)
void	setNode(CIAppHostInfo node)
void	setParameters_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,String>> parameters)
void	setParameters(Map<String,String> parameters)
void	setPipelineName(String pipelineName)
void	setPipelineUniqueId(String pipelineUniqueId)
void	setStageId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> stageId)
void	setStageId(String stageId)
void	setStageName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> stageName)
void	setStageName(String stageName)
void	setStart(OffsetDateTime start)
void	setStatus(CIAppPipelineEventStepStatus status)
void	setTags_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tags)
void	setTags(List<String> tags)
void	setUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> url)
void	setUrl(String url)
CIAppPipelineEventStep	stageId(String stageId)
CIAppPipelineEventStep	stageName(String stageName)
CIAppPipelineEventStep	start(OffsetDateTime start)
CIAppPipelineEventStep	status(CIAppPipelineEventStepStatus status)
CIAppPipelineEventStep	tags(List<String> tags)
String	toString()
CIAppPipelineEventStep	url(String url)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_END

public static final String JSON_PROPERTY_END

See Also:

Constant Field Values

JSON_PROPERTY_ERROR

public static final String JSON_PROPERTY_ERROR

See Also:

Constant Field Values

JSON_PROPERTY_GIT

public static final String JSON_PROPERTY_GIT

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_JOB_ID

public static final String JSON_PROPERTY_JOB_ID

See Also:

Constant Field Values

JSON_PROPERTY_JOB_NAME

public static final String JSON_PROPERTY_JOB_NAME

See Also:

Constant Field Values

JSON_PROPERTY_LEVEL

public static final String JSON_PROPERTY_LEVEL

See Also:

Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_NODE

public static final String JSON_PROPERTY_NODE

See Also:

Constant Field Values

JSON_PROPERTY_PARAMETERS

public static final String JSON_PROPERTY_PARAMETERS

See Also:

Constant Field Values

JSON_PROPERTY_PIPELINE_NAME

public static final String JSON_PROPERTY_PIPELINE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PIPELINE_UNIQUE_ID

public static final String JSON_PROPERTY_PIPELINE_UNIQUE_ID

See Also:

Constant Field Values

JSON_PROPERTY_STAGE_ID

public static final String JSON_PROPERTY_STAGE_ID

See Also:

Constant Field Values

JSON_PROPERTY_STAGE_NAME

public static final String JSON_PROPERTY_STAGE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_START

public static final String JSON_PROPERTY_START

See Also:

Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

Constant Field Values

Constructor Detail

CIAppPipelineEventStep

public CIAppPipelineEventStep()

CIAppPipelineEventStep

public CIAppPipelineEventStep(OffsetDateTime end,
                              String id,
                              CIAppPipelineEventStepLevel level,
                              String name,
                              String pipelineName,
                              String pipelineUniqueId,
                              OffsetDateTime start,
                              CIAppPipelineEventStepStatus status)

Method Detail

end

public CIAppPipelineEventStep end(OffsetDateTime end)

getEnd

public OffsetDateTime getEnd()

Time when the step run finished. The time format must be RFC3339.

Returns:

end

setEnd

public void setEnd(OffsetDateTime end)

error

public CIAppPipelineEventStep error(CIAppCIError error)

getError

@Nullable
public CIAppCIError getError()

Contains information of the CI error.

Returns:

error

getError_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<CIAppCIError> getError_JsonNullable()

setError_JsonNullable

public void setError_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppCIError> error)

setError

public void setError(CIAppCIError error)

git

public CIAppPipelineEventStep git(CIAppGitInfo git)

getGit

@Nullable
public CIAppGitInfo getGit()

If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.

Returns:

git

getGit_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<CIAppGitInfo> getGit_JsonNullable()

setGit_JsonNullable

public void setGit_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppGitInfo> git)

setGit

public void setGit(CIAppGitInfo git)

id

public CIAppPipelineEventStep id(String id)

getId

public String getId()

UUID for the step. It has to be unique within each pipeline execution.

Returns:

id

setId

public void setId(String id)

jobId

public CIAppPipelineEventStep jobId(String jobId)

getJobId

@Nullable
public String getJobId()

The parent job UUID (if applicable).

Returns:

jobId

getJobId_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getJobId_JsonNullable()

setJobId_JsonNullable

public void setJobId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobId)

setJobId

public void setJobId(String jobId)

jobName

public CIAppPipelineEventStep jobName(String jobName)

getJobName

@Nullable
public String getJobName()

The parent job name (if applicable).

Returns:

jobName

getJobName_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getJobName_JsonNullable()

setJobName_JsonNullable

public void setJobName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> jobName)

setJobName

public void setJobName(String jobName)

level

public CIAppPipelineEventStep level(CIAppPipelineEventStepLevel level)

getLevel

public CIAppPipelineEventStepLevel getLevel()

Used to distinguish between pipelines, stages, jobs and steps.

Returns:

level

setLevel

public void setLevel(CIAppPipelineEventStepLevel level)

metrics

public CIAppPipelineEventStep metrics(List<String> metrics)

addMetricsItem

public CIAppPipelineEventStep addMetricsItem(String metricsItem)

getMetrics

@Nullable
public List<String> getMetrics()

A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.

Returns:

metrics

getMetrics_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<List<String>> getMetrics_JsonNullable()

setMetrics_JsonNullable

public void setMetrics_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> metrics)

setMetrics

public void setMetrics(List<String> metrics)

name

public CIAppPipelineEventStep name(String name)

getName

public String getName()

The name for the step.

Returns:

name

setName

public void setName(String name)

node

public CIAppPipelineEventStep node(CIAppHostInfo node)

getNode

@Nullable
public CIAppHostInfo getNode()

Contains information of the host running the pipeline, stage, job, or step.

Returns:

node

getNode_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<CIAppHostInfo> getNode_JsonNullable()

setNode_JsonNullable

public void setNode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<CIAppHostInfo> node)

setNode

public void setNode(CIAppHostInfo node)

parameters

public CIAppPipelineEventStep parameters(Map<String,String> parameters)

putParametersItem

public CIAppPipelineEventStep putParametersItem(String key,
                                                String parametersItem)

getParameters

@Nullable
public Map<String,String> getParameters()

A map of key-value parameters or environment variables that were defined for the pipeline.

Returns:

parameters

getParameters_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Map<String,String>> getParameters_JsonNullable()

setParameters_JsonNullable

public void setParameters_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,String>> parameters)

setParameters

public void setParameters(Map<String,String> parameters)

pipelineName

public CIAppPipelineEventStep pipelineName(String pipelineName)

getPipelineName

public String getPipelineName()

The parent pipeline name.

Returns:

pipelineName

setPipelineName

public void setPipelineName(String pipelineName)

pipelineUniqueId

public CIAppPipelineEventStep pipelineUniqueId(String pipelineUniqueId)

getPipelineUniqueId

public String getPipelineUniqueId()

The parent pipeline UUID.

Returns:

pipelineUniqueId

setPipelineUniqueId

public void setPipelineUniqueId(String pipelineUniqueId)

stageId

public CIAppPipelineEventStep stageId(String stageId)

getStageId

@Nullable
public String getStageId()

The parent stage UUID (if applicable).

Returns:

stageId

getStageId_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getStageId_JsonNullable()

setStageId_JsonNullable

public void setStageId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> stageId)

setStageId

public void setStageId(String stageId)

stageName

public CIAppPipelineEventStep stageName(String stageName)

getStageName

@Nullable
public String getStageName()

The parent stage name (if applicable).

Returns:

stageName

getStageName_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getStageName_JsonNullable()

setStageName_JsonNullable

public void setStageName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> stageName)

setStageName

public void setStageName(String stageName)

start

public CIAppPipelineEventStep start(OffsetDateTime start)

getStart

public OffsetDateTime getStart()

Time when the step run started. The time format must be RFC3339.

Returns:

start

setStart

public void setStart(OffsetDateTime start)

status

public CIAppPipelineEventStep status(CIAppPipelineEventStepStatus status)

getStatus

public CIAppPipelineEventStepStatus getStatus()

The final status of the step.

Returns:

status

setStatus

public void setStatus(CIAppPipelineEventStepStatus status)

tags

public CIAppPipelineEventStep tags(List<String> tags)

addTagsItem

public CIAppPipelineEventStep addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

A list of user-defined tags. The tags must follow the key:value pattern.

Returns:

tags

getTags_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTags_JsonNullable()

setTags_JsonNullable

public void setTags_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tags)

setTags

public void setTags(List<String> tags)

url

public CIAppPipelineEventStep url(String url)

getUrl

@Nullable
public String getUrl()

The URL to look at the step in the CI provider UI.

Returns:

url

getUrl_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getUrl_JsonNullable()

setUrl_JsonNullable

public void setUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> url)

setUrl

public void setUrl(String url)

putAdditionalProperty

public CIAppPipelineEventStep putAdditionalProperty(String key,
                                                    Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

CIAppPipelineEventStep

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this CIAppPipelineEventStep object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object