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 for DORA Metrics.
CompletableFuture<DORADeploymentResponse>	createDORADeploymentAsync(DORADeploymentRequest body) Send a deployment event for DORA Metrics.
ApiResponse<DORADeploymentResponse>	createDORADeploymentWithHttpInfo(DORADeploymentRequest body) Use this API endpoint to provide data about deployments for DORA metrics.
CompletableFuture<ApiResponse<DORADeploymentResponse>>	createDORADeploymentWithHttpInfoAsync(DORADeploymentRequest body) Send a deployment event for DORA Metrics.
DORAFailureResponse	createDORAFailure(DORAFailureRequest body) Send a failure event for DORA Metrics.
CompletableFuture<DORAFailureResponse>	createDORAFailureAsync(DORAFailureRequest body) Send a failure event for DORA Metrics.
ApiResponse<DORAFailureResponse>	createDORAFailureWithHttpInfo(DORAFailureRequest body) Use this API endpoint to provide failure data for DORA metrics.
CompletableFuture<ApiResponse<DORAFailureResponse>>	createDORAFailureWithHttpInfoAsync(DORAFailureRequest body) Send a failure event for DORA Metrics.
DORAFailureResponse	createDORAIncident(DORAFailureRequest body) Deprecated.
CompletableFuture<DORAFailureResponse>	createDORAIncidentAsync(DORAFailureRequest body) Deprecated.
ApiResponse<DORAFailureResponse>	createDORAIncidentWithHttpInfo(DORAFailureRequest body) Deprecated.
CompletableFuture<ApiResponse<DORAFailureResponse>>	createDORAIncidentWithHttpInfoAsync(DORAFailureRequest body) Deprecated.
ApiClient	getApiClient() Get the API client.
DORAFetchResponse	getDORADeployment(String deploymentId) Get a deployment event.
CompletableFuture<DORAFetchResponse>	getDORADeploymentAsync(String deploymentId) Get a deployment event.
ApiResponse<DORAFetchResponse>	getDORADeploymentWithHttpInfo(String deploymentId) Use this API endpoint to get a deployment event.
CompletableFuture<ApiResponse<DORAFetchResponse>>	getDORADeploymentWithHttpInfoAsync(String deploymentId) Get a deployment event.
DORAFetchResponse	getDORAFailure(String failureId) Get a failure event.
CompletableFuture<DORAFetchResponse>	getDORAFailureAsync(String failureId) Get a failure event.
ApiResponse<DORAFetchResponse>	getDORAFailureWithHttpInfo(String failureId) Use this API endpoint to get a failure event.
CompletableFuture<ApiResponse<DORAFetchResponse>>	getDORAFailureWithHttpInfoAsync(String failureId) Get a failure event.
DORAListResponse	listDORADeployments(DORAListDeploymentsRequest body) Get a list of deployment events.
CompletableFuture<DORAListResponse>	listDORADeploymentsAsync(DORAListDeploymentsRequest body) Get a list of deployment events.
ApiResponse<DORAListResponse>	listDORADeploymentsWithHttpInfo(DORAListDeploymentsRequest body) Use this API endpoint to get a list of deployment events.
CompletableFuture<ApiResponse<DORAListResponse>>	listDORADeploymentsWithHttpInfoAsync(DORAListDeploymentsRequest body) Get a list of deployment events.
DORAListResponse	listDORAFailures(DORAListFailuresRequest body) Get a list of failure events.
CompletableFuture<DORAListResponse>	listDORAFailuresAsync(DORAListFailuresRequest body) Get a list of failure events.
ApiResponse<DORAListResponse>	listDORAFailuresWithHttpInfo(DORAListFailuresRequest body) Use this API endpoint to get a list of failure events.
CompletableFuture<ApiResponse<DORAListResponse>>	listDORAFailuresWithHttpInfoAsync(DORAListFailuresRequest body) Get a list of failure events.
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 for DORA Metrics.

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 for DORA Metrics.

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 data about deployments for DORA metrics.

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

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 for DORA Metrics.

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 a failure event for DORA Metrics.

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 a failure event for DORA Metrics.

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 failure data for DORA metrics.

This is necessary for: - Change Failure Rate - Time to Restore

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 a failure event for DORA Metrics.

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 for DORA Metrics.

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 for DORA Metrics.

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 failure data for DORA metrics.

This is necessary for: - Change Failure Rate - Time to Restore

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 for DORA Metrics.

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

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAFailureResponse>>

getDORADeployment

public DORAFetchResponse getDORADeployment(String deploymentId)
                                    throws ApiException

Get a deployment event.

See getDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

DORAFetchResponse

Throws:

ApiException - if fails to make API call

getDORADeploymentAsync

public CompletableFuture<DORAFetchResponse> getDORADeploymentAsync(String deploymentId)

Get a deployment event.

See getDORADeploymentWithHttpInfoAsync(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<DORAFetchResponse>

getDORADeploymentWithHttpInfo

public ApiResponse<DORAFetchResponse> 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<DORAFetchResponse>

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<DORAFetchResponse>> getDORADeploymentWithHttpInfoAsync(String deploymentId)

Get a deployment event.

See getDORADeploymentWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<DORAFetchResponse>>

getDORAFailure

public DORAFetchResponse getDORAFailure(String failureId)
                                 throws ApiException

Get a failure event.

See getDORAFailureWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

DORAFetchResponse

Throws:

ApiException - if fails to make API call

getDORAFailureAsync

public CompletableFuture<DORAFetchResponse> getDORAFailureAsync(String failureId)

Get a failure event.

See getDORAFailureWithHttpInfoAsync(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<DORAFetchResponse>

getDORAFailureWithHttpInfo

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

Use this API endpoint to get a failure event.

Parameters:

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

Returns:

ApiResponse<DORAFetchResponse>

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<DORAFetchResponse>> getDORAFailureWithHttpInfoAsync(String failureId)

Get a failure event.

See getDORAFailureWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<DORAFetchResponse>>

listDORADeployments

public DORAListResponse listDORADeployments(DORAListDeploymentsRequest body)
                                     throws ApiException

Get a list of deployment events.

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

Parameters:

body - (required)

Returns:

DORAListResponse

Throws:

ApiException - if fails to make API call

listDORADeploymentsAsync

public CompletableFuture<DORAListResponse> listDORADeploymentsAsync(DORAListDeploymentsRequest body)

Get a list of deployment events.

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

Parameters:

body - (required)

Returns:

CompletableFuture<DORAListResponse>

listDORADeploymentsWithHttpInfo

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

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

Parameters:

body - (required)

Returns:

ApiResponse<DORAListResponse>

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<DORAListResponse>> listDORADeploymentsWithHttpInfoAsync(DORAListDeploymentsRequest body)

Get a list of deployment events.

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

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAListResponse>>

listDORAFailures

public DORAListResponse listDORAFailures(DORAListFailuresRequest body)
                                  throws ApiException

Get a list of failure events.

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

Parameters:

body - (required)

Returns:

DORAListResponse

Throws:

ApiException - if fails to make API call

listDORAFailuresAsync

public CompletableFuture<DORAListResponse> listDORAFailuresAsync(DORAListFailuresRequest body)

Get a list of failure events.

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

Parameters:

body - (required)

Returns:

CompletableFuture<DORAListResponse>

listDORAFailuresWithHttpInfo

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

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

Parameters:

body - (required)

Returns:

ApiResponse<DORAListResponse>

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<DORAListResponse>> listDORAFailuresWithHttpInfoAsync(DORAListFailuresRequest body)

Get a list of failure events.

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

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DORAListResponse>>