@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
84 lines (83 loc) • 2.45 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { SyntheticsAPITestConfig } from "./SyntheticsAPITestConfig";
import { SyntheticsAPITestType } from "./SyntheticsAPITestType";
import { SyntheticsTestDetailsSubType } from "./SyntheticsTestDetailsSubType";
import { SyntheticsTestOptions } from "./SyntheticsTestOptions";
import { SyntheticsTestPauseStatus } from "./SyntheticsTestPauseStatus";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* Object containing details about a Synthetic API test.
*/
export declare class SyntheticsAPITest {
/**
* Configuration object for a Synthetic API test.
*/
"config": SyntheticsAPITestConfig;
/**
* Array of locations used to run the test.
*/
"locations": Array<string>;
/**
* Notification message associated with the test.
*/
"message": string;
/**
* The associated monitor ID.
*/
"monitorId"?: number;
/**
* Name of the test.
*/
"name": string;
/**
* Object describing the extra options for a Synthetic test.
*/
"options": SyntheticsTestOptions;
/**
* The public ID for the test.
*/
"publicId"?: string;
/**
* Define whether you want to start (`live`) or pause (`paused`) a
* Synthetic test.
*/
"status"?: SyntheticsTestPauseStatus;
/**
* The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
* `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.
*/
"subtype"?: SyntheticsTestDetailsSubType;
/**
* Array of tags attached to the test.
*/
"tags"?: Array<string>;
/**
* Type of the Synthetic test, `api`.
*/
"type": SyntheticsAPITestType;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}