Class DatasetsApi

Hierarchy

DatasetsApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

createDataset deleteDataset getAllDatasets getDataset updateDataset

Constructors

constructor

new DatasetsApi(configuration: Configuration, requestFactory?: DatasetsApiRequestFactory, responseProcessor?: DatasetsApiResponseProcessor): DatasetsApi
Parameters
- configuration: Configuration
- Optional requestFactory: DatasetsApiRequestFactory
- Optional responseProcessor: DatasetsApiResponseProcessor
Returns DatasetsApi
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:581

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: DatasetsApiRequestFactory

`Private` responseProcessor

responseProcessor: DatasetsApiResponseProcessor

Methods

createDataset

createDataset(param: DatasetsApiCreateDatasetRequest, options?: Configuration): Promise<DatasetResponseSingle>
Create a dataset with the configurations in the request.
Parameters
- param: DatasetsApiCreateDatasetRequest
  
  The request object
- Optional options: Configuration
Returns Promise<DatasetResponseSingle>
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:597

deleteDataset

deleteDataset(param: DatasetsApiDeleteDatasetRequest, options?: Configuration): Promise<void>
Deletes the dataset associated with the ID.
Parameters
- param: DatasetsApiDeleteDatasetRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:618

getAllDatasets

getAllDatasets(options?: Configuration): Promise<DatasetResponseMulti>
Get all datasets that have been configured for an organization.
Parameters
- Optional options: Configuration
Returns Promise<DatasetResponseMulti>
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:639

getDataset

getDataset(param: DatasetsApiGetDatasetRequest, options?: Configuration): Promise<DatasetResponseSingle>
Retrieves the dataset associated with the ID.
Parameters
- param: DatasetsApiGetDatasetRequest
  
  The request object
- Optional options: Configuration
Returns Promise<DatasetResponseSingle>
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:656

updateDataset

updateDataset(param: DatasetsApiUpdateDatasetRequest, options?: Configuration): Promise<DatasetResponseSingle>
Edits the dataset associated with the ID.
Parameters
- param: DatasetsApiUpdateDatasetRequest
  
  The request object
- Optional options: Configuration
Returns Promise<DatasetResponseSingle>
- Defined in packages/datadog-api-client-v2/apis/DatasetsApi.ts:677

Generated using TypeDoc