@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
83 lines (82 loc) • 2.57 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 { SyntheticsAPITestStepSubtype } from "./SyntheticsAPITestStepSubtype";
import { SyntheticsAssertion } from "./SyntheticsAssertion";
import { SyntheticsParsingOptions } from "./SyntheticsParsingOptions";
import { SyntheticsTestOptionsRetry } from "./SyntheticsTestOptionsRetry";
import { SyntheticsTestRequest } from "./SyntheticsTestRequest";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* The Test step used in a Synthetic multi-step API test.
*/
export declare class SyntheticsAPITestStep {
/**
* Determines whether or not to continue with test if this step fails.
*/
"allowFailure"?: boolean;
/**
* Array of assertions used for the test.
*/
"assertions": Array<SyntheticsAssertion>;
/**
* Determines whether or not to exit the test if the step succeeds.
*/
"exitIfSucceed"?: boolean;
/**
* Array of values to parse and save as variables from the response.
*/
"extractedValues"?: Array<SyntheticsParsingOptions>;
/**
* Generate variables using JavaScript.
*/
"extractedValuesFromScript"?: string;
/**
* ID of the step.
*/
"id"?: string;
/**
* Determines whether or not to consider the entire test as failed if this step fails.
* Can be used only if `allowFailure` is `true`.
*/
"isCritical"?: boolean;
/**
* The name of the step.
*/
"name": string;
/**
* Object describing the Synthetic test request.
*/
"request": SyntheticsTestRequest;
/**
* Object describing the retry strategy to apply to a Synthetic test.
*/
"retry"?: SyntheticsTestOptionsRetry;
/**
* The subtype of the Synthetic multi-step API test step.
*/
"subtype": SyntheticsAPITestStepSubtype;
/**
* 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();
}