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 FlowSet(Base):
      """Flow Set Configuration
      The FlowSet class encapsulates a list of flowSet resources that are managed by the system.
      A list of resources can be retrieved from the server using the FlowSet.find() method.
      """
  
      __slots__ = ()
      _SDM_NAME = 'flowSet'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'Cookie': 'cookie',
          'CookieMask': 'cookieMask',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'FlowAdvertise': 'flowAdvertise',
          'FlowFlags': 'flowFlags',
          'FlowMatchType': 'flowMatchType',
          'FlowSetId': 'flowSetId',
          'HardTimeout': 'hardTimeout',
          'IdleTimeout': 'idleTimeout',
          'Name': 'name',
          'NumberOfFlows': 'numberOfFlows',
          'Priority': 'priority',
      }
      _SDM_ENUM_MAP = {
      }
  
      def __init__(self, parent, list_op=False):
          super(FlowSet, self).__init__(parent, list_op)
  
      @property
      def FlowProfile(self):
          """
          Returns
          -------
          - obj(uhd_restpy.testplatform.sessions.ixnetwork.topology.flowprofile_a1f78cfc247b918e0d8219ac19d05f87.FlowProfile): An instance of the FlowProfile class
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          from uhd_restpy.testplatform.sessions.ixnetwork.topology.flowprofile_a1f78cfc247b918e0d8219ac19d05f87 import FlowProfile
          if self._properties.get('FlowProfile', None) is not None:
              return self._properties.get('FlowProfile')
          else:
              return FlowProfile(self)._select()
  
      @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 Cookie(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Cookie of the flow entry that was looked up. This is the opaque controller-issued identifier.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Cookie']))
  
      @property
      def CookieMask(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): The mask used to restrict the cookie bits.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['CookieMask']))
  
      @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 FlowAdvertise(self):
          # type: () -> bool
          """
          Returns
          -------
          - bool: If selected, the flows are advertised by the OF Channel.
          """
          return self._get_attribute(self._SDM_ATT_MAP['FlowAdvertise'])
      @FlowAdvertise.setter
      def FlowAdvertise(self, value):
          # type: (bool) -> None
          self._set_attribute(self._SDM_ATT_MAP['FlowAdvertise'], value)
  
      @property
      def FlowFlags(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Allows to configure the Flow Flags. Options are: 1) Send Flow Removed 2) Check Overlap 3) Reset Counts 4) No Packet Count 5) No Byte Count
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['FlowFlags']))
  
      @property
      def FlowMatchType(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): The type of match to be configured. Options include the following: 1) Strict 2) Loose
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['FlowMatchType']))
  
      @property
      def FlowSetId(self):
          # type: () -> str
          """
          Returns
          -------
          - str: Specify the controller Flow Set identifier.
          """
          return self._get_attribute(self._SDM_ATT_MAP['FlowSetId'])
      @FlowSetId.setter
      def FlowSetId(self, value):
          # type: (str) -> None
          self._set_attribute(self._SDM_ATT_MAP['FlowSetId'], value)
  
      @property
      def HardTimeout(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): The inactive time in seconds after which the Flow range will hard timeout and close.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['HardTimeout']))
  
      @property
      def IdleTimeout(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): The inactive time in seconds after which the Flow range will timeout and become idle.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['IdleTimeout']))
  
      @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 NumberOfFlows(self):
          # type: () -> int
          """
          Returns
          -------
          - number: The number of flows to be configured for the controller table.
          """
          return self._get_attribute(self._SDM_ATT_MAP['NumberOfFlows'])
      @NumberOfFlows.setter
      def NumberOfFlows(self, value):
          # type: (int) -> None
          self._set_attribute(self._SDM_ATT_MAP['NumberOfFlows'], value)
  
      @property
      def Priority(self):
          # type: () -> 'Multivalue'
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): The priority level for the Flow Range.
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Priority']))
  
      def update(self, FlowAdvertise=None, FlowSetId=None, Name=None, NumberOfFlows=None):
          # type: (bool, str, str, int) -> FlowSet
          """Updates flowSet 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
          ----
          - FlowAdvertise (bool): If selected, the flows are advertised by the OF Channel.
          - FlowSetId (str): Specify the controller Flow Set identifier.
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - NumberOfFlows (number): The number of flows to be configured for the controller table.
  
          Raises
          ------
          - ServerError: The server has encountered an uncategorized error condition
          """
          return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))
  
      def add(self, FlowAdvertise=None, FlowSetId=None, Name=None, NumberOfFlows=None):
          # type: (bool, str, str, int) -> FlowSet
          """Adds a new flowSet resource on the json, only valid with config assistant
  
          Args
          ----
          - FlowAdvertise (bool): If selected, the flows are advertised by the OF Channel.
          - FlowSetId (str): Specify the controller Flow Set identifier.
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - NumberOfFlows (number): The number of flows to be configured for the controller table.
  
          Returns
          -------
          - self: This instance with all currently retrieved flowSet resources using find and the newly added flowSet resources available through an iterator or index
  
          Raises
          ------
          - Exception: if this function is not being used with config assistance
          """
          return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals()))
  
      def find(self, Count=None, DescriptiveName=None, FlowAdvertise=None, FlowSetId=None, Name=None, NumberOfFlows=None):
          # type: (int, str, bool, str, str, int) -> FlowSet
          """Finds and retrieves flowSet resources from the server.
  
          All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve flowSet 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 flowSet resources from the server.
  
          Args
          ----
          - 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.
          - FlowAdvertise (bool): If selected, the flows are advertised by the OF Channel.
          - FlowSetId (str): Specify the controller Flow Set identifier.
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - NumberOfFlows (number): The number of flows to be configured for the controller table.
  
          Returns
          -------
          - self: This instance with matching flowSet 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 flowSet data from the server.
  
          Args
          ----
          - href (str): An href to the instance to be retrieved
  
          Returns
          -------
          - self: This instance with the flowSet 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 get_device_ids(self, PortNames=None, Active=None, Cookie=None, CookieMask=None, FlowFlags=None, FlowMatchType=None, HardTimeout=None, IdleTimeout=None, Priority=None):
          """Base class infrastructure that gets a list of flowSet 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
          - Cookie (str): optional regex of cookie
          - CookieMask (str): optional regex of cookieMask
          - FlowFlags (str): optional regex of flowFlags
          - FlowMatchType (str): optional regex of flowMatchType
          - HardTimeout (str): optional regex of hardTimeout
          - IdleTimeout (str): optional regex of idleTimeout
          - Priority (str): optional regex of priority
  
          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())
  