synthetics_api_wait_step.py

# 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 2019-Present Datadog, Inc.
from __future__ import annotations

from typing import Union, TYPE_CHECKING

from datadog_api_client.model_utils import (
    ModelNormal,
    cached_property,
    unset,
    UnsetType,
)


if TYPE_CHECKING:
    from datadog_api_client.v1.model.synthetics_api_wait_step_subtype import SyntheticsAPIWaitStepSubtype


class SyntheticsAPIWaitStep(ModelNormal):
    validations = {
        "value": {
            "inclusive_maximum": 180,
            "inclusive_minimum": 0,
        },
    }

    @cached_property
    def openapi_types(_):
        from datadog_api_client.v1.model.synthetics_api_wait_step_subtype import SyntheticsAPIWaitStepSubtype

        return {
            "id": (str,),
            "name": (str,),
            "subtype": (SyntheticsAPIWaitStepSubtype,),
            "value": (int,),
        }

    attribute_map = {
        "id": "id",
        "name": "name",
        "subtype": "subtype",
        "value": "value",
    }
    read_only_vars = {
        "id",
    }

    def __init__(
        self_, name: str, subtype: SyntheticsAPIWaitStepSubtype, value: int, id: Union[str, UnsetType] = unset, **kwargs
    ):
        """
        The Wait step used in a Synthetic multi-step API test.

        :param id: ID of the step.
        :type id: str, optional

        :param name: The name of the step.
        :type name: str

        :param subtype: The subtype of the Synthetic multi-step API wait step.
        :type subtype: SyntheticsAPIWaitStepSubtype

        :param value: The time to wait in seconds. Minimum value: 0. Maximum value: 180.
        :type value: int
        """
        if id is not unset:
            kwargs["id"] = id
        super().__init__(kwargs)

        self_.name = name
        self_.subtype = subtype
        self_.value = value