Package com.atlassian.bamboo.webhook

Interface WebhookResponse

All Superinterfaces:

BambooIdProvider

All Known Subinterfaces:

WebhookResponseDetails

All Known Implementing Classes:

WebhookResponseDetailsEntity, WebhookResponseDto

public interface WebhookResponse
extends BambooIdProvider

Method Summary

Modifier and Type	Method	Description
Long	getDeploymentResultId()
@NotNull String	getEventName()
@NotNull org.springframework.http.HttpMethod	getHttpMethod()
String	getPlanResultKey()
Date	getReceiveTime()
@NotNull WebhookResponseStatus	getResponseStatus()
int	getRetriesCount()
@NotNull Date	getSendTime()
Integer	getStatusCode()
@NotNull String	getTemplateName()
@NotNull String	getUrl()
@NotNull UUID	getUuid()

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Method Detail

getHttpMethod

@NotNull
@NotNull org.springframework.http.HttpMethod getHttpMethod()

Returns:

HTTP method of sent webhook

getUrl

@NotNull
@NotNull String getUrl()

Returns:

destination URL on which webhook was sent.

getResponseStatus

@NotNull
@NotNull WebhookResponseStatus getResponseStatus()

Returns:

current status of webhook response.

getStatusCode

@Nullable
Integer getStatusCode()

Returns:

current status code of webhook response. Null if there are no status code

getTemplateName

@NotNull
@NotNull String getTemplateName()

Returns:

name of template of sent webhook.

getEventName

@NotNull
@NotNull String getEventName()

Returns:

name of the event which triggered sending webhook.

getUuid

@NotNull
@NotNull UUID getUuid()

Returns:

uuid of sent webhook.

getRetriesCount

int getRetriesCount()

Returns:

number of retries of sending webhook.

getPlanResultKey

@Nullable
String getPlanResultKey()

Returns:

plan result key associated with webhook. Null if webhook is not associated with any plan result.

getDeploymentResultId

@Nullable
Long getDeploymentResultId()

Returns:

deployment result id associated with webhook. Null if webhook is not associated with any deployment result.

getSendTime

@NotNull
@NotNull Date getSendTime()

Returns:

time of sending webhook.

getReceiveTime

@Nullable
Date getReceiveTime()

Returns:

time of receiving webhook response.