Class ObservabilityPipelinesApi

Hierarchy

ObservabilityPipelinesApi

Index

Constructors

constructor

new ObservabilityPipelinesApi(configuration: Configuration, requestFactory?: ObservabilityPipelinesApiRequestFactory, responseProcessor?: ObservabilityPipelinesApiResponseProcessor): ObservabilityPipelinesApi
Parameters
- configuration: Configuration
- Optional requestFactory: ObservabilityPipelinesApiRequestFactory
- Optional responseProcessor: ObservabilityPipelinesApiResponseProcessor
Returns ObservabilityPipelinesApi
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:731

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: ObservabilityPipelinesApiRequestFactory

`Private` responseProcessor

responseProcessor: ObservabilityPipelinesApiResponseProcessor

Methods

createPipeline

createPipeline(param: ObservabilityPipelinesApiCreatePipelineRequest, options?: Configuration): Promise<ObservabilityPipeline>
Create a new pipeline.
Parameters
- param: ObservabilityPipelinesApiCreatePipelineRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ObservabilityPipeline>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:748

deletePipeline

deletePipeline(param: ObservabilityPipelinesApiDeletePipelineRequest, options?: Configuration): Promise<void>
Delete a pipeline.
Parameters
- param: ObservabilityPipelinesApiDeletePipelineRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:769

getPipeline

getPipeline(param: ObservabilityPipelinesApiGetPipelineRequest, options?: Configuration): Promise<ObservabilityPipeline>
Get a specific pipeline by its ID.
Parameters
- param: ObservabilityPipelinesApiGetPipelineRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ObservabilityPipeline>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:790

listPipelines

listPipelines(param?: ObservabilityPipelinesApiListPipelinesRequest, options?: Configuration): Promise<ListPipelinesResponse>
Retrieve a list of pipelines.
Parameters
- param: ObservabilityPipelinesApiListPipelinesRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ListPipelinesResponse>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:811

updatePipeline

updatePipeline(param: ObservabilityPipelinesApiUpdatePipelineRequest, options?: Configuration): Promise<ObservabilityPipeline>
Update a pipeline.
Parameters
- param: ObservabilityPipelinesApiUpdatePipelineRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ObservabilityPipeline>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:833

validatePipeline

validatePipeline(param: ObservabilityPipelinesApiValidatePipelineRequest, options?: Configuration): Promise<ValidationResponse>
Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.
Parameters
- param: ObservabilityPipelinesApiValidatePipelineRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ValidationResponse>
- Defined in packages/datadog-api-client-v2/apis/ObservabilityPipelinesApi.ts:856

Class ObservabilityPipelinesApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: ObservabilityPipelinesApiRequestFactory

Optional responseProcessor: ObservabilityPipelinesApiResponseProcessor

Returns ObservabilityPipelinesApi

Properties

Private configuration

Private requestFactory

Private responseProcessor

Methods

createPipeline

Parameters

param: ObservabilityPipelinesApiCreatePipelineRequest

Optional options: Configuration

Returns Promise<ObservabilityPipeline>

deletePipeline

Parameters

param: ObservabilityPipelinesApiDeletePipelineRequest

Optional options: Configuration

Returns Promise<void>

getPipeline

Parameters

param: ObservabilityPipelinesApiGetPipelineRequest

Optional options: Configuration

Returns Promise<ObservabilityPipeline>

listPipelines

Parameters

param: ObservabilityPipelinesApiListPipelinesRequest = {}

Optional options: Configuration

Returns Promise<ListPipelinesResponse>

updatePipeline

Parameters

param: ObservabilityPipelinesApiUpdatePipelineRequest

Optional options: Configuration

Returns Promise<ObservabilityPipeline>

validatePipeline

Parameters

param: ObservabilityPipelinesApiValidatePipelineRequest

Optional options: Configuration

Returns Promise<ValidationResponse>

Settings

Member Visibility

Theme

`Optional` requestFactory: ObservabilityPipelinesApiRequestFactory

`Optional` responseProcessor: ObservabilityPipelinesApiResponseProcessor

`Private` configuration

`Private` requestFactory

`Private` responseProcessor

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration