Class SoftwareCatalogApi

Hierarchy

SoftwareCatalogApi

Index

Constructors

constructor

new SoftwareCatalogApi(configuration: Configuration, requestFactory?: SoftwareCatalogApiRequestFactory, responseProcessor?: SoftwareCatalogApiResponseProcessor): SoftwareCatalogApi
Parameters
- configuration: Configuration
- Optional requestFactory: SoftwareCatalogApiRequestFactory
- Optional responseProcessor: SoftwareCatalogApiResponseProcessor
Returns SoftwareCatalogApi
- Defined in packages/datadog-api-client-v2/apis/SoftwareCatalogApi.ts:465

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: SoftwareCatalogApiRequestFactory

`Private` responseProcessor

responseProcessor: SoftwareCatalogApiResponseProcessor

Methods

deleteCatalogEntity

deleteCatalogEntity(param: SoftwareCatalogApiDeleteCatalogEntityRequest, options?: Configuration): Promise<void>
Delete a single entity in Software Catalog.
Parameters
- param: SoftwareCatalogApiDeleteCatalogEntityRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/SoftwareCatalogApi.ts:481

listCatalogEntity

listCatalogEntity(param?: SoftwareCatalogApiListCatalogEntityRequest, options?: Configuration): Promise<ListEntityCatalogResponse>
Get a list of entities from Software Catalog.
Parameters
- param: SoftwareCatalogApiListCatalogEntityRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ListEntityCatalogResponse>
- Defined in packages/datadog-api-client-v2/apis/SoftwareCatalogApi.ts:502

listCatalogEntityWithPagination

listCatalogEntityWithPagination(param?: SoftwareCatalogApiListCatalogEntityRequest, options?: Configuration): AsyncGenerator<EntityData, any, unknown>
Provide a paginated version of listCatalogEntity returning a generator with all the items.
Parameters
- param: SoftwareCatalogApiListCatalogEntityRequest = {}
- Optional options: Configuration
Returns AsyncGenerator<EntityData, any, unknown>
- Defined in packages/datadog-api-client-v2/apis/SoftwareCatalogApi.ts:531

upsertCatalogEntity

upsertCatalogEntity(param: SoftwareCatalogApiUpsertCatalogEntityRequest, options?: Configuration): Promise<UpsertCatalogEntityResponse>
Create or update entities in Software Catalog.
Parameters
- param: SoftwareCatalogApiUpsertCatalogEntityRequest
  
  The request object
- Optional options: Configuration
Returns Promise<UpsertCatalogEntityResponse>
- Defined in packages/datadog-api-client-v2/apis/SoftwareCatalogApi.ts:581

Class SoftwareCatalogApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: SoftwareCatalogApiRequestFactory

Optional responseProcessor: SoftwareCatalogApiResponseProcessor

Returns SoftwareCatalogApi

Properties

Private configuration

Private requestFactory

Private responseProcessor

Methods

deleteCatalogEntity

Parameters

param: SoftwareCatalogApiDeleteCatalogEntityRequest

Optional options: Configuration

Returns Promise<void>

listCatalogEntity

Parameters

param: SoftwareCatalogApiListCatalogEntityRequest = {}

Optional options: Configuration

Returns Promise<ListEntityCatalogResponse>

listCatalogEntityWithPagination

Parameters

param: SoftwareCatalogApiListCatalogEntityRequest = {}

Optional options: Configuration

Returns AsyncGenerator<EntityData, any, unknown>

upsertCatalogEntity

Parameters

param: SoftwareCatalogApiUpsertCatalogEntityRequest

Optional options: Configuration

Returns Promise<UpsertCatalogEntityResponse>

Settings

Member Visibility

Theme

`Optional` requestFactory: SoftwareCatalogApiRequestFactory

`Optional` responseProcessor: SoftwareCatalogApiResponseProcessor

`Private` configuration

`Private` requestFactory

`Private` responseProcessor

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration