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 ixnetwork_restpy.base import Base
  from ixnetwork_restpy.files import Files
  from typing import List, Any, Union
  
  
  class Streams(Base):
      """MSRP Talker level Configuration
      The Streams class encapsulates a list of streams resources that are managed by the user.
      A list of resources can be retrieved from the server using the Streams.find() method.
      The list can be managed by using the Streams.add() and Streams.remove() methods.
      """
  
      __slots__ = ()
      _SDM_NAME = 'streams'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'ActualBandwidth': 'actualBandwidth',
          'ClassMeasurementInterval': 'classMeasurementInterval',
          'ConnectedVia': 'connectedVia',
          'Count': 'count',
          'DataFramePriority': 'dataFramePriority',
          'DescriptiveName': 'descriptiveName',
          'DestinationMac': 'destinationMac',
          'Errors': 'errors',
          'MaxFrameSize': 'maxFrameSize',
          'MaxIntervalFrames': 'maxIntervalFrames',
          'Multiplier': 'multiplier',
          'Name': 'name',
          'PerFrameOverhead': 'perFrameOverhead',
          'PortTcMaxLatency': 'portTcMaxLatency',
          'Rank': 'rank',
          'SessionStatus': 'sessionStatus',
          'SourceMac': 'sourceMac',
          'SrClass': 'srClass',
          'StackedLayers': 'stackedLayers',
          'StateCounts': 'stateCounts',
          'Status': 'status',
          'StreamId': 'streamId',
          'StreamName': 'streamName',
          'UniqueId': 'uniqueId',
          'VlanId': 'vlanId',
      }
      _SDM_ENUM_MAP = {
          'status': ['configured', 'error', 'mixed', 'notStarted', 'started', 'starting', 'stopping'],
      }
  
      def __init__(self, parent, list_op=False):
          super(Streams, self).__init__(parent, list_op)
  
      @property
      def Active(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Activate/Deactivate Configuration
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Active']))
  
      @property
      def ActualBandwidth(self):
          # type: () -> List[str]
          """
          Returns
          -------
          - list(str): Bandwidth (Mbps)
          """
          return self._get_attribute(self._SDM_ATT_MAP['ActualBandwidth'])
  
      @property
      def ClassMeasurementInterval(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Class Measurement Interval (us)
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ClassMeasurementInterval']))
  
      @property
      def ConnectedVia(self):
          # type: () -> List[str]
          """DEPRECATED 
          Returns
          -------
          - list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*]): List of layers this layer is used to connect with to the wire.
          """
          return self._get_attribute(self._SDM_ATT_MAP['ConnectedVia'])
      @ConnectedVia.setter
      def ConnectedVia(self, value):
          # type: (List[str]) -> None
          self._set_attribute(self._SDM_ATT_MAP['ConnectedVia'], value)
  
      @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 DataFramePriority(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): data frame priority of tagged data stream
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['DataFramePriority']))
  
      @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 DestinationMac(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Destination MAC
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['DestinationMac']))
  
      @property
      def Errors(self):
          """
          Returns
          -------
          - list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork//.../*],arg2:list[str])): A list of errors that have occurred
          """
          return self._get_attribute(self._SDM_ATT_MAP['Errors'])
  
      @property
      def MaxFrameSize(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): maximum frame size that talker will produce
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MaxFrameSize']))
  
      @property
      def MaxIntervalFrames(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Maximum number of frames that the talker may transmit in one class measurement interval
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MaxIntervalFrames']))
  
      @property
      def Multiplier(self):
          # type: () -> int
          """
          Returns
          -------
          - number: Number of layer instances per parent instance (multiplier)
          """
          return self._get_attribute(self._SDM_ATT_MAP['Multiplier'])
      @Multiplier.setter
      def Multiplier(self, value):
          # type: (int) -> None
          self._set_attribute(self._SDM_ATT_MAP['Multiplier'], value)
  
      @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 PerFrameOverhead(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Per Frame Overhead (Bytes)
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['PerFrameOverhead']))
  
      @property
      def PortTcMaxLatency(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): maximum latency that is introduced by talker
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['PortTcMaxLatency']))
  
      @property
      def Rank(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Rank of the stream
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Rank']))
  
      @property
      def SessionStatus(self):
          # type: () -> List[str]
          """
          Returns
          -------
          - list(str[down | notStarted | up]): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully.
          """
          return self._get_attribute(self._SDM_ATT_MAP['SessionStatus'])
  
      @property
      def SourceMac(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Source MAC
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SourceMac']))
  
      @property
      def SrClass(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Derived SR Class
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SrClass']))
  
      @property
      def StackedLayers(self):
          # type: () -> List[str]
          """
          Returns
          -------
          - list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*]): List of secondary (many to one) child layer protocols
          """
          return self._get_attribute(self._SDM_ATT_MAP['StackedLayers'])
      @StackedLayers.setter
      def StackedLayers(self, value):
          # type: (List[str]) -> None
          self._set_attribute(self._SDM_ATT_MAP['StackedLayers'], value)
  
      @property
      def StateCounts(self):
          """
          Returns
          -------
          - dict(total:number,notStarted:number,down:number,up:number): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up
          """
          return self._get_attribute(self._SDM_ATT_MAP['StateCounts'])
  
      @property
      def Status(self):
          # type: () -> str
          """
          Returns
          -------
          - str(configured | error | mixed | notStarted | started | starting | stopping): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate.
          """
          return self._get_attribute(self._SDM_ATT_MAP['Status'])
  
      @property
      def StreamId(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): 64 bit stream ID after concatenation of 48 bit source MAC and 16 bit Unique ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['StreamId']))
  
      @property
      def StreamName(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): User friendly name for 64 bit stream ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['StreamName']))
  
      @property
      def UniqueId(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): 16 bit unsigned integer value to distinguish among multiple streams sourced by same talker
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['UniqueId']))
  
      @property
      def VlanId(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): VLAN ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['VlanId']))
  
      def update(self, ConnectedVia=None, Multiplier=None, Name=None, StackedLayers=None):
          # type: (List[str], int, str, List[str]) -> Streams
          """Updates streams 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
          ----
          - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of layers this layer is used to connect with to the wire.
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of secondary (many to one) child layer protocols
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))
  
      def add(self, ConnectedVia=None, Multiplier=None, Name=None, StackedLayers=None):
          # type: (List[str], int, str, List[str]) -> Streams
          """Adds a new streams resource on the server and adds it to the container.
  
          Args
          ----
          - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of layers this layer is used to connect with to the wire.
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of secondary (many to one) child layer protocols
  
          Returns
          -------
          - self: This instance with all currently retrieved streams resources using find and the newly added streams 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 streams 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, ActualBandwidth=None, ConnectedVia=None, Count=None, DescriptiveName=None, Errors=None, Multiplier=None, Name=None, SessionStatus=None, StackedLayers=None, StateCounts=None, Status=None):
          """Finds and retrieves streams resources from the server.
  
          All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve streams 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 streams resources from the server.
  
          Args
          ----
          - ActualBandwidth (list(str)): Bandwidth (Mbps)
          - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of layers this layer is used to connect with to the wire.
          - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group.
          - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context.
          - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork//.../*],arg2:list[str]))): A list of errors that have occurred
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully.
          - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology/.../*])): List of secondary (many to one) child layer protocols
          - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up
          - Status (str(configured | error | mixed | notStarted | started | starting | stopping)): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate.
  
          Returns
          -------
          - self: This instance with matching streams 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 streams data from the server.
  
          Args
          ----
          - href (str): An href to the instance to be retrieved
  
          Returns
          -------
          - self: This instance with the streams 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)
  
      def Abort(self, *args, **kwargs):
          # type: (*Any, **Any) -> None
          """Executes the abort operation on the server.
  
          Abort CPF control plane (equals to demote to kUnconfigured state).
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          abort(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.
  
          abort(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.
  
          abort(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.
  
          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('abort', payload=payload, response_object=None)
  
      def ApplyTSpecToPort(self, *args, **kwargs):
          # type: (*Any, **Any) -> None
          """Executes the applyTSpecToPort operation on the server.
  
          Apply TSpec to Port
  
          applyTSpecToPort(Arg2=string, Arg3=list, async_operation=bool)
          --------------------------------------------------------------
          - Arg2 (str): ID to associate each async action invocation
          - Arg3 (list(number)): List of indices in the grid.
          - 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.
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self.href }
          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('applyTSpecToPort', payload=payload, response_object=None)
  
      def RestartDown(self, *args, **kwargs):
          # type: (*Any, **Any) -> None
          """Executes the restartDown operation on the server.
  
          Stop and start interfaces and sessions that are in Down state.
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          restartDown(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.
  
          restartDown(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.
  
          restartDown(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.
  
          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('restartDown', payload=payload, response_object=None)
  
      def Start(self, *args, **kwargs):
          # type: (*Any, **Any) -> None
          """Executes the start operation on the server.
  
          Start CPF control plane (equals to promote to negotiated state).
  
          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.
  
          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) -> None
          """Executes the stop operation on the server.
  
          Stop CPF control plane (equals to demote to PreValidated-DoDDone state).
  
          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.
  
          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, ClassMeasurementInterval=None, DataFramePriority=None, DestinationMac=None, MaxFrameSize=None, MaxIntervalFrames=None, PerFrameOverhead=None, PortTcMaxLatency=None, Rank=None, SourceMac=None, SrClass=None, StreamId=None, StreamName=None, UniqueId=None, VlanId=None):
          """Base class infrastructure that gets a list of streams 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
          - ClassMeasurementInterval (str): optional regex of classMeasurementInterval
          - DataFramePriority (str): optional regex of dataFramePriority
          - DestinationMac (str): optional regex of destinationMac
          - MaxFrameSize (str): optional regex of maxFrameSize
          - MaxIntervalFrames (str): optional regex of maxIntervalFrames
          - PerFrameOverhead (str): optional regex of perFrameOverhead
          - PortTcMaxLatency (str): optional regex of portTcMaxLatency
          - Rank (str): optional regex of rank
          - SourceMac (str): optional regex of sourceMac
          - SrClass (str): optional regex of srClass
          - StreamId (str): optional regex of streamId
          - StreamName (str): optional regex of streamName
          - UniqueId (str): optional regex of uniqueId
          - VlanId (str): optional regex of vlanId
  
          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())
  