com.datadog.api.client.v2.api

Class DoraMetricsApi

java.lang.Object

com.datadog.api.client.v2.api.DoraMetricsApi

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

Constructor Summary

Constructors

Constructor and Description
DoraMetricsApi()
DoraMetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DORADeploymentResponse	createDORADeployment(DORADeploymentRequest body) Send a deployment event.
CompletableFuture<DORADeploymentResponse>	createDORADeploymentAsync(DORADeploymentRequest body) Send a deployment event.
ApiResponse<DORADeploymentResponse>	createDORADeploymentWithHttpInfo(DORADeploymentRequest body) Use this API endpoint to provide deployment data.
CompletableFuture<ApiResponse<DORADeploymentResponse>>	createDORADeploymentWithHttpInfoAsync(DORADeploymentRequest body) Send a deployment event.
DORAFailureResponse	createDORAFailure(DORAFailureRequest body) Send an incident event.
CompletableFuture<DORAFailureResponse>	createDORAFailureAsync(DORAFailureRequest body) Send an incident event.
ApiResponse<DORAFailureResponse>	createDORAFailureWithHttpInfo(DORAFailureRequest body) Use this API endpoint to provide incident data for DORA Metrics.
CompletableFuture<ApiResponse<DORAFailureResponse>>	createDORAFailureWithHttpInfoAsync(DORAFailureRequest body) Send an incident event.
DORAFailureResponse	createDORAIncident(DORAFailureRequest body) Deprecated.
CompletableFuture<DORAFailureResponse>	createDORAIncidentAsync(DORAFailureRequest body) Deprecated.
ApiResponse<DORAFailureResponse>	createDORAIncidentWithHttpInfo(DORAFailureRequest body) Deprecated.
CompletableFuture<ApiResponse<DORAFailureResponse>>	createDORAIncidentWithHttpInfoAsync(DORAFailureRequest body) Deprecated.
void	deleteDORADeployment(String deploymentId) Delete a deployment event.
CompletableFuture<Void>	deleteDORADeploymentAsync(String deploymentId) Delete a deployment event.
ApiResponse<Void>	deleteDORADeploymentWithHttpInfo(String deploymentId) Use this API endpoint to delete a deployment event.
CompletableFuture<ApiResponse<Void>>	deleteDORADeploymentWithHttpInfoAsync(String deploymentId) Delete a deployment event.
void	deleteDORAFailure(String failureId) Delete an incident event.
CompletableFuture<Void>	deleteDORAFailureAsync(String failureId) Delete an incident event.
ApiResponse<Void>	deleteDORAFailureWithHttpInfo(String failureId) Use this API endpoint to delete an incident event.
CompletableFuture<ApiResponse<Void>>	deleteDORAFailureWithHttpInfoAsync(String failureId) Delete an incident event.
ApiClient	getApiClient() Get the API client.
DORADeploymentFetchResponse	getDORADeployment(String deploymentId) Get a deployment event.
CompletableFuture<DORADeploymentFetchResponse>	getDORADeploymentAsync(String deploymentId) Get a deployment event.
ApiResponse<DORADeploymentFetchResponse>	getDORADeploymentWithHttpInfo(String deploymentId) Use this API endpoint to get a deployment event.
CompletableFuture<ApiResponse<DORADeploymentFetchResponse>>	getDORADeploymentWithHttpInfoAsync(String deploymentId) Get a deployment event.
DORAFailureFetchResponse	getDORAFailure(String failureId) Get an incident event.
CompletableFuture<DORAFailureFetchResponse>	getDORAFailureAsync(String failureId) Get an incident event.
ApiResponse<DORAFailureFetchResponse>	getDORAFailureWithHttpInfo(String failureId) Use this API endpoint to get an incident event.
CompletableFuture<ApiResponse<DORAFailureFetchResponse>>	getDORAFailureWithHttpInfoAsync(String failureId) Get an incident event.
DORADeploymentsListResponse	listDORADeployments(DORAListDeploymentsRequest body) Get a list of deployment events.
CompletableFuture<DORADeploymentsListResponse>	listDORADeploymentsAsync(DORAListDeploymentsRequest body) Get a list of deployment events.
ApiResponse<DORADeploymentsListResponse>	listDORADeploymentsWithHttpInfo(DORAListDeploymentsRequest body) Use this API endpoint to get a list of deployment events.
CompletableFuture<ApiResponse<DORADeploymentsListResponse>>	listDORADeploymentsWithHttpInfoAsync(DORAListDeploymentsRequest body) Get a list of deployment events.
DORAFailuresListResponse	listDORAFailures(DORAListFailuresRequest body) Get a list of incident events.
CompletableFuture<DORAFailuresListResponse>	listDORAFailuresAsync(DORAListFailuresRequest body) Get a list of incident events.
ApiResponse<DORAFailuresListResponse>	listDORAFailuresWithHttpInfo(DORAListFailuresRequest body) Use this API endpoint to get a list of incident events.
CompletableFuture<ApiResponse<DORAFailuresListResponse>>	listDORAFailuresWithHttpInfoAsync(DORAListFailuresRequest body) Get a list of incident events.
void	patchDORADeployment(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.
CompletableFuture<Void>	patchDORADeploymentAsync(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.
ApiResponse<Void>	patchDORADeploymentWithHttpInfo(String deploymentId, DORADeploymentPatchRequest body) Update a deployment's change failure status.
CompletableFuture<ApiResponse<Void>>	patchDORADeploymentWithHttpInfoAsync(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.
void	setApiClient(ApiClient apiClient) Set the API client.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoraMetricsApi

public DoraMetricsApi()

DoraMetricsApi

public DoraMetricsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createDORADeployment

public DORADeploymentResponse createDORADeployment(DORADeploymentRequest body)
                                            throws ApiException

Send a deployment event.

See createDORADeploymentWithHttpInfo(com.datadog.api.client.v2.model.DORADeploymentRequest).

Parameters:

body - (required)

Returns:

DORADeploymentResponse

Throws:

ApiException - if fails to make API call

createDORADeploymentAsync

public CompletableFuture<DORADeploymentResponse> createDORADeploymentAsync(DORADeploymentRequest body)

Send a deployment event.

See createDORADeploymentWithHttpInfoAsync(com.datadog.api.client.v2.model.DORADeploymentRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DORADeploymentResponse>

createDORADeploymentWithHttpInfo

public ApiResponse<DORADeploymentResponse> createDORADeploymentWithHttpInfo(DORADeploymentRequest body)
                                                                     throws ApiException

Use this API endpoint to provide deployment data.

This is necessary for: - Deployment Frequency - Change Lead Time - Change Failure Rate - Failed Deployment Recovery Time

Parameters:

body - (required)

Returns:

ApiResponse<DORADeploymentResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
202	OK - but delayed due to incident	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

createDORADeploymentWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORADeploymentResponse>> createDORADeploymentWithHttpInfoAsync(DORADeploymentRequest body)

Send a deployment event.

See createDORADeploymentWithHttpInfo(com.datadog.api.client.v2.model.DORADeploymentRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORADeploymentResponse>>

createDORAFailure

public DORAFailureResponse createDORAFailure(DORAFailureRequest body)
                                      throws ApiException

Send an incident event.

See createDORAFailureWithHttpInfo(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

DORAFailureResponse

Throws:

ApiException - if fails to make API call

createDORAFailureAsync

public CompletableFuture<DORAFailureResponse> createDORAFailureAsync(DORAFailureRequest body)

Send an incident event.

See createDORAFailureWithHttpInfoAsync(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DORAFailureResponse>

createDORAFailureWithHttpInfo

public ApiResponse<DORAFailureResponse> createDORAFailureWithHttpInfo(DORAFailureRequest body)
                                                               throws ApiException

Use this API endpoint to provide incident data for DORA Metrics. Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.

Parameters:

body - (required)

Returns:

ApiResponse<DORAFailureResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
202	OK - but delayed due to incident	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

createDORAFailureWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORAFailureResponse>> createDORAFailureWithHttpInfoAsync(DORAFailureRequest body)

Send an incident event.

See createDORAFailureWithHttpInfo(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAFailureResponse>>

createDORAIncident

@Deprecated
public DORAFailureResponse createDORAIncident(DORAFailureRequest body)
                                                   throws ApiException

Deprecated.

Send an incident event (legacy).

See createDORAIncidentWithHttpInfo(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

DORAFailureResponse

Throws:

ApiException - if fails to make API call

createDORAIncidentAsync

@Deprecated
public CompletableFuture<DORAFailureResponse> createDORAIncidentAsync(DORAFailureRequest body)

Deprecated.

Send an incident event (legacy).

See createDORAIncidentWithHttpInfoAsync(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DORAFailureResponse>

createDORAIncidentWithHttpInfo

@Deprecated
public ApiResponse<DORAFailureResponse> createDORAIncidentWithHttpInfo(DORAFailureRequest body)
                                                                            throws ApiException

Deprecated.

Note: This endpoint is deprecated. Please use /api/v2/dora/failure instead.

Use this API endpoint to provide incident data. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents.

Parameters:

body - (required)

Returns:

ApiResponse<DORAFailureResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
202	OK - but delayed due to incident	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

createDORAIncidentWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<DORAFailureResponse>> createDORAIncidentWithHttpInfoAsync(DORAFailureRequest body)

Deprecated.

Send an incident event (legacy).

See createDORAIncidentWithHttpInfo(com.datadog.api.client.v2.model.DORAFailureRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAFailureResponse>>

deleteDORADeployment

public void deleteDORADeployment(String deploymentId)
                          throws ApiException

Delete a deployment event.

See deleteDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event to delete. (required)

Throws:

ApiException - if fails to make API call

deleteDORADeploymentAsync

public CompletableFuture<Void> deleteDORADeploymentAsync(String deploymentId)

Delete a deployment event.

See deleteDORADeploymentWithHttpInfoAsync(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event to delete. (required)

Returns:

CompletableFuture

deleteDORADeploymentWithHttpInfo

public ApiResponse<Void> deleteDORADeploymentWithHttpInfo(String deploymentId)
                                                   throws ApiException

Use this API endpoint to delete a deployment event.

Parameters:

deploymentId - The ID of the deployment event to delete. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

deleteDORADeploymentWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDORADeploymentWithHttpInfoAsync(String deploymentId)

Delete a deployment event.

See deleteDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event to delete. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deleteDORAFailure

public void deleteDORAFailure(String failureId)
                       throws ApiException

Delete an incident event.

See deleteDORAFailureWithHttpInfo(java.lang.String).

Parameters:

failureId - The ID of the incident event to delete. (required)

Throws:

ApiException - if fails to make API call

deleteDORAFailureAsync

public CompletableFuture<Void> deleteDORAFailureAsync(String failureId)

Delete an incident event.

See deleteDORAFailureWithHttpInfoAsync(java.lang.String).

Parameters:

failureId - The ID of the incident event to delete. (required)

Returns:

CompletableFuture

deleteDORAFailureWithHttpInfo

public ApiResponse<Void> deleteDORAFailureWithHttpInfo(String failureId)
                                                throws ApiException

Use this API endpoint to delete an incident event.

Parameters:

failureId - The ID of the incident event to delete. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

deleteDORAFailureWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDORAFailureWithHttpInfoAsync(String failureId)

Delete an incident event.

See deleteDORAFailureWithHttpInfo(java.lang.String).

Parameters:

failureId - The ID of the incident event to delete. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getDORADeployment

public DORADeploymentFetchResponse getDORADeployment(String deploymentId)
                                              throws ApiException

Get a deployment event.

See getDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event. (required)

Returns:

DORADeploymentFetchResponse

Throws:

ApiException - if fails to make API call

getDORADeploymentAsync

public CompletableFuture<DORADeploymentFetchResponse> getDORADeploymentAsync(String deploymentId)

Get a deployment event.

See getDORADeploymentWithHttpInfoAsync(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event. (required)

Returns:

CompletableFuture<DORADeploymentFetchResponse>

getDORADeploymentWithHttpInfo

public ApiResponse<DORADeploymentFetchResponse> getDORADeploymentWithHttpInfo(String deploymentId)
                                                                       throws ApiException

Use this API endpoint to get a deployment event.

Parameters:

deploymentId - The ID of the deployment event. (required)

Returns:

ApiResponse<DORADeploymentFetchResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

getDORADeploymentWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORADeploymentFetchResponse>> getDORADeploymentWithHttpInfoAsync(String deploymentId)

Get a deployment event.

See getDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

deploymentId - The ID of the deployment event. (required)

Returns:

CompletableFuture<ApiResponse<DORADeploymentFetchResponse>>

getDORAFailure

public DORAFailureFetchResponse getDORAFailure(String failureId)
                                        throws ApiException

Get an incident event.

See getDORAFailureWithHttpInfo(java.lang.String).

Parameters:

failureId - The ID of the incident event. (required)

Returns:

DORAFailureFetchResponse

Throws:

ApiException - if fails to make API call

getDORAFailureAsync

public CompletableFuture<DORAFailureFetchResponse> getDORAFailureAsync(String failureId)

Get an incident event.

See getDORAFailureWithHttpInfoAsync(java.lang.String).

Parameters:

failureId - The ID of the incident event. (required)

Returns:

CompletableFuture<DORAFailureFetchResponse>

getDORAFailureWithHttpInfo

public ApiResponse<DORAFailureFetchResponse> getDORAFailureWithHttpInfo(String failureId)
                                                                 throws ApiException

Use this API endpoint to get an incident event.

Parameters:

failureId - The ID of the incident event. (required)

Returns:

ApiResponse<DORAFailureFetchResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

getDORAFailureWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORAFailureFetchResponse>> getDORAFailureWithHttpInfoAsync(String failureId)

Get an incident event.

See getDORAFailureWithHttpInfo(java.lang.String).

Parameters:

failureId - The ID of the incident event. (required)

Returns:

CompletableFuture<ApiResponse<DORAFailureFetchResponse>>

listDORADeployments

public DORADeploymentsListResponse listDORADeployments(DORAListDeploymentsRequest body)
                                                throws ApiException

Get a list of deployment events.

See listDORADeploymentsWithHttpInfo(com.datadog.api.client.v2.model.DORAListDeploymentsRequest).

Parameters:

body - (required)

Returns:

DORADeploymentsListResponse

Throws:

ApiException - if fails to make API call

listDORADeploymentsAsync

public CompletableFuture<DORADeploymentsListResponse> listDORADeploymentsAsync(DORAListDeploymentsRequest body)

Get a list of deployment events.

See listDORADeploymentsWithHttpInfoAsync(com.datadog.api.client.v2.model.DORAListDeploymentsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DORADeploymentsListResponse>

listDORADeploymentsWithHttpInfo

public ApiResponse<DORADeploymentsListResponse> listDORADeploymentsWithHttpInfo(DORAListDeploymentsRequest body)
                                                                         throws ApiException

Use this API endpoint to get a list of deployment events.

Parameters:

body - (required)

Returns:

ApiResponse<DORADeploymentsListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

listDORADeploymentsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORADeploymentsListResponse>> listDORADeploymentsWithHttpInfoAsync(DORAListDeploymentsRequest body)

Get a list of deployment events.

See listDORADeploymentsWithHttpInfo(com.datadog.api.client.v2.model.DORAListDeploymentsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORADeploymentsListResponse>>

listDORAFailures

public DORAFailuresListResponse listDORAFailures(DORAListFailuresRequest body)
                                          throws ApiException

Get a list of incident events.

See listDORAFailuresWithHttpInfo(com.datadog.api.client.v2.model.DORAListFailuresRequest).

Parameters:

body - (required)

Returns:

DORAFailuresListResponse

Throws:

ApiException - if fails to make API call

listDORAFailuresAsync

public CompletableFuture<DORAFailuresListResponse> listDORAFailuresAsync(DORAListFailuresRequest body)

Get a list of incident events.

See listDORAFailuresWithHttpInfoAsync(com.datadog.api.client.v2.model.DORAListFailuresRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DORAFailuresListResponse>

listDORAFailuresWithHttpInfo

public ApiResponse<DORAFailuresListResponse> listDORAFailuresWithHttpInfo(DORAListFailuresRequest body)
                                                                   throws ApiException

Use this API endpoint to get a list of incident events.

Parameters:

body - (required)

Returns:

ApiResponse<DORAFailuresListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

listDORAFailuresWithHttpInfoAsync

public CompletableFuture<ApiResponse<DORAFailuresListResponse>> listDORAFailuresWithHttpInfoAsync(DORAListFailuresRequest body)

Get a list of incident events.

See listDORAFailuresWithHttpInfo(com.datadog.api.client.v2.model.DORAListFailuresRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAFailuresListResponse>>

patchDORADeployment

public void patchDORADeployment(String deploymentId,
                                DORADeploymentPatchRequest body)
                         throws ApiException

Patch a deployment event.

See patchDORADeploymentWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.DORADeploymentPatchRequest).

Parameters:

deploymentId - The ID of the deployment event. (required)

body - (required)

Throws:

ApiException - if fails to make API call

patchDORADeploymentAsync

public CompletableFuture<Void> patchDORADeploymentAsync(String deploymentId,
                                                        DORADeploymentPatchRequest body)

Patch a deployment event.

See patchDORADeploymentWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.DORADeploymentPatchRequest).

Parameters:

deploymentId - The ID of the deployment event. (required)

body - (required)

Returns:

CompletableFuture

patchDORADeploymentWithHttpInfo

public ApiResponse<Void> patchDORADeploymentWithHttpInfo(String deploymentId,
                                                         DORADeploymentPatchRequest body)
                                                  throws ApiException

Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.

Parameters:

deploymentId - The ID of the deployment event. (required)

body - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

patchDORADeploymentWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> patchDORADeploymentWithHttpInfoAsync(String deploymentId,
                                                                                 DORADeploymentPatchRequest body)

Patch a deployment event.

See patchDORADeploymentWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.DORADeploymentPatchRequest).

Parameters:

deploymentId - The ID of the deployment event. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<Void>>