com.softlayer.api.service.Search Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.search.ObjectType;
import com.softlayer.api.service.container.search.Result;
import java.util.List;
import java.util.concurrent.Future;

/**
 * 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 SoftLayer_Search
 */
@ApiType("SoftLayer_Search")
public class Search extends Entity {

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * 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 SoftLayer_Search
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Search")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * 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 SoftLayer_Search::advancedSearch
         */
        @ApiMethod
        public List advancedSearch(String searchString);

        /**
         * 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 SoftLayer_Search::getObjectTypes
         */
        @ApiMethod
        public List getObjectTypes();

        /**
         * 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 SoftLayer_Search::search
         */
        @ApiMethod
        public List search(String searchString);

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#advancedSearch}
         */
        public Future> advancedSearch(String searchString);

        public Future advancedSearch(String searchString, ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObjectTypes}
         */
        public Future> getObjectTypes();

        public Future getObjectTypes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#search}
         */
        public Future> search(String searchString);

        public Future search(String searchString, ResponseHandler> callback);

    }

    public static class Mask extends Entity.Mask {

    }

}