Class Network_FS_Parameters

    • Field Detail

      • json_template_name

        public static java.lang.String json_template_name
        The template toJSON uses.
      • JSON_ADDRESS_SPACE

        public static final java.lang.String JSON_ADDRESS_SPACE
        See Also:
        Constant Field Values
      • JSON_ADDRESS_SPACE_COMMENT

        public static final java.lang.String JSON_ADDRESS_SPACE_COMMENT
        See Also:
        Constant Field Values
      • JSON_ADDRESS_SPACE_DHCP_SETTING

        public static final java.lang.String JSON_ADDRESS_SPACE_DHCP_SETTING
        See Also:
        Constant Field Values
      • JSON_ADDRESS_SPACE_GROUP

        public static final java.lang.String JSON_ADDRESS_SPACE_GROUP
        See Also:
        Constant Field Values
      • JSON_DHCP_ADDRESS

        public static final java.lang.String JSON_DHCP_ADDRESS
        See Also:
        Constant Field Values
      • JSON_DHCP_ADDRESS_ACTIVE

        public static final java.lang.String JSON_DHCP_ADDRESS_ACTIVE
        See Also:
        Constant Field Values
      • JSON_DHCP_ADDRESS_NAME

        public static final java.lang.String JSON_DHCP_ADDRESS_NAME
        See Also:
        Constant Field Values
      • JSON_DHCP_SERVICE

        public static final java.lang.String JSON_DHCP_SERVICE
        See Also:
        Constant Field Values
      • JSON_NETWORK_DHCP_SETTING

        public static final java.lang.String JSON_NETWORK_DHCP_SETTING
        See Also:
        Constant Field Values
      • JSON_INCLUDE_ADDRESS_SPACE

        public static final java.lang.String JSON_INCLUDE_ADDRESS_SPACE
        See Also:
        Constant Field Values
      • JSON_INCLUDE_ADDRESS_SPACE_COMMENT

        public static final java.lang.String JSON_INCLUDE_ADDRESS_SPACE_COMMENT
        See Also:
        Constant Field Values
      • JSON_INCLUDE_ADDRESS_SPACE_DHCP_SETTING

        public static final java.lang.String JSON_INCLUDE_ADDRESS_SPACE_DHCP_SETTING
        See Also:
        Constant Field Values
      • JSON_INCLUDE_ADDRESS_SPACE_GROUP

        public static final java.lang.String JSON_INCLUDE_ADDRESS_SPACE_GROUP
        See Also:
        Constant Field Values
      • JSON_INCLUDE_CODE

        public static final java.lang.String JSON_INCLUDE_CODE
        See Also:
        Constant Field Values
      • JSON_INCLUDE_DHCP_ADDRESS

        public static final java.lang.String JSON_INCLUDE_DHCP_ADDRESS
        See Also:
        Constant Field Values
      • JSON_INCLUDE_DHCP_ADDRESS_ACTIVE

        public static final java.lang.String JSON_INCLUDE_DHCP_ADDRESS_ACTIVE
        See Also:
        Constant Field Values
      • JSON_INCLUDE_DHCP_ADDRESS_NAME

        public static final java.lang.String JSON_INCLUDE_DHCP_ADDRESS_NAME
        See Also:
        Constant Field Values
      • JSON_INCLUDE_DHCP_SERVICE

        public static final java.lang.String JSON_INCLUDE_DHCP_SERVICE
        See Also:
        Constant Field Values
      • JSON_INCLUDE_HIGH_RES

        public static final java.lang.String JSON_INCLUDE_HIGH_RES
        See Also:
        Constant Field Values
      • JSON_INCLUDE_LOCATION

        public static final java.lang.String JSON_INCLUDE_LOCATION
        See Also:
        Constant Field Values
      • JSON_INCLUDE_LOW_RES

        public static final java.lang.String JSON_INCLUDE_LOW_RES
        See Also:
        Constant Field Values
      • JSON_INCLUDE_NAME

        public static final java.lang.String JSON_INCLUDE_NAME
        See Also:
        Constant Field Values
      • JSON_INCLUDE_NETWORK_DHCP_SETTING

        public static final java.lang.String JSON_INCLUDE_NETWORK_DHCP_SETTING
        See Also:
        Constant Field Values
      • JSON_INCLUDE_SITE

        public static final java.lang.String JSON_INCLUDE_SITE
        See Also:
        Constant Field Values
      • JSON_INCLUDE_VLAN

        public static final java.lang.String JSON_INCLUDE_VLAN
        See Also:
        Constant Field Values
      • JSON_INCLUDE_VLAN_AREA

        public static final java.lang.String JSON_INCLUDE_VLAN_AREA
        See Also:
        Constant Field Values
      • JSON_INCLUDE_ALL_FIELDS

        public static final java.lang.String[] JSON_INCLUDE_ALL_FIELDS
        When 'include all' is used, these are the fields that will be set to true.
    • Constructor Detail

      • Network_FS_Parameters

        public Network_FS_Parameters()
    • Method Detail

      • name

        public java.lang.String name()
        Fetch the search value for the name.
      • include_name

        public java.lang.Boolean include_name()
        Fetch whether or not names will be included in the search result.
      • location

        public java.lang.String location()
        Fetch the search value for the location.
      • include_location

        public java.lang.Boolean include_location()
        Fetch whether or not locations will be included in the search result.
      • site

        public java.lang.String site()
        Fetch the search value for the site.
      • include_site

        public java.lang.Boolean include_site()
        Fetch whether or not sites will be included in the search result.
      • code

        public java.lang.String code()
        Fetch the search value for the code.
      • include_code

        public java.lang.Boolean include_code()
        Fetch whether or not codes will be included in the search result.
      • address_space

        public java.lang.String address_space()
        Fetch the search value for the address space prefix.
      • include_address_space

        public java.lang.Boolean include_address_space()
        Fetch whether or not address space prefixes will be included in the search result.
      • DHCP_service

        public java.lang.String DHCP_service()
        Alias for dhcp_service ().
      • dhcp_service

        public java.lang.String dhcp_service()
        Fetch the search value for the dhcp_service.
      • include_DHCP_service

        public java.lang.Boolean include_DHCP_service()
        Alias for include_dhcp_service ().
      • include_dhcp_service

        public java.lang.Boolean include_dhcp_service()
        Fetch whether or not dhcp dhcp_services will be included in the search result.
      • network_DHCP_setting

        public java.lang.String network_DHCP_setting()
        Alias for network_dhcp_setting ().
      • network_dhcp_setting

        public java.lang.String network_dhcp_setting()
        Fetch the search value for the network dhcp settings.
      • include_network_DHCP_setting

        public java.lang.Boolean include_network_DHCP_setting()
        Alias for include_network_dhcp_setting ().
      • include_network_dhcp_setting

        public java.lang.Boolean include_network_dhcp_setting()
        Fetch whether or not network dhcp settingss will be included in the search result.
      • VLAN

        public java.lang.String VLAN()
        Alias for vlan ().
      • vlan

        public java.lang.String vlan()
        Fetch the search value for the vlan.
      • include_VLAN

        public java.lang.Boolean include_VLAN()
        Alias for include_vlan ().
      • include_vlan

        public java.lang.Boolean include_vlan()
        Fetch whether or not vlan will be included in the search result.
      • VLAN_Area

        public java.lang.String VLAN_Area()
        Alias for vlan_area ().
      • vlan_area

        public java.lang.String vlan_area()
        Fetch the search value for the vlan_area.
      • include_VLAN_Area

        public java.lang.Boolean include_VLAN_Area()
        Alias for include_vlan_area ().
      • include_vlan_area

        public java.lang.Boolean include_vlan_area()
        Fetch whether or not vlan_area will be included in the search result.
      • address_space_DHCP_setting

        public java.lang.String address_space_DHCP_setting()
        Alias for address_space_dhcp_setting ().
      • address_space_dhcp_setting

        public java.lang.String address_space_dhcp_setting()
        Fetch the search value for the address space dhcp settings.
      • include_address_space_DHCP_setting

        public java.lang.Boolean include_address_space_DHCP_setting()
        Alias for include_address_space_dhcp_setting ().
      • include_address_space_dhcp_setting

        public java.lang.Boolean include_address_space_dhcp_setting()
        Fetch whether or not address space dhcp dhcp_settings will be included in the search result.
      • address_space_group

        public java.lang.String address_space_group()
        Fetch the search value for the address space group.
      • include_address_space_group

        public java.lang.Boolean include_address_space_group()
        Fetch whether or not address space groups will be included in the search result.
      • address_space_comment

        public java.lang.String address_space_comment()
        Fetch the search value for the address space comments.
      • include_address_space_comment

        public java.lang.Boolean include_address_space_comment()
        Fetch whether or not address space comments will be included in the search result.
      • DHCP_address

        public java.lang.String DHCP_address()
        Alias for dhcp_address ().
      • dhcp_address

        public java.lang.String dhcp_address()
        Fetch the search value for the dhcp addresses.
      • include_DHCP_address

        public java.lang.Boolean include_DHCP_address()
        Alias for include_dhcp_address ().
      • include_dhcp_address

        public java.lang.Boolean include_dhcp_address()
        Fetch whether or not dhcp addresses will be included in the search result.
      • DHCP_address_name

        public java.lang.String DHCP_address_name()
        Alias for dhcp_address_name ().
      • dhcp_address_name

        public java.lang.String dhcp_address_name()
        Fetch the search value for the dhcp address names.
      • include_DHCP_address_name

        public java.lang.Boolean include_DHCP_address_name()
        Alias for include_dhcp_address_name ().
      • include_dhcp_address_name

        public java.lang.Boolean include_dhcp_address_name()
        Fetch whether or not dhcp address names will be included in the search result.
      • DHCP_address_active

        public java.lang.Boolean DHCP_address_active()
        Alias for dhcp_address_active ().
      • dhcp_address_active

        public java.lang.Boolean dhcp_address_active()
        Fetch the search value for the dhcp address active state.
      • include_DHCP_address_active

        public java.lang.Boolean include_DHCP_address_active()
        Alias for include_dhcp_address_active ().
      • include_dhcp_address_active

        public java.lang.Boolean include_dhcp_address_active()
        Fetch whether or not dhcp address active state will be included in the search result.
      • include_low_res

        public java.lang.Boolean include_low_res()
        Fetch whether or not low reserves will be included in the search result.
      • include_high_res

        public java.lang.Boolean include_high_res()
        Fetch whether or not high reserves will be included in the search result.
      • name

        public Network_FS_Parameters name​(java.lang.String name,
                                          java.lang.Boolean include_data)
        Set the search value for name and whether or not it will be included in the search result.
      • include_name

        public Network_FS_Parameters include_name​(java.lang.Boolean include_data)
        Set whether or not names will be included in the search result.
      • location

        public Network_FS_Parameters location​(java.lang.String location)
        Set the search value for location.
      • location

        public Network_FS_Parameters location​(java.lang.String location,
                                              java.lang.Boolean include_data)
        Set the search value for location and whether or not it will be included in the search result.
      • include_location

        public Network_FS_Parameters include_location​(java.lang.Boolean include_data)
        Set whether or not locations will be included in the search result.
      • site

        public Network_FS_Parameters site​(java.lang.String site,
                                          java.lang.Boolean include_data)
        Set the search value for site and whether or not it will be included in the search result.
      • include_site

        public Network_FS_Parameters include_site​(java.lang.Boolean include_data)
        Set whether or not sites will be included in the search result.
      • code

        public Network_FS_Parameters code​(java.lang.String code,
                                          java.lang.Boolean include_data)
        Set the search value for code and whether or not it will be included in the search result.
      • include_code

        public Network_FS_Parameters include_code​(java.lang.Boolean include_data)
        Set whether or not codes will be included in the search result.
      • address_space

        public Network_FS_Parameters address_space​(java.lang.String address_space)
        Set the search value for address_space.
      • address_space

        public Network_FS_Parameters address_space​(java.lang.String address_space,
                                                   java.lang.Boolean include_data)
        Set the search value for address_space and whether or not it will be included in the search result.
      • include_address_space

        public Network_FS_Parameters include_address_space​(java.lang.Boolean include_data)
        Set whether or not address spaces will be included in the search result.
      • DHCP_service

        public Network_FS_Parameters DHCP_service​(java.lang.String service)
        Alias for dhcp_service (...).
      • dhcp_service

        public Network_FS_Parameters dhcp_service​(java.lang.String dhcp_service)
        Set the search value for dhcp_service.
      • DHCP_service

        public Network_FS_Parameters DHCP_service​(java.lang.String service,
                                                  java.lang.Boolean include_data)
        Alias for dhcp_service (...).
      • dhcp_service

        public Network_FS_Parameters dhcp_service​(java.lang.String dhcp_service,
                                                  java.lang.Boolean include_data)
        Set the search value for dhcp_service and whether or not it will be included in the search result.
      • include_DHCP_service

        public Network_FS_Parameters include_DHCP_service​(java.lang.Boolean include_data)
        Alias for include_dhcp_service (...).
      • include_dhcp_service

        public Network_FS_Parameters include_dhcp_service​(java.lang.Boolean include_data)
        Set whether or not dhcp_services will be included in the search result.
      • network_DHCP_setting

        public Network_FS_Parameters network_DHCP_setting​(java.lang.String dhcp_setting)
        Alias for network_dhcp_setting (...).
      • network_dhcp_setting

        public Network_FS_Parameters network_dhcp_setting​(java.lang.String network_dhcp_setting)
        Set the search value for network_dhcp_setting.
      • network_DHCP_setting

        public Network_FS_Parameters network_DHCP_setting​(java.lang.String dhcp_setting,
                                                          java.lang.Boolean include_data)
        Alias for network_dhcp_setting (...).
      • network_dhcp_setting

        public Network_FS_Parameters network_dhcp_setting​(java.lang.String network_dhcp_setting,
                                                          java.lang.Boolean include_data)
        Set the search value for network_dhcp_setting and whether or not it will be included in the search result.
      • include_network_DHCP_setting

        public Network_FS_Parameters include_network_DHCP_setting​(java.lang.Boolean include_data)
        Alias for include_network_dhcp_setting (...).
      • include_network_dhcp_setting

        public Network_FS_Parameters include_network_dhcp_setting​(java.lang.Boolean include_data)
        Set whether or not network FHCP dhcp_settings will be included in the search result.
      • VLAN

        public Network_FS_Parameters VLAN​(java.lang.String vlan,
                                          java.lang.Boolean include_data)
        Alias for vlan (...).
      • vlan

        public Network_FS_Parameters vlan​(java.lang.String vlan,
                                          java.lang.Boolean include_data)
        Set the search value for vlan and whether or not it will be included in the search result.
      • include_VLAN

        public Network_FS_Parameters include_VLAN​(java.lang.Boolean include_data)
        Alias for include_vlan (...).
      • include_vlan

        public Network_FS_Parameters include_vlan​(java.lang.Boolean include_data)
        Set whether or not vlans will be included in the search result.
      • VLAN_Area

        public Network_FS_Parameters VLAN_Area​(java.lang.String vlan_area)
        Alias for vlan_area (...).
      • vlan_area

        public Network_FS_Parameters vlan_area​(java.lang.String vlan_area)
        Set the search value for vlan_area.
      • VLAN_Area

        public Network_FS_Parameters VLAN_Area​(java.lang.String vlan_area,
                                               java.lang.Boolean include_data)
        Alias for vlan_area (...).
      • vlan_area

        public Network_FS_Parameters vlan_area​(java.lang.String vlan_area,
                                               java.lang.Boolean include_data)
        Set the search value for vlan_area and whether or not it will be included in the search result.
      • include_VLAN_Area

        public Network_FS_Parameters include_VLAN_Area​(java.lang.Boolean include_data)
        Alias for include_vlan_area (...).
      • include_vlan_area

        public Network_FS_Parameters include_vlan_area​(java.lang.Boolean include_data)
        Set whether or not vlan_areas will be included in the search result.
      • address_space_DHCP_setting

        public Network_FS_Parameters address_space_DHCP_setting​(java.lang.String dhcp_setting)
        Alias for address_space_dhcp_setting (...).
      • address_space_dhcp_setting

        public Network_FS_Parameters address_space_dhcp_setting​(java.lang.String address_space_dhcp_setting)
        Set the search value for address_space_dhcp_setting.
      • address_space_DHCP_setting

        public Network_FS_Parameters address_space_DHCP_setting​(java.lang.String dhcp_setting,
                                                                java.lang.Boolean include_data)
        Alias for address_space_dhcp_setting (...).
      • address_space_dhcp_setting

        public Network_FS_Parameters address_space_dhcp_setting​(java.lang.String address_space_dhcp_setting,
                                                                java.lang.Boolean include_data)
        Set the search value for address_space_dhcp_setting and whether or not it will be included in the search result.
      • include_address_space_DHCP_setting

        public Network_FS_Parameters include_address_space_DHCP_setting​(java.lang.Boolean include_data)
        Alias for include_address_space_dhcp_setting (...).
      • include_address_space_dhcp_setting

        public Network_FS_Parameters include_address_space_dhcp_setting​(java.lang.Boolean include_data)
        Set whether or not address space DHCP dhcp_settings will be included in the search result.
      • address_space_group

        public Network_FS_Parameters address_space_group​(java.lang.String address_space_group)
        Set the search value for address_space_group.
      • address_space_group

        public Network_FS_Parameters address_space_group​(java.lang.String address_space_group,
                                                         java.lang.Boolean include_data)
        Set the search value for address_space_group and whether or not it will be included in the search result.
      • include_address_space_group

        public Network_FS_Parameters include_address_space_group​(java.lang.Boolean include_data)
        Set whether or not address space groups will be included in the search result.
      • address_space_comment

        public Network_FS_Parameters address_space_comment​(java.lang.String address_space_comment)
        Set the search value for address_space_comment.
      • address_space_comment

        public Network_FS_Parameters address_space_comment​(java.lang.String address_space_comment,
                                                           java.lang.Boolean include_data)
        Set the search value for address_space_comment and whether or not it will be included in the search result.
      • include_address_space_comment

        public Network_FS_Parameters include_address_space_comment​(java.lang.Boolean include_data)
        Set whether or not address space comments will be included in the search result.
      • DHCP_address

        public Network_FS_Parameters DHCP_address​(java.lang.String address)
        Alias for dhcp_address (...).
      • dhcp_address

        public Network_FS_Parameters dhcp_address​(java.lang.String dhcp_address)
        Set the search value for dhcp_address.
      • DHCP_address

        public Network_FS_Parameters DHCP_address​(java.lang.String address,
                                                  java.lang.Boolean include_data)
        Alias for dhcp_address (...).
      • dhcp_address

        public Network_FS_Parameters dhcp_address​(java.lang.String dhcp_address,
                                                  java.lang.Boolean include_data)
        Set the search value for dhcp_address and whether or not it will be included in the search result.
      • include_DHCP_address

        public Network_FS_Parameters include_DHCP_address​(java.lang.Boolean include_data)
        Alias for include_dhcp_address (...).
      • include_dhcp_address

        public Network_FS_Parameters include_dhcp_address​(java.lang.Boolean include_data)
        Set whether or not DHCP addresses will be included in the search result.
      • DHCP_address_name

        public Network_FS_Parameters DHCP_address_name​(java.lang.String name)
        Alias for dhcp_address_name (...).
      • dhcp_address_name

        public Network_FS_Parameters dhcp_address_name​(java.lang.String dhcp_address_name)
        Set the search value for dhcp_address_name.
      • DHCP_address_name

        public Network_FS_Parameters DHCP_address_name​(java.lang.String name,
                                                       java.lang.Boolean include_data)
        Alias for dhcp_address_name (...).
      • dhcp_address_name

        public Network_FS_Parameters dhcp_address_name​(java.lang.String dhcp_address_name,
                                                       java.lang.Boolean include_data)
        Set the search value for dhcp_address_name and whether or not it will be included in the search result.
      • include_DHCP_address_name

        public Network_FS_Parameters include_DHCP_address_name​(java.lang.Boolean include_data)
        Alias for include_dhcp_address_name (...).
      • include_dhcp_address_name

        public Network_FS_Parameters include_dhcp_address_name​(java.lang.Boolean include_data)
        Set whether or not dhcp address names will be included in the search result.
      • DHCP_address_active

        public Network_FS_Parameters DHCP_address_active​(java.lang.Boolean active)
        Alias for dhcp_address_active (...).
      • dhcp_address_active

        public Network_FS_Parameters dhcp_address_active​(java.lang.Boolean dhcp_address_active)
        Set the search value for dhcp address active state.
      • DHCP_address_active

        public Network_FS_Parameters DHCP_address_active​(java.lang.Boolean active,
                                                         java.lang.Boolean include_data)
        Alias for dhcp_address_active (...).
      • dhcp_address_active

        public Network_FS_Parameters dhcp_address_active​(java.lang.Boolean dhcp_address_active,
                                                         java.lang.Boolean include_data)
        Set the search value for dhcp address active state and whether or not it will be included in the search result.
      • include_DHCP_address_active

        public Network_FS_Parameters include_DHCP_address_active​(java.lang.Boolean include_data)
        Alias for include_dhcp_address_active (...).
      • include_dhcp_address_active

        public Network_FS_Parameters include_dhcp_address_active​(java.lang.Boolean include_data)
        Set whether or not the active state for dhcp addresses will be included in the search result.
      • include_low_res

        public Network_FS_Parameters include_low_res​(java.lang.Boolean include_data)
        Set whether or not low_res will be included in the search result.
      • include_high_res

        public Network_FS_Parameters include_high_res​(java.lang.Boolean include_data)
        Set whether or not high_res will be included in the search result.
      • legacy_search_params

        public java.util.Hashtable<java.lang.String,​java.lang.String> legacy_search_params()
        Build a hashtable that is used by the current production RMI full search.
      • toJSON

        public java.lang.String toJSON​(java.lang.Boolean pretty,
                                       java.lang.Boolean ignore_exceptions)
                                throws java.lang.Exception
        Convert this to a JSON object using the template defined in json_template_name.
        Specified by:
        toJSON in class Full_Search_Parameters<Network_FS_Parameters,​Network>
        Throws:
        java.lang.Exception