Class DataObservabilityApi

Hierarchy

DataObservabilityApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

getDataObservabilityMonitorRunStatus runDataObservabilityMonitor

Constructors

constructor

new DataObservabilityApi(configuration: Configuration, requestFactory?: DataObservabilityApiRequestFactory, responseProcessor?: DataObservabilityApiResponseProcessor): DataObservabilityApi
Parameters
- configuration: Configuration
- Optional requestFactory: DataObservabilityApiRequestFactory
- Optional responseProcessor: DataObservabilityApiResponseProcessor
Returns DataObservabilityApi
- Defined in packages/datadog-api-client-v2/apis/DataObservabilityApi.ts:303

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: DataObservabilityApiRequestFactory

`Private` responseProcessor

responseProcessor: DataObservabilityApiResponseProcessor

Methods

getDataObservabilityMonitorRunStatus

getDataObservabilityMonitorRunStatus(param: DataObservabilityApiGetDataObservabilityMonitorRunStatusRequest, options?: Configuration): Promise<GetDataObservabilityMonitorRunStatusResponse>
Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
Parameters
- param: DataObservabilityApiGetDataObservabilityMonitorRunStatusRequest
  
  The request object
- Optional options: Configuration
Returns Promise<GetDataObservabilityMonitorRunStatusResponse>
- Defined in packages/datadog-api-client-v2/apis/DataObservabilityApi.ts:319

runDataObservabilityMonitor

runDataObservabilityMonitor(param: DataObservabilityApiRunDataObservabilityMonitorRequest, options?: Configuration): Promise<RunDataObservabilityMonitorResponse>
Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
Parameters
- param: DataObservabilityApiRunDataObservabilityMonitorRequest
  
  The request object
- Optional options: Configuration
Returns Promise<RunDataObservabilityMonitorResponse>
- Defined in packages/datadog-api-client-v2/apis/DataObservabilityApi.ts:343

Generated using TypeDoc