@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
52 lines (51 loc) • 2.65 kB
TypeScript
import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
import { Configuration } from "../../datadog-api-client-common/configuration";
import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
import { GovernanceInsightsResponse } from "../models/GovernanceInsightsResponse";
export declare class GovernanceInsightsApiRequestFactory extends BaseAPIRequestFactory {
listGovernanceInsights(withValues?: boolean, orgUuid?: string, filterProduct?: Array<string>, _options?: Configuration): Promise<RequestContext>;
}
export declare class GovernanceInsightsApiResponseProcessor {
/**
* Unwraps the actual response sent by the server from the response context and deserializes the response content
* to the expected objects
*
* @params response Response returned by the server for a request to listGovernanceInsights
* @throws ApiException if the response code was not in [200, 299]
*/
listGovernanceInsights(response: ResponseContext): Promise<GovernanceInsightsResponse>;
}
export interface GovernanceInsightsApiListGovernanceInsightsRequest {
/**
* Whether to compute and include the current and previous value of each insight.
* Defaults to `false`, in which case only insight metadata is returned.
* @type boolean
*/
withValues?: boolean;
/**
* The UUID of the organization to compute insights for. Defaults to the organization of
* the authenticated user. Used to retrieve insights for a child organization from a
* parent organization.
* @type string
*/
orgUuid?: string;
/**
* Restrict the results to insights belonging to the given products. May be repeated to
* filter by multiple products. Matching is case-insensitive.
* @type Array<string>
*/
filterProduct?: Array<string>;
}
export declare class GovernanceInsightsApi {
private requestFactory;
private responseProcessor;
private configuration;
constructor(configuration: Configuration, requestFactory?: GovernanceInsightsApiRequestFactory, responseProcessor?: GovernanceInsightsApiResponseProcessor);
/**
* Retrieve the list of governance insights available to the organization. By default, only
* insight metadata is returned; pass `withValues=true` to also compute and include each
* insight's current and previous values. Insights can be filtered by product.
* @param param The request object
*/
listGovernanceInsights(param?: GovernanceInsightsApiListGovernanceInsightsRequest, options?: Configuration): Promise<GovernanceInsightsResponse>;
}