ProspectiveSearchService (Google App Engine API for Java)

com.google.appengine.api.prospectivesearch

Interface ProspectiveSearchService


  • Deprecated. 
    This API has been deprecated.

    @Deprecated
    public interface ProspectiveSearchService
    The Prospective Search App Engine API exposes the real-time and highly scalable Google Prospective Search Infrastructure as an App Engine service. The ProspectiveSearch API allows an app to register a set of queries (in a simple query format) to match against documents that are presented. For every document presented, the matcher will return the ids of all of the matching queries. To allow the app to handle a potentially large number of matched queries, the matched ids are enqueued as tasks on the TaskQueue. The target for these match notifications is defined in the member DEFAULT_RESULT_RELATIVE_URL.
    See Also:
    Query Language Overview in the Developer Guide., Handling Matches in the Developer Guide.
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method and Description
      Entity getDocument(HttpServletRequest matchCallbackPost)
      Deprecated. 
      Decodes document from match(Entity, String, String, String, String, int, boolean) result POST request.
      Subscription getSubscription(java.lang.String topic, java.lang.String subId)
      Deprecated. 
      Get the Subscription with the given topic and id.
      java.util.List<Subscription> listSubscriptions(java.lang.String topic)
      Deprecated. 
      Equivalent to:
      java.util.List<Subscription> listSubscriptions(java.lang.String topic, java.lang.String subIdStart, int maxResults, long expiresBefore)
      Deprecated. 
      The listSubscriptions call lists subscriptions that are currently active.
      java.util.List<java.lang.String> listTopics(java.lang.String topicStart, long maxResults)
      Deprecated. 
      List topics in lexicographic order.
      void match(Entity document, java.lang.String topic)
      Deprecated. 
      Equivalent to:
      void match(Entity document, java.lang.String topic, java.lang.String resultKey)
      Deprecated. 
      Equivalent to:
      void match(Entity document, java.lang.String topic, java.lang.String resultKey, java.lang.String resultRelativeUrl, java.lang.String resultTaskQueueName, int resultBatchSize, boolean resultReturnDocument)
      Deprecated. 
      The match call is used to present a document for matching against all registered subscriptions of the same topic.
      void subscribe(java.lang.String topic, java.lang.String subId, long leaseDurationSeconds, java.lang.String query, java.util.Map<java.lang.String,FieldType> schema)
      Deprecated. 
      The subscribe call is used to register subscriptions, which comprise of a subscription id and a query.
      void unsubscribe(java.lang.String topic, java.lang.String subId)
      Deprecated. 
      Subscriptions are removed from the system using the unsubscribe call.
    • Field Detail

      • DEFAULT_LEASE_DURATION_SEC

        static final int DEFAULT_LEASE_DURATION_SEC
        Deprecated. 
        The default lease duration value of zero means no expiration.
        See Also:
        Constant Field Values
      • DEFAULT_LIST_SUBSCRIPTIONS_MAX_RESULTS

        static final int DEFAULT_LIST_SUBSCRIPTIONS_MAX_RESULTS
        <