程序包 org.easysearch.client.asyncsearch

类 AsyncSearchResponse

java.lang.Object
org.easysearch.client.asyncsearch.AsyncSearchResponse
所有已实现的接口:
org.easysearch.common.xcontent.ToXContent, org.easysearch.common.xcontent.ToXContentObject
public class AsyncSearchResponse
extends java.lang.Object
implements org.easysearch.common.xcontent.ToXContentObject
A response of an async search request.

  • 嵌套类概要

    从接口继承的嵌套类/接口 org.easysearch.common.xcontent.ToXContent

    org.easysearch.common.xcontent.ToXContent.DelegatingMapParams, org.easysearch.common.xcontent.ToXContent.MapParams, org.easysearch.common.xcontent.ToXContent.Params

  • 字段概要

    字段
    修饰符和类型 字段 说明
    static org.easysearch.common.ParseField ERROR_FIELD  
    static org.easysearch.common.ParseField EXPIRATION_FIELD  
    static org.easysearch.common.ParseField ID_FIELD  
    static org.easysearch.common.ParseField IS_PARTIAL_FIELD  
    static org.easysearch.common.ParseField IS_RUNNING_FIELD  
    static org.easysearch.common.xcontent.ConstructingObjectParser<AsyncSearchResponse,​java.lang.Void> PARSER  
    static org.easysearch.common.ParseField RESPONSE_FIELD  
    static org.easysearch.common.ParseField START_TIME_FIELD  

    从接口继承的字段 org.easysearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • 方法概要

    修饰符和类型 方法 说明
    static AsyncSearchResponse fromXContent​(org.easysearch.common.xcontent.XContentParser parser)  
    long getExpirationTime()
    When this response will expired as a timestamp in milliseconds since epoch.
    org.easysearch.EasysearchException getFailure()
    Returns the failure reason or null if the query is running or has completed normally.
    java.lang.String getId()
    Returns the id of the async search request or null if the response is not stored in the cluster.
    org.easysearch.action.search.SearchResponse getSearchResponse()
    Returns the current SearchResponse or null if not available.
    long getStartTime()
    When this response was created as a timestamp in milliseconds since epoch.
    boolean isPartial()
    Returns true if the SearchResponse contains partial results computed from a subset of the total shards.
    boolean isRunning()
    Whether the search is still running in the cluster.
    java.lang.String toString()  
    org.easysearch.common.xcontent.XContentBuilder toXContent​(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params)  

    从类继承的方法 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    从接口继承的方法 org.easysearch.common.xcontent.ToXContentObject

    isFragment

  • 字段详细资料

    • ID_FIELD

      public static final org.easysearch.common.ParseField ID_FIELD

    • IS_PARTIAL_FIELD

      public static final org.easysearch.common.ParseField IS_PARTIAL_FIELD

    • IS_RUNNING_FIELD

      public static final org.easysearch.common.ParseField IS_RUNNING_FIELD

    • START_TIME_FIELD

      public static final org.easysearch.common.ParseField START_TIME_FIELD

    • EXPIRATION_FIELD

      public static final org.easysearch.common.ParseField EXPIRATION_FIELD

    • RESPONSE_FIELD

      public static final org.easysearch.common.ParseField RESPONSE_FIELD

    • ERROR_FIELD

      public static final org.easysearch.common.ParseField ERROR_FIELD

    • PARSER

      public static final org.easysearch.common.xcontent.ConstructingObjectParser<AsyncSearchResponse,​java.lang.Void> PARSER

  • 方法详细资料

    • getId

      @Nullable public java.lang.String getId()
      Returns the id of the async search request or null if the response is not stored in the cluster.

    • getSearchResponse

      public org.easysearch.action.search.SearchResponse getSearchResponse()
      Returns the current SearchResponse or null if not available. See isPartial() to determine whether the response contains partial or complete results.

    • getFailure

      public org.easysearch.EasysearchException getFailure()
      Returns the failure reason or null if the query is running or has completed normally.

    • isPartial

      public boolean isPartial()
      Returns true if the SearchResponse contains partial results computed from a subset of the total shards.

    • isRunning

      public boolean isRunning()
      Whether the search is still running in the cluster. A value of false indicates that the response is final even if isPartial() returns true. In such case, the partial response represents the status of the search before a non-recoverable failure.

    • getStartTime

      public long getStartTime()
      When this response was created as a timestamp in milliseconds since epoch.

    • getExpirationTime

      public long getExpirationTime()
      When this response will expired as a timestamp in milliseconds since epoch.

    • toXContent

      public org.easysearch.common.xcontent.XContentBuilder toXContent​(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      指定者:
      toXContent 在接口中 org.easysearch.common.xcontent.ToXContent
      抛出:
      java.io.IOException

    • fromXContent

      public static AsyncSearchResponse fromXContent​(org.easysearch.common.xcontent.XContentParser parser)

    • toString

      public java.lang.String toString()
      覆盖:
      toString 在类中 java.lang.Object