text: # 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. 
  from uhd_restpy.base import Base
  from uhd_restpy.files import Files
  from typing import List, Any, Union
  
  
  class MsrpTalkerDomains(Base):
      """Domains Informations for Msrp Talker
      The MsrpTalkerDomains class encapsulates a required msrpTalkerDomains resource which will be retrieved from the server every time the property is accessed.
      """
  
      __slots__ = ()
      _SDM_NAME = 'msrpTalkerDomains'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'Name': 'name',
          'SrClassIdType': 'srClassIdType',
          'SrClassPriorityType': 'srClassPriorityType',
          'SrClassVid': 'srClassVid',
      }
      _SDM_ENUM_MAP = {
      }
  
      def __init__(self, parent, list_op=False):
          super(MsrpTalkerDomains, self).__init__(parent, list_op)
  
      @property
      def Active(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Activate/Deactivate Configuration.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Active']))
  
      @property
      def Count(self):
          # type: () -> int
          """
          Returns
          -------
          - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group.
          """
          return self._get_attribute(self._SDM_ATT_MAP['Count'])
  
      @property
      def DescriptiveName(self):
          # type: () -> str
          """
          Returns
          -------
          - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context.
          """
          return self._get_attribute(self._SDM_ATT_MAP['DescriptiveName'])
  
      @property
      def Name(self):
          # type: () -> str
          """
          Returns
          -------
          - str: Name of NGPF element, guaranteed to be unique in Scenario
          """
          return self._get_attribute(self._SDM_ATT_MAP['Name'])
      @Name.setter
      def Name(self, value):
          # type: (str) -> None
          self._set_attribute(self._SDM_ATT_MAP['Name'], value)
  
      @property
      def SrClassIdType(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): SR Class ID
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SrClassIdType']))
  
      @property
      def SrClassPriorityType(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): SR Class Priority.Class A maps to priority 3 and Class B maps to priority 2.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SrClassPriorityType']))
  
      @property
      def SrClassVid(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): VLAN ID that associated streams will be tagged with by Talker
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SrClassVid']))
  
      def update(self, Name=None):
          # type: (str) -> MsrpTalkerDomains
          """Updates msrpTalkerDomains resource on the server.
  
          This method has some named parameters with a type: obj (Multivalue).
          The Multivalue class has documentation that details the possible values for those named parameters.
  
          Args
          ----
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))
  
      def Start(self, *args, **kwargs):
          # type: (*Any, **Any) -> Union[List[str], None]
          """Executes the start operation on the server.
  
          Start MSRP Talker Domain
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          start(async_operation=bool)
          ---------------------------
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          start(SessionIndices=list, async_operation=bool)
          ------------------------------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          start(SessionIndices=string, async_operation=bool)
          --------------------------------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          start(Arg2=list, async_operation=bool)list
          ------------------------------------------
          - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin.
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
          - Returns list(str): ID to associate each async action invocation
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self }
          for i in range(len(args)): payload['Arg%s' % (i + 2)] = args[i]
          for item in kwargs.items(): payload[item[0]] = item[1]
          return self._execute('start', payload=payload, response_object=None)
  
      def Stop(self, *args, **kwargs):
          # type: (*Any, **Any) -> Union[List[str], None]
          """Executes the stop operation on the server.
  
          Stop MSRP Talker Domain
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          stop(async_operation=bool)
          --------------------------
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          stop(SessionIndices=list, async_operation=bool)
          -----------------------------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          stop(SessionIndices=string, async_operation=bool)
          -------------------------------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
  
          stop(Arg2=list, async_operation=bool)list
          -----------------------------------------
          - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin.
          - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete.
          - Returns list(str): ID to associate each async action invocation
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self }
          for i in range(len(args)): payload['Arg%s' % (i + 2)] = args[i]
          for item in kwargs.items(): payload[item[0]] = item[1]
          return self._execute('stop', payload=payload, response_object=None)
  
      def get_device_ids(self, PortNames=None, Active=None, SrClassIdType=None, SrClassPriorityType=None, SrClassVid=None):
          """Base class infrastructure that gets a list of msrpTalkerDomains device ids encapsulated by this object.
  
          Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object.
  
          Args
          ----
          - PortNames (str): optional regex of port names
          - Active (str): optional regex of active
          - SrClassIdType (str): optional regex of srClassIdType
          - SrClassPriorityType (str): optional regex of srClassPriorityType
          - SrClassVid (str): optional regex of srClassVid
  
          Returns
          -------
          - list(int): A list of device ids that meets the regex criteria provided in the method parameters
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._get_ngpf_device_ids(locals())
  