Package org.opensearch.protobufs

Interface SearchResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResponse, SearchResponse.Builder
public interface SearchResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getTook

      long getTook()
      int64 took = 1 [json_name = "took"];
      Returns:
      The took.

    • getTimedOut

      boolean getTimedOut()
      bool timed_out = 2 [json_name = "timedOut"];
      Returns:
      The timedOut.

    • hasXShards

      boolean hasXShards()
      .org.opensearch.protobufs.ShardStatistics x_shards = 3 [json_name = "xShards"];
      Returns:
      Whether the xShards field is set.

    • getXShards

      ShardStatistics getXShards()
      .org.opensearch.protobufs.ShardStatistics x_shards = 3 [json_name = "xShards"];
      Returns:
      The xShards.

    • getXShardsOrBuilder

      ShardStatisticsOrBuilder getXShardsOrBuilder()
      .org.opensearch.protobufs.ShardStatistics x_shards = 3 [json_name = "xShards"];

    • hasPhaseTook

      boolean hasPhaseTook()
      optional .org.opensearch.protobufs.PhaseTook phase_took = 4 [json_name = "phaseTook"];
      Returns:
      Whether the phaseTook field is set.

    • getPhaseTook

      PhaseTook getPhaseTook()
      optional .org.opensearch.protobufs.PhaseTook phase_took = 4 [json_name = "phaseTook"];
      Returns:
      The phaseTook.

    • getPhaseTookOrBuilder

      PhaseTookOrBuilder getPhaseTookOrBuilder()
      optional .org.opensearch.protobufs.PhaseTook phase_took = 4 [json_name = "phaseTook"];

    • hasHits

      boolean hasHits()
      .org.opensearch.protobufs.HitsMetadata hits = 5 [json_name = "hits"];
      Returns:
      Whether the hits field is set.

    • getHits

      HitsMetadata getHits()
      .org.opensearch.protobufs.HitsMetadata hits = 5 [json_name = "hits"];
      Returns:
      The hits.

    • getHitsOrBuilder

      HitsMetadataOrBuilder getHitsOrBuilder()
      .org.opensearch.protobufs.HitsMetadata hits = 5 [json_name = "hits"];

    • getProcessorResultsList

      List<ProcessorExecutionDetail> getProcessorResultsList()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];

    • getProcessorResults

      ProcessorExecutionDetail getProcessorResults(int index)
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];

    • getProcessorResultsCount

      int getProcessorResultsCount()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];

    • getProcessorResultsOrBuilderList

      List<? extends ProcessorExecutionDetailOrBuilder> getProcessorResultsOrBuilderList()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];

    • getProcessorResultsOrBuilder

      ProcessorExecutionDetailOrBuilder getProcessorResultsOrBuilder(int index)
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];

    • hasXClusters

      boolean hasXClusters()
      optional .org.opensearch.protobufs.ClusterStatistics x_clusters = 7 [json_name = "xClusters"];
      Returns:
      Whether the xClusters field is set.

    • getXClusters

      ClusterStatistics getXClusters()
      optional .org.opensearch.protobufs.ClusterStatistics x_clusters = 7 [json_name = "xClusters"];
      Returns:
      The xClusters.

    • getXClustersOrBuilder

      ClusterStatisticsOrBuilder getXClustersOrBuilder()
      optional .org.opensearch.protobufs.ClusterStatistics x_clusters = 7 [json_name = "xClusters"];

    • hasFields

      @Deprecated boolean hasFields()
      Deprecated.
      org.opensearch.protobufs.SearchResponse.fields is deprecated. See protos/schemas/common.proto;l=0
      optional .org.opensearch.protobufs.ObjectMap fields = 8 [json_name = "fields", deprecated = true];
      Returns:
      Whether the fields field is set.

    • getFields

      @Deprecated ObjectMap getFields()
      Deprecated.
      org.opensearch.protobufs.SearchResponse.fields is deprecated. See protos/schemas/common.proto;l=0
      optional .org.opensearch.protobufs.ObjectMap fields = 8 [json_name = "fields", deprecated = true];
      Returns:
      The fields.

    • getFieldsOrBuilder

      @Deprecated ObjectMapOrBuilder getFieldsOrBuilder()
      Deprecated.
      optional .org.opensearch.protobufs.ObjectMap fields = 8 [json_name = "fields", deprecated = true];

    • hasNumReducePhases

      boolean hasNumReducePhases()
      optional int32 num_reduce_phases = 9 [json_name = "numReducePhases"];
      Returns:
      Whether the numReducePhases field is set.

    • getNumReducePhases

      int getNumReducePhases()
      optional int32 num_reduce_phases = 9 [json_name = "numReducePhases"];
      Returns:
      The numReducePhases.

    • hasProfile

      boolean hasProfile()
      optional .org.opensearch.protobufs.Profile profile = 10 [json_name = "profile"];
      Returns:
      Whether the profile field is set.

    • getProfile

      Profile getProfile()
      optional .org.opensearch.protobufs.Profile profile = 10 [json_name = "profile"];
      Returns:
      The profile.

    • getProfileOrBuilder

      ProfileOrBuilder getProfileOrBuilder()
      optional .org.opensearch.protobufs.Profile profile = 10 [json_name = "profile"];

    • hasPitId

      boolean hasPitId()
      optional string pit_id = 11 [json_name = "pitId"];
      Returns:
      Whether the pitId field is set.

    • getPitId

      String getPitId()
      optional string pit_id = 11 [json_name = "pitId"];
      Returns:
      The pitId.

    • getPitIdBytes

      com.google.protobuf.ByteString getPitIdBytes()
      optional string pit_id = 11 [json_name = "pitId"];
      Returns:
      The bytes for pitId.

    • hasXScrollId

      boolean hasXScrollId()
      optional string x_scroll_id = 12 [json_name = "xScrollId"];
      Returns:
      Whether the xScrollId field is set.

    • getXScrollId

      String getXScrollId()
      optional string x_scroll_id = 12 [json_name = "xScrollId"];
      Returns:
      The xScrollId.

    • getXScrollIdBytes

      com.google.protobuf.ByteString getXScrollIdBytes()
      optional string x_scroll_id = 12 [json_name = "xScrollId"];
      Returns:
      The bytes for xScrollId.

    • hasTerminatedEarly

      boolean hasTerminatedEarly()
      optional bool terminated_early = 13 [json_name = "terminatedEarly"];
      Returns:
      Whether the terminatedEarly field is set.

    • getTerminatedEarly

      boolean getTerminatedEarly()
      optional bool terminated_early = 13 [json_name = "terminatedEarly"];
      Returns:
      The terminatedEarly.

    • getAggregationsCount

      int getAggregationsCount()
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];

    • containsAggregations

      boolean containsAggregations(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];

    • getAggregations

      @Deprecated Map<String,Aggregate> getAggregations()
      Deprecated.
      Use getAggregationsMap() instead.

    • getAggregationsMap

      Map<String,Aggregate> getAggregationsMap()
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];

    • getAggregationsOrDefault

      Aggregate getAggregationsOrDefault(String key, Aggregate defaultValue)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];

    • getAggregationsOrThrow

      Aggregate getAggregationsOrThrow(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];