Package com.softlayer.api.service

Interface Search.Service

  • All Superinterfaces:
    Maskable, ResultLimitable, Service
    Enclosing class:
    Search
    @ApiService("SoftLayer_Search")
public static interface Search.Service
extends Service
    SoftLayer's account historical service allows users to access a broad overview of devices for that account and historical details concerning the overall function and performance of the devices on that account
    See Also:
    SoftLayer_Search

    • Method Detail

      • withNewMask

        Search.Mask withNewMask()
        Description copied from interface: Maskable
        Overwrite the existing mask on this service with a new one and return it
        Specified by:
        withNewMask in interface Maskable

      • withMask

        Search.Mask withMask()
        Description copied from interface: Maskable
        Use the existing mask on this service or create it if not present
        Specified by:
        withMask in interface Maskable

      • advancedSearch

        @ApiMethod
List<Result> advancedSearch​(String searchString)
        This method allows for searching for SoftLayer resources by simple terms and operators. Fields that are used for searching will be available at sldn.softlayer.com. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found.

        The advancedSearch() method recognizes the special _objectType: quantifier in search strings. See the documentation for the [[SoftLayer_Search/search]] method on how to restrict searches using object types.

        The advancedSearch() method recognizes [[SoftLayer_Container_Search_ObjectType_Property]], which can also be used to limit searches. Example:

        _objectType:Type_1 propertyA:value

        A search string can specify multiple properties, separated with spaces. Example:

        _objectType:Type_1 propertyA:value propertyB:value

        A collection of available object types and their properties can be retrieved by calling the [[SoftLayer_Search/getObjectTypes]] method.


        #### Exact Match on Text Fields
        To enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names:

        • baremetal-a
        • baremetal-b
        • a-virtual-guest
        • b-virtual-guest
        • edge-router


        An exact search (double-quote) for "baremetal-a" will return only the exact match of baremetal-a.

        A fuzzy search (no double-quote) for baremetal-a will return baremetal-a, baremetal-b, a-virtual-guest, b-virtual-guest but will omit edge-router.
        See Also:
        SoftLayer_Search::advancedSearch

      • getObjectTypes

        @ApiMethod
List<ObjectType> getObjectTypes()
        This method returns a collection of [[SoftLayer_Container_Search_ObjectType]] containers that specify which indexed object types and properties are exposed for the current user. These object types can be used to discover searchable data and to create or validate object index search strings.



        Refer to the [[SoftLayer_Search/search]] and [[SoftLayer_Search/advancedSearch]] methods for information on using object types and properties in search strings.
        See Also:
        SoftLayer_Search::getObjectTypes

      • search

        @ApiMethod
List<Result> search​(String searchString)
        This method allows for searching for SoftLayer resources by simple phrase. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found.

        This method recognizes the special _objectType: quantifier in search strings. This quantifier can be used to restrict a search to specific object types. Example usage:

        _objectType:Type_1 (other search terms...)

        A search string can specify multiple object types, separated by commas (no spaces are permitted between the type names). Example:

        _objectType:Type_1,Type_2,Type_3 (other search terms...)

        If the list of object types is prefixed with a hyphen or minus sign (-), then the specified types are excluded from the search. Example:

        _objectType:-Type_4,Type_5 (other search terms...)

        A collection of available object types can be retrieved by calling the [[SoftLayer_Search/getObjectTypes]] method.


        #### Exact Match on Text Fields
        To enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names:

        • baremetal-a
        • baremetal-b
        • a-virtual-guest
        • b-virtual-guest
        • edge-router


        An exact search (double-quote) for "baremetal-a" will return only the exact match of baremetal-a.

        A fuzzy search (no double-quote) for baremetal-a will return baremetal-a, baremetal-b, a-virtual-guest, b-virtual-guest but will omit edge-router.
        See Also:
        SoftLayer_Search::search