# MIT LICENSE
#
# Copyright 1997 - 2020 by IXIA Keysight
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE. 
import sys
from ixnetwork_restpy.base import Base
from ixnetwork_restpy.files import Files
if sys.version_info >= (3, 5):
    from typing import List, Any, Union


class AmtGlobals(Base):
    """Global settings placeholder for AMTPlugin.
    The AmtGlobals class encapsulates a list of amtGlobals resources that are managed by the user.
    A list of resources can be retrieved from the server using the AmtGlobals.find() method.
    The list can be managed by using the AmtGlobals.add() and AmtGlobals.remove() methods.
    """

    __slots__ = ()
    _SDM_NAME = 'amtGlobals'
    _SDM_ATT_MAP = {
        'DiscoveryTimeout': 'discoveryTimeout',
        'MaxOutstandingSessions': 'maxOutstandingSessions',
        'MaxRelayDiscoveryRetransmissionCount': 'maxRelayDiscoveryRetransmissionCount',
        'MaxRequestRetransmissionCount': 'maxRequestRetransmissionCount',
        'ObjectId': 'objectId',
        'RequestTimeout': 'requestTimeout',
        'RetransmissionHolddown': 'retransmissionHolddown',
        'SetupRate': 'setupRate',
        'TeardownRate': 'teardownRate',
    }
    _SDM_ENUM_MAP = {
    }

    def __init__(self, parent, list_op=False):
        super(AmtGlobals, self).__init__(parent, list_op)

    @property
    def DiscoveryTimeout(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Initial time to wait for a response to a Relay Discovery message.
        """
        return self._get_attribute(self._SDM_ATT_MAP['DiscoveryTimeout'])
    @DiscoveryTimeout.setter
    def DiscoveryTimeout(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['DiscoveryTimeout'], value)

    @property
    def MaxOutstandingSessions(self):
        # type: () -> int
        """
        Returns
        -------
        - number: This is the point at which AMT Discovery packets will be restricted. AMT Discovery are sent at the configured speed until these are the number of AMT Discovery in progress, without receiving AMT Advertisment messages; at which point new Discovery messages are sent only when other are completed.
        """
        return self._get_attribute(self._SDM_ATT_MAP['MaxOutstandingSessions'])
    @MaxOutstandingSessions.setter
    def MaxOutstandingSessions(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['MaxOutstandingSessions'], value)

    @property
    def MaxRelayDiscoveryRetransmissionCount(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Maximum number of Relay Discovery retransmissions to allow before terminating relay discovery and reporting an error.
        """
        return self._get_attribute(self._SDM_ATT_MAP['MaxRelayDiscoveryRetransmissionCount'])
    @MaxRelayDiscoveryRetransmissionCount.setter
    def MaxRelayDiscoveryRetransmissionCount(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['MaxRelayDiscoveryRetransmissionCount'], value)

    @property
    def MaxRequestRetransmissionCount(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Maximum number of Request retransmissions to allow before abandoning a relay and restarting relay discovery or reporting an error.
        """
        return self._get_attribute(self._SDM_ATT_MAP['MaxRequestRetransmissionCount'])
    @MaxRequestRetransmissionCount.setter
    def MaxRequestRetransmissionCount(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['MaxRequestRetransmissionCount'], value)

    @property
    def ObjectId(self):
        # type: () -> str
        """
        Returns
        -------
        - str: Unique identifier for this object
        """
        return self._get_attribute(self._SDM_ATT_MAP['ObjectId'])

    @property
    def RequestTimeout(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Initial time to wait for a response to a Request message.
        """
        return self._get_attribute(self._SDM_ATT_MAP['RequestTimeout'])
    @RequestTimeout.setter
    def RequestTimeout(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['RequestTimeout'], value)

    @property
    def RetransmissionHolddown(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Number of seconds to wait in hold-down when the maximum number of retries was reached before trying to retransmit message. Applicable for both Relay Discovery and Request messages.
        """
        return self._get_attribute(self._SDM_ATT_MAP['RetransmissionHolddown'])
    @RetransmissionHolddown.setter
    def RetransmissionHolddown(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['RetransmissionHolddown'], value)

    @property
    def SetupRate(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Request Rate is the number of AMT Discovery packets to send in each second.
        """
        return self._get_attribute(self._SDM_ATT_MAP['SetupRate'])
    @SetupRate.setter
    def SetupRate(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['SetupRate'], value)

    @property
    def TeardownRate(self):
        # type: () -> int
        """
        Returns
        -------
        - number: Teardown rate is the number of clients to stop in each second. This value represents the initial value for teardown rate.
        """
        return self._get_attribute(self._SDM_ATT_MAP['TeardownRate'])
    @TeardownRate.setter
    def TeardownRate(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['TeardownRate'], value)

    def update(self, DiscoveryTimeout=None, MaxOutstandingSessions=None, MaxRelayDiscoveryRetransmissionCount=None, MaxRequestRetransmissionCount=None, RequestTimeout=None, RetransmissionHolddown=None, SetupRate=None, TeardownRate=None):
        # type: (int, int, int, int, int, int, int, int) -> AmtGlobals
        """Updates amtGlobals resource on the server.

        Args
        ----
        - DiscoveryTimeout (number): Initial time to wait for a response to a Relay Discovery message.
        - MaxOutstandingSessions (number): This is the point at which AMT Discovery packets will be restricted. AMT Discovery are sent at the configured speed until these are the number of AMT Discovery in progress, without receiving AMT Advertisment messages; at which point new Discovery messages are sent only when other are completed.
        - MaxRelayDiscoveryRetransmissionCount (number): Maximum number of Relay Discovery retransmissions to allow before terminating relay discovery and reporting an error.
        - MaxRequestRetransmissionCount (number): Maximum number of Request retransmissions to allow before abandoning a relay and restarting relay discovery or reporting an error.
        - RequestTimeout (number): Initial time to wait for a response to a Request message.
        - RetransmissionHolddown (number): Number of seconds to wait in hold-down when the maximum number of retries was reached before trying to retransmit message. Applicable for both Relay Discovery and Request messages.
        - SetupRate (number): Request Rate is the number of AMT Discovery packets to send in each second.
        - TeardownRate (number): Teardown rate is the number of clients to stop in each second. This value represents the initial value for teardown rate.

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))

    def add(self, DiscoveryTimeout=None, MaxOutstandingSessions=None, MaxRelayDiscoveryRetransmissionCount=None, MaxRequestRetransmissionCount=None, RequestTimeout=None, RetransmissionHolddown=None, SetupRate=None, TeardownRate=None):
        # type: (int, int, int, int, int, int, int, int) -> AmtGlobals
        """Adds a new amtGlobals resource on the server and adds it to the container.

        Args
        ----
        - DiscoveryTimeout (number): Initial time to wait for a response to a Relay Discovery message.
        - MaxOutstandingSessions (number): This is the point at which AMT Discovery packets will be restricted. AMT Discovery are sent at the configured speed until these are the number of AMT Discovery in progress, without receiving AMT Advertisment messages; at which point new Discovery messages are sent only when other are completed.
        - MaxRelayDiscoveryRetransmissionCount (number): Maximum number of Relay Discovery retransmissions to allow before terminating relay discovery and reporting an error.
        - MaxRequestRetransmissionCount (number): Maximum number of Request retransmissions to allow before abandoning a relay and restarting relay discovery or reporting an error.
        - RequestTimeout (number): Initial time to wait for a response to a Request message.
        - RetransmissionHolddown (number): Number of seconds to wait in hold-down when the maximum number of retries was reached before trying to retransmit message. Applicable for both Relay Discovery and Request messages.
        - SetupRate (number): Request Rate is the number of AMT Discovery packets to send in each second.
        - TeardownRate (number): Teardown rate is the number of clients to stop in each second. This value represents the initial value for teardown rate.

        Returns
        -------
        - self: This instance with all currently retrieved amtGlobals resources using find and the newly added amtGlobals resources available through an iterator or index

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._create(self._map_locals(self._SDM_ATT_MAP, locals()))

    def remove(self):
        """Deletes all the contained amtGlobals resources in this instance from the server.

        Raises
        ------
        - NotFoundError: The requested resource does not exist on the server
        - ServerError: The server has encountered an uncategorized error condition
        """
        self._delete()

    def find(self, DiscoveryTimeout=None, MaxOutstandingSessions=None, MaxRelayDiscoveryRetransmissionCount=None, MaxRequestRetransmissionCount=None, ObjectId=None, RequestTimeout=None, RetransmissionHolddown=None, SetupRate=None, TeardownRate=None):
        # type: (int, int, int, int, str, int, int, int, int) -> AmtGlobals
        """Finds and retrieves amtGlobals resources from the server.

        All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve amtGlobals resources from the server.
        To retrieve an exact match ensure the parameter value starts with ^ and ends with $
        By default the find method takes no parameters and will retrieve all amtGlobals resources from the server.

        Args
        ----
        - DiscoveryTimeout (number): Initial time to wait for a response to a Relay Discovery message.
        - MaxOutstandingSessions (number): This is the point at which AMT Discovery packets will be restricted. AMT Discovery are sent at the configured speed until these are the number of AMT Discovery in progress, without receiving AMT Advertisment messages; at which point new Discovery messages are sent only when other are completed.
        - MaxRelayDiscoveryRetransmissionCount (number): Maximum number of Relay Discovery retransmissions to allow before terminating relay discovery and reporting an error.
        - MaxRequestRetransmissionCount (number): Maximum number of Request retransmissions to allow before abandoning a relay and restarting relay discovery or reporting an error.
        - ObjectId (str): Unique identifier for this object
        - RequestTimeout (number): Initial time to wait for a response to a Request message.
        - RetransmissionHolddown (number): Number of seconds to wait in hold-down when the maximum number of retries was reached before trying to retransmit message. Applicable for both Relay Discovery and Request messages.
        - SetupRate (number): Request Rate is the number of AMT Discovery packets to send in each second.
        - TeardownRate (number): Teardown rate is the number of clients to stop in each second. This value represents the initial value for teardown rate.

        Returns
        -------
        - self: This instance with matching amtGlobals resources retrieved from the server available through an iterator or index

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._select(self._map_locals(self._SDM_ATT_MAP, locals()))

    def read(self, href):
        """Retrieves a single instance of amtGlobals data from the server.

        Args
        ----
        - href (str): An href to the instance to be retrieved

        Returns
        -------
        - self: This instance with the amtGlobals resources from the server available through an iterator or index

        Raises
        ------
        - NotFoundError: The requested resource does not exist on the server
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._read(href)
