Package com.datadog.api.client.v2.api
Class DoraMetricsApi
java.lang.Object
com.datadog.api.client.v2.api.DoraMetricsApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class DoraMetricsApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSend a deployment event.Send a deployment event.Use this API endpoint to provide deployment data.Send a deployment event.Send an incident event.Send an incident event.Use this API endpoint to provide incident data for DORA Metrics.Send an incident event.Deprecated.Deprecated.Deprecated.Deprecated.voiddeleteDORADeployment(String deploymentId) Delete a deployment event.deleteDORADeploymentAsync(String deploymentId) Delete a deployment event.deleteDORADeploymentWithHttpInfo(String deploymentId) Use this API endpoint to delete a deployment event.deleteDORADeploymentWithHttpInfoAsync(String deploymentId) Delete a deployment event.voiddeleteDORAFailure(String failureId) Delete an incident event.deleteDORAFailureAsync(String failureId) Delete an incident event.deleteDORAFailureWithHttpInfo(String failureId) Use this API endpoint to delete an incident event.deleteDORAFailureWithHttpInfoAsync(String failureId) Delete an incident event.Get the API client.getDORADeployment(String deploymentId) Get a deployment event.getDORADeploymentAsync(String deploymentId) Get a deployment event.getDORADeploymentWithHttpInfo(String deploymentId) Use this API endpoint to get a deployment event.getDORADeploymentWithHttpInfoAsync(String deploymentId) Get a deployment event.getDORAFailure(String failureId) Get an incident event.getDORAFailureAsync(String failureId) Get an incident event.getDORAFailureWithHttpInfo(String failureId) Use this API endpoint to get an incident event.getDORAFailureWithHttpInfoAsync(String failureId) Get an incident event.Get a list of deployment events.Get a list of deployment events.Use this API endpoint to get a list of deployment events.Get a list of deployment events.Get a list of incident events.Get a list of incident events.Use this API endpoint to get a list of incident events.Get a list of incident events.voidpatchDORADeployment(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.patchDORADeploymentAsync(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.voidPatch a deployment event by version.Patch a deployment event by version.Update a deployment's change failure status, identifying the deployment by its service, environment, and version instead of its ID.Patch a deployment event by version.patchDORADeploymentWithHttpInfo(String deploymentId, DORADeploymentPatchRequest body) Update a deployment's change failure status.patchDORADeploymentWithHttpInfoAsync(String deploymentId, DORADeploymentPatchRequest body) Patch a deployment event.voidsetApiClient(ApiClient apiClient) Set the API client.
-
Constructor Details
-
DoraMetricsApi
public DoraMetricsApi() -
DoraMetricsApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createDORADeployment
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
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
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/failureinstead.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
Delete a deployment event.- Parameters:
deploymentId- The ID of the deployment event to delete. (required)- Throws:
ApiException- if fails to make API call
-
deleteDORADeploymentAsync
Delete a deployment event.See
deleteDORADeploymentWithHttpInfoAsync(java.lang.String).- Parameters:
deploymentId- The ID of the deployment event to delete. (required)- Returns:
- CompletableFuture
-
deleteDORADeploymentWithHttpInfo
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.- Parameters:
deploymentId- The ID of the deployment event to delete. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteDORAFailure
Delete an incident event.- Parameters:
failureId- The ID of the incident event to delete. (required)- Throws:
ApiException- if fails to make API call
-
deleteDORAFailureAsync
Delete an incident event.- Parameters:
failureId- The ID of the incident event to delete. (required)- Returns:
- CompletableFuture
-
deleteDORAFailureWithHttpInfo
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
Delete an incident event.- Parameters:
failureId- The ID of the incident event to delete. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
getDORADeployment
Get a deployment event.- Parameters:
deploymentId- The ID of the deployment event. (required)- Returns:
- DORADeploymentFetchResponse
- Throws:
ApiException- if fails to make API call
-
getDORADeploymentAsync
Get a deployment event.- 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.- Parameters:
deploymentId- The ID of the deployment event. (required)- Returns:
- CompletableFuture<ApiResponse<DORADeploymentFetchResponse>>
-
getDORAFailure
Get an incident event.- Parameters:
failureId- The ID of the incident event. (required)- Returns:
- DORAFailureFetchResponse
- Throws:
ApiException- if fails to make API call
-
getDORAFailureAsync
Get an incident event.- 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.- 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
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.- 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.- 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.- Parameters:
deploymentId- The ID of the deployment event. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
patchDORADeploymentByVersion
public void patchDORADeploymentByVersion(DORADeploymentPatchByVersionRequest body) throws ApiException Patch a deployment event by version.- Parameters:
body- (required)- Throws:
ApiException- if fails to make API call
-
patchDORADeploymentByVersionAsync
public CompletableFuture<Void> patchDORADeploymentByVersionAsync(DORADeploymentPatchByVersionRequest body) Patch a deployment event by version.- Parameters:
body- (required)- Returns:
- CompletableFuture
-
patchDORADeploymentByVersionWithHttpInfo
public ApiResponse<Void> patchDORADeploymentByVersionWithHttpInfo(DORADeploymentPatchByVersionRequest body) throws ApiException Update a deployment's change failure status, identifying the deployment by its service, environment, and version instead of its ID. 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. If multiple deployments match the given service, environment, and version, the most recently finished one is updated.- Parameters:
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 -
-
patchDORADeploymentByVersionWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> patchDORADeploymentByVersionWithHttpInfoAsync(DORADeploymentPatchByVersionRequest body) Patch a deployment event by version.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-