Class ServiceDefinitionApi

Hierarchy

ServiceDefinitionApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

createOrUpdateServiceDefinitions deleteServiceDefinition getServiceDefinition listServiceDefinitions listServiceDefinitionsWithPagination

Constructors

constructor

new ServiceDefinitionApi(configuration: Configuration, requestFactory?: ServiceDefinitionApiRequestFactory, responseProcessor?: ServiceDefinitionApiResponseProcessor): ServiceDefinitionApi
Parameters
- configuration: Configuration
- Optional requestFactory: ServiceDefinitionApiRequestFactory
- Optional responseProcessor: ServiceDefinitionApiResponseProcessor
Returns ServiceDefinitionApi
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:503

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: ServiceDefinitionApiRequestFactory

`Private` responseProcessor

responseProcessor: ServiceDefinitionApiResponseProcessor

Methods

createOrUpdateServiceDefinitions

createOrUpdateServiceDefinitions(param: ServiceDefinitionApiCreateOrUpdateServiceDefinitionsRequest, options?: Configuration): Promise<ServiceDefinitionCreateResponse>
Create or update service definition in the Datadog Service Catalog.
Parameters
- param: ServiceDefinitionApiCreateOrUpdateServiceDefinitionsRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ServiceDefinitionCreateResponse>
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:519

deleteServiceDefinition

deleteServiceDefinition(param: ServiceDefinitionApiDeleteServiceDefinitionRequest, options?: Configuration): Promise<void>
Delete a single service definition in the Datadog Service Catalog.
Parameters
- param: ServiceDefinitionApiDeleteServiceDefinitionRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:540

getServiceDefinition

getServiceDefinition(param: ServiceDefinitionApiGetServiceDefinitionRequest, options?: Configuration): Promise<ServiceDefinitionGetResponse>
Get a single service definition from the Datadog Service Catalog.
Parameters
- param: ServiceDefinitionApiGetServiceDefinitionRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ServiceDefinitionGetResponse>
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:563

listServiceDefinitions

listServiceDefinitions(param?: ServiceDefinitionApiListServiceDefinitionsRequest, options?: Configuration): Promise<ServiceDefinitionsListResponse>
Get a list of all service definitions from the Datadog Service Catalog.
Parameters
- param: ServiceDefinitionApiListServiceDefinitionsRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ServiceDefinitionsListResponse>
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:585

listServiceDefinitionsWithPagination

listServiceDefinitionsWithPagination(param?: ServiceDefinitionApiListServiceDefinitionsRequest, options?: Configuration): AsyncGenerator<ServiceDefinitionData, any, unknown>
Provide a paginated version of listServiceDefinitions returning a generator with all the items.
Parameters
- param: ServiceDefinitionApiListServiceDefinitionsRequest = {}
- Optional options: Configuration
Returns AsyncGenerator<ServiceDefinitionData, any, unknown>
- Defined in packages/datadog-api-client-v2/apis/ServiceDefinitionApi.ts:607

Class ServiceDefinitionApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: ServiceDefinitionApiRequestFactory

Optional responseProcessor: ServiceDefinitionApiResponseProcessor

Returns ServiceDefinitionApi

Properties

Private configuration

Private requestFactory

Private responseProcessor

Methods

createOrUpdateServiceDefinitions

Parameters

param: ServiceDefinitionApiCreateOrUpdateServiceDefinitionsRequest

Optional options: Configuration

Returns Promise<ServiceDefinitionCreateResponse>

deleteServiceDefinition

Parameters

param: ServiceDefinitionApiDeleteServiceDefinitionRequest

Optional options: Configuration

Returns Promise<void>

getServiceDefinition

Parameters

param: ServiceDefinitionApiGetServiceDefinitionRequest

Optional options: Configuration

Returns Promise<ServiceDefinitionGetResponse>

listServiceDefinitions

Parameters

param: ServiceDefinitionApiListServiceDefinitionsRequest = {}

Optional options: Configuration

Returns Promise<ServiceDefinitionsListResponse>

listServiceDefinitionsWithPagination

Parameters

param: ServiceDefinitionApiListServiceDefinitionsRequest = {}

Optional options: Configuration

Returns AsyncGenerator<ServiceDefinitionData, any, unknown>

Settings

Member Visibility

Theme

`Optional` requestFactory: ServiceDefinitionApiRequestFactory

`Optional` responseProcessor: ServiceDefinitionApiResponseProcessor

`Private` configuration

`Private` requestFactory

`Private` responseProcessor

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration