com.datadog.api.client.v2.api

Class DataObservabilityApi

java.lang.Object

com.datadog.api.client.v2.api.DataObservabilityApi

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

Constructor Summary

Constructors

Constructor and Description
DataObservabilityApi()
DataObservabilityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
GetDataObservabilityMonitorRunStatusResponse	getDataObservabilityMonitorRunStatus(String runId) Get data observability monitor run status.
CompletableFuture<GetDataObservabilityMonitorRunStatusResponse>	getDataObservabilityMonitorRunStatusAsync(String runId) Get data observability monitor run status.
ApiResponse<GetDataObservabilityMonitorRunStatusResponse>	getDataObservabilityMonitorRunStatusWithHttpInfo(String runId) Retrieves the current status of a data observability monitor run.
CompletableFuture<ApiResponse<GetDataObservabilityMonitorRunStatusResponse>>	getDataObservabilityMonitorRunStatusWithHttpInfoAsync(String runId) Get data observability monitor run status.
RunDataObservabilityMonitorResponse	runDataObservabilityMonitor(Long monitorId) Run a data observability monitor.
CompletableFuture<RunDataObservabilityMonitorResponse>	runDataObservabilityMonitorAsync(Long monitorId) Run a data observability monitor.
ApiResponse<RunDataObservabilityMonitorResponse>	runDataObservabilityMonitorWithHttpInfo(Long monitorId) Manually triggers a run for a data observability monitor.
CompletableFuture<ApiResponse<RunDataObservabilityMonitorResponse>>	runDataObservabilityMonitorWithHttpInfoAsync(Long monitorId) Run a data observability monitor.
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

DataObservabilityApi

public DataObservabilityApi()

DataObservabilityApi

public DataObservabilityApi(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

getDataObservabilityMonitorRunStatus

public GetDataObservabilityMonitorRunStatusResponse getDataObservabilityMonitorRunStatus(String runId)
                                                                                  throws ApiException

Get data observability monitor run status.

See getDataObservabilityMonitorRunStatusWithHttpInfo(java.lang.String).

Parameters:

runId - The ID of the monitor run to retrieve status for. (required)

Returns:

GetDataObservabilityMonitorRunStatusResponse

Throws:

ApiException - if fails to make API call

getDataObservabilityMonitorRunStatusAsync

public CompletableFuture<GetDataObservabilityMonitorRunStatusResponse> getDataObservabilityMonitorRunStatusAsync(String runId)

Get data observability monitor run status.

See getDataObservabilityMonitorRunStatusWithHttpInfoAsync(java.lang.String).

Parameters:

runId - The ID of the monitor run to retrieve status for. (required)

Returns:

CompletableFuture<GetDataObservabilityMonitorRunStatusResponse>

getDataObservabilityMonitorRunStatusWithHttpInfo

public ApiResponse<GetDataObservabilityMonitorRunStatusResponse> getDataObservabilityMonitorRunStatusWithHttpInfo(String runId)
                                                                                                           throws ApiException

Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

Parameters:

runId - The ID of the monitor run to retrieve status for. (required)

Returns:

ApiResponse<GetDataObservabilityMonitorRunStatusResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	Not Found	-
429	Too many requests	-

getDataObservabilityMonitorRunStatusWithHttpInfoAsync

public CompletableFuture<ApiResponse<GetDataObservabilityMonitorRunStatusResponse>> getDataObservabilityMonitorRunStatusWithHttpInfoAsync(String runId)

Get data observability monitor run status.

See getDataObservabilityMonitorRunStatusWithHttpInfo(java.lang.String).

Parameters:

runId - The ID of the monitor run to retrieve status for. (required)

Returns:

CompletableFuture<ApiResponse<GetDataObservabilityMonitorRunStatusResponse>>

runDataObservabilityMonitor

public RunDataObservabilityMonitorResponse runDataObservabilityMonitor(Long monitorId)
                                                                throws ApiException

Run a data observability monitor.

See runDataObservabilityMonitorWithHttpInfo(java.lang.Long).

Parameters:

monitorId - The ID of the data observability monitor to run. (required)

Returns:

RunDataObservabilityMonitorResponse

Throws:

ApiException - if fails to make API call

runDataObservabilityMonitorAsync

public CompletableFuture<RunDataObservabilityMonitorResponse> runDataObservabilityMonitorAsync(Long monitorId)

Run a data observability monitor.

See runDataObservabilityMonitorWithHttpInfoAsync(java.lang.Long).

Parameters:

monitorId - The ID of the data observability monitor to run. (required)

Returns:

CompletableFuture<RunDataObservabilityMonitorResponse>

runDataObservabilityMonitorWithHttpInfo

public ApiResponse<RunDataObservabilityMonitorResponse> runDataObservabilityMonitorWithHttpInfo(Long monitorId)
                                                                                         throws ApiException

Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.

Parameters:

monitorId - The ID of the data observability monitor to run. (required)

Returns:

ApiResponse<RunDataObservabilityMonitorResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

runDataObservabilityMonitorWithHttpInfoAsync

public CompletableFuture<ApiResponse<RunDataObservabilityMonitorResponse>> runDataObservabilityMonitorWithHttpInfoAsync(Long monitorId)

Run a data observability monitor.

See runDataObservabilityMonitorWithHttpInfo(java.lang.Long).

Parameters:

monitorId - The ID of the data observability monitor to run. (required)

Returns:

CompletableFuture<ApiResponse<RunDataObservabilityMonitorResponse>>