Module mailslurp_client.models.rerun_device_preview_targets_options

MailSlurp API

MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501

The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech

Classes

class RerunDevicePreviewTargetsOptions (target_ids=None, failed_only=None, local_vars_configuration=None)

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

RerunDevicePreviewTargetsOptions - a model defined in OpenAPI

Expand source code

class RerunDevicePreviewTargetsOptions(object):
    """NOTE: This class is auto generated by OpenAPI Generator.
    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'target_ids': 'list[str]',
        'failed_only': 'bool'
    }

    attribute_map = {
        'target_ids': 'targetIds',
        'failed_only': 'failedOnly'
    }

    def __init__(self, target_ids=None, failed_only=None, local_vars_configuration=None):  # noqa: E501
        """RerunDevicePreviewTargetsOptions - a model defined in OpenAPI"""  # noqa: E501
        if local_vars_configuration is None:
            local_vars_configuration = Configuration()
        self.local_vars_configuration = local_vars_configuration

        self._target_ids = None
        self._failed_only = None
        self.discriminator = None

        self.target_ids = target_ids
        self.failed_only = failed_only

    @property
    def target_ids(self):
        """Gets the target_ids of this RerunDevicePreviewTargetsOptions.  # noqa: E501

        Device preview target IDs to rerun within the existing run. Use target IDs from DevicePreviewRunResultsDto.targets.  # noqa: E501

        :return: The target_ids of this RerunDevicePreviewTargetsOptions.  # noqa: E501
        :rtype: list[str]
        """
        return self._target_ids

    @target_ids.setter
    def target_ids(self, target_ids):
        """Sets the target_ids of this RerunDevicePreviewTargetsOptions.

        Device preview target IDs to rerun within the existing run. Use target IDs from DevicePreviewRunResultsDto.targets.  # noqa: E501

        :param target_ids: The target_ids of this RerunDevicePreviewTargetsOptions.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and target_ids is None:  # noqa: E501
            raise ValueError("Invalid value for `target_ids`, must not be `None`")  # noqa: E501

        self._target_ids = target_ids

    @property
    def failed_only(self):
        """Gets the failed_only of this RerunDevicePreviewTargetsOptions.  # noqa: E501

        When true, only selected targets in failed terminal states are rerun. Set false to rerun any selected target; a target that already completed successfully uses its credit cost again. Defaults to true.  # noqa: E501

        :return: The failed_only of this RerunDevicePreviewTargetsOptions.  # noqa: E501
        :rtype: bool
        """
        return self._failed_only

    @failed_only.setter
    def failed_only(self, failed_only):
        """Sets the failed_only of this RerunDevicePreviewTargetsOptions.

        When true, only selected targets in failed terminal states are rerun. Set false to rerun any selected target; a target that already completed successfully uses its credit cost again. Defaults to true.  # noqa: E501

        :param failed_only: The failed_only of this RerunDevicePreviewTargetsOptions.  # noqa: E501
        :type: bool
        """
        if self.local_vars_configuration.client_side_validation and failed_only is None:  # noqa: E501
            raise ValueError("Invalid value for `failed_only`, must not be `None`")  # noqa: E501

        self._failed_only = failed_only

    def to_dict(self):
        """Returns the model properties as a dict"""
        result = {}

        for attr, _ in six.iteritems(self.openapi_types):
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Returns the string representation of the model"""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`"""
        return self.to_str()

    def __eq__(self, other):
        """Returns true if both objects are equal"""
        if not isinstance(other, RerunDevicePreviewTargetsOptions):
            return False

        return self.to_dict() == other.to_dict()

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        if not isinstance(other, RerunDevicePreviewTargetsOptions):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop failed_only

Gets the failed_only of this RerunDevicePreviewTargetsOptions. # noqa: E501

When true, only selected targets in failed terminal states are rerun. Set false to rerun any selected target; a target that already completed successfully uses its credit cost again. Defaults to true. # noqa: E501

:return: The failed_only of this RerunDevicePreviewTargetsOptions. # noqa: E501 :rtype: bool

Expand source code

@property
def failed_only(self):
    """Gets the failed_only of this RerunDevicePreviewTargetsOptions.  # noqa: E501

    When true, only selected targets in failed terminal states are rerun. Set false to rerun any selected target; a target that already completed successfully uses its credit cost again. Defaults to true.  # noqa: E501

    :return: The failed_only of this RerunDevicePreviewTargetsOptions.  # noqa: E501
    :rtype: bool
    """
    return self._failed_only

prop target_ids

Gets the target_ids of this RerunDevicePreviewTargetsOptions. # noqa: E501

Device preview target IDs to rerun within the existing run. Use target IDs from DevicePreviewRunResultsDto.targets. # noqa: E501

:return: The target_ids of this RerunDevicePreviewTargetsOptions. # noqa: E501 :rtype: list[str]

Expand source code

@property
def target_ids(self):
    """Gets the target_ids of this RerunDevicePreviewTargetsOptions.  # noqa: E501

    Device preview target IDs to rerun within the existing run. Use target IDs from DevicePreviewRunResultsDto.targets.  # noqa: E501

    :return: The target_ids of this RerunDevicePreviewTargetsOptions.  # noqa: E501
    :rtype: list[str]
    """
    return self._target_ids

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model