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
  
  
  class IsisSegmentList(Base):
      """ISIS MPLS SR Tunnel Segments
      The IsisSegmentList class encapsulates a list of isisSegmentList resources that are managed by the system.
      A list of resources can be retrieved from the server using the IsisSegmentList.find() method.
      """
  
      __slots__ = ()
      _SDM_NAME = 'isisSegmentList'
      _SDM_ATT_MAP = {
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'Enable': 'enable',
          'Name': 'name',
          'NeighbournodeSystemID': 'neighbournodeSystemID',
          'NodeSystemID': 'nodeSystemID',
          'SegmentType': 'segmentType',
      }
  
      def __init__(self, parent):
          super(IsisSegmentList, self).__init__(parent)
  
      @property
      def Count(self):
          """
          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):
          """
          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 Enable(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Enable
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Enable']))
  
      @property
      def Name(self):
          """
          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):
          self._set_attribute(self._SDM_ATT_MAP['Name'], value)
  
      @property
      def NeighbournodeSystemID(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Neighbour Node System ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['NeighbournodeSystemID']))
  
      @property
      def NodeSystemID(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Node System ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['NodeSystemID']))
  
      @property
      def SegmentType(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Segment Type
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SegmentType']))
  
      def update(self, Name=None):
          """Updates isisSegmentList 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 find(self, Count=None, DescriptiveName=None, Name=None):
          """Finds and retrieves isisSegmentList resources from the server.
  
          All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve isisSegmentList 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 isisSegmentList 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.
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
  
          Returns
          -------
          - self: This instance with matching isisSegmentList 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 isisSegmentList data from the server.
  
          Args
          ----
          - href (str): An href to the instance to be retrieved
  
          Returns
          -------
          - self: This instance with the isisSegmentList 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, Enable=None, NeighbournodeSystemID=None, NodeSystemID=None, SegmentType=None):
          """Base class infrastructure that gets a list of isisSegmentList 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
          - Enable (str): optional regex of enable
          - NeighbournodeSystemID (str): optional regex of neighbournodeSystemID
          - NodeSystemID (str): optional regex of nodeSystemID
          - SegmentType (str): optional regex of segmentType
  
          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())
  