Package org.opensearch.protobufs

Class SearchResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.SearchResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SearchResponseOrBuilder
public final class SearchResponse extends com.google.protobuf.GeneratedMessageV3 implements SearchResponseOrBuilder
Protobuf type org.opensearch.protobufs.SearchResponse
See Also:

  • Field Details

    • TOOK_FIELD_NUMBER

      public static final int TOOK_FIELD_NUMBER
      See Also:

    • TIMED_OUT_FIELD_NUMBER

      public static final int TIMED_OUT_FIELD_NUMBER
      See Also:

    • X_SHARDS_FIELD_NUMBER

      public static final int X_SHARDS_FIELD_NUMBER
      See Also:

    • PHASE_TOOK_FIELD_NUMBER

      public static final int PHASE_TOOK_FIELD_NUMBER
      See Also:

    • HITS_FIELD_NUMBER

      public static final int HITS_FIELD_NUMBER
      See Also:

    • PROCESSOR_RESULTS_FIELD_NUMBER

      public static final int PROCESSOR_RESULTS_FIELD_NUMBER
      See Also:

    • X_CLUSTERS_FIELD_NUMBER

      public static final int X_CLUSTERS_FIELD_NUMBER
      See Also:

    • FIELDS_FIELD_NUMBER

      public static final int FIELDS_FIELD_NUMBER
      See Also:

    • NUM_REDUCE_PHASES_FIELD_NUMBER

      public static final int NUM_REDUCE_PHASES_FIELD_NUMBER
      See Also:

    • PROFILE_FIELD_NUMBER

      public static final int PROFILE_FIELD_NUMBER
      See Also:

    • PIT_ID_FIELD_NUMBER

      public static final int PIT_ID_FIELD_NUMBER
      See Also:

    • X_SCROLL_ID_FIELD_NUMBER

      public static final int X_SCROLL_ID_FIELD_NUMBER
      See Also:

    • TERMINATED_EARLY_FIELD_NUMBER

      public static final int TERMINATED_EARLY_FIELD_NUMBER
      See Also:

    • AGGREGATIONS_FIELD_NUMBER

      public static final int AGGREGATIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getTook

      public long getTook()
      int64 took = 1 [json_name = "took"];
      Specified by:
      getTook in interface SearchResponseOrBuilder
      Returns:
      The took.

    • getTimedOut

      public boolean getTimedOut()
      bool timed_out = 2 [json_name = "timedOut"];
      Specified by:
      getTimedOut in interface SearchResponseOrBuilder
      Returns:
      The timedOut.

    • hasXShards

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

    • getXShards

      public ShardStatistics getXShards()
      .org.opensearch.protobufs.ShardStatistics x_shards = 3 [json_name = "xShards"];
      Specified by:
      getXShards in interface SearchResponseOrBuilder
      Returns:
      The xShards.

    • getXShardsOrBuilder

      public ShardStatisticsOrBuilder getXShardsOrBuilder()
      .org.opensearch.protobufs.ShardStatistics x_shards = 3 [json_name = "xShards"];
      Specified by:
      getXShardsOrBuilder in interface SearchResponseOrBuilder

    • hasPhaseTook

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

    • getPhaseTook

      public PhaseTook getPhaseTook()
      optional .org.opensearch.protobufs.PhaseTook phase_took = 4 [json_name = "phaseTook"];
      Specified by:
      getPhaseTook in interface SearchResponseOrBuilder
      Returns:
      The phaseTook.

    • getPhaseTookOrBuilder

      public PhaseTookOrBuilder getPhaseTookOrBuilder()
      optional .org.opensearch.protobufs.PhaseTook phase_took = 4 [json_name = "phaseTook"];
      Specified by:
      getPhaseTookOrBuilder in interface SearchResponseOrBuilder

    • hasHits

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

    • getHits

      public HitsMetadata getHits()
      .org.opensearch.protobufs.HitsMetadata hits = 5 [json_name = "hits"];
      Specified by:
      getHits in interface SearchResponseOrBuilder
      Returns:
      The hits.

    • getHitsOrBuilder

      public HitsMetadataOrBuilder getHitsOrBuilder()
      .org.opensearch.protobufs.HitsMetadata hits = 5 [json_name = "hits"];
      Specified by:
      getHitsOrBuilder in interface SearchResponseOrBuilder

    • getProcessorResultsList

      public List<ProcessorExecutionDetail> getProcessorResultsList()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];
      Specified by:
      getProcessorResultsList in interface SearchResponseOrBuilder

    • getProcessorResultsOrBuilderList

      public List<? extends ProcessorExecutionDetailOrBuilder> getProcessorResultsOrBuilderList()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];
      Specified by:
      getProcessorResultsOrBuilderList in interface SearchResponseOrBuilder

    • getProcessorResultsCount

      public int getProcessorResultsCount()
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];
      Specified by:
      getProcessorResultsCount in interface SearchResponseOrBuilder

    • getProcessorResults

      public ProcessorExecutionDetail getProcessorResults(int index)
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];
      Specified by:
      getProcessorResults in interface SearchResponseOrBuilder

    • getProcessorResultsOrBuilder

      public ProcessorExecutionDetailOrBuilder getProcessorResultsOrBuilder(int index)
      repeated .org.opensearch.protobufs.ProcessorExecutionDetail processor_results = 6 [json_name = "processorResults"];
      Specified by:
      getProcessorResultsOrBuilder in interface SearchResponseOrBuilder

    • hasXClusters

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

    • getXClusters

      public ClusterStatistics getXClusters()
      optional .org.opensearch.protobufs.ClusterStatistics x_clusters = 7 [json_name = "xClusters"];
      Specified by:
      getXClusters in interface SearchResponseOrBuilder
      Returns:
      The xClusters.

    • getXClustersOrBuilder

      public ClusterStatisticsOrBuilder getXClustersOrBuilder()
      optional .org.opensearch.protobufs.ClusterStatistics x_clusters = 7 [json_name = "xClusters"];
      Specified by:
      getXClustersOrBuilder in interface SearchResponseOrBuilder

    • hasFields

      @Deprecated public 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];
      Specified by:
      hasFields in interface SearchResponseOrBuilder
      Returns:
      Whether the fields field is set.

    • getFields

      @Deprecated public 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];
      Specified by:
      getFields in interface SearchResponseOrBuilder
      Returns:
      The fields.

    • getFieldsOrBuilder

      @Deprecated public ObjectMapOrBuilder getFieldsOrBuilder()
      Deprecated.
      optional .org.opensearch.protobufs.ObjectMap fields = 8 [json_name = "fields", deprecated = true];
      Specified by:
      getFieldsOrBuilder in interface SearchResponseOrBuilder

    • hasNumReducePhases

      public boolean hasNumReducePhases()
      optional int32 num_reduce_phases = 9 [json_name = "numReducePhases"];
      Specified by:
      hasNumReducePhases in interface SearchResponseOrBuilder
      Returns:
      Whether the numReducePhases field is set.

    • getNumReducePhases

      public int getNumReducePhases()
      optional int32 num_reduce_phases = 9 [json_name = "numReducePhases"];
      Specified by:
      getNumReducePhases in interface SearchResponseOrBuilder
      Returns:
      The numReducePhases.

    • hasProfile

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

    • getProfile

      public Profile getProfile()
      optional .org.opensearch.protobufs.Profile profile = 10 [json_name = "profile"];
      Specified by:
      getProfile in interface SearchResponseOrBuilder
      Returns:
      The profile.

    • getProfileOrBuilder

      public ProfileOrBuilder getProfileOrBuilder()
      optional .org.opensearch.protobufs.Profile profile = 10 [json_name = "profile"];
      Specified by:
      getProfileOrBuilder in interface SearchResponseOrBuilder

    • hasPitId

      public boolean hasPitId()
      optional string pit_id = 11 [json_name = "pitId"];
      Specified by:
      hasPitId in interface SearchResponseOrBuilder
      Returns:
      Whether the pitId field is set.

    • getPitId

      public String getPitId()
      optional string pit_id = 11 [json_name = "pitId"];
      Specified by:
      getPitId in interface SearchResponseOrBuilder
      Returns:
      The pitId.

    • getPitIdBytes

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

    • hasXScrollId

      public boolean hasXScrollId()
      optional string x_scroll_id = 12 [json_name = "xScrollId"];
      Specified by:
      hasXScrollId in interface SearchResponseOrBuilder
      Returns:
      Whether the xScrollId field is set.

    • getXScrollId

      public String getXScrollId()
      optional string x_scroll_id = 12 [json_name = "xScrollId"];
      Specified by:
      getXScrollId in interface SearchResponseOrBuilder
      Returns:
      The xScrollId.

    • getXScrollIdBytes

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

    • hasTerminatedEarly

      public boolean hasTerminatedEarly()
      optional bool terminated_early = 13 [json_name = "terminatedEarly"];
      Specified by:
      hasTerminatedEarly in interface SearchResponseOrBuilder
      Returns:
      Whether the terminatedEarly field is set.

    • getTerminatedEarly

      public boolean getTerminatedEarly()
      optional bool terminated_early = 13 [json_name = "terminatedEarly"];
      Specified by:
      getTerminatedEarly in interface SearchResponseOrBuilder
      Returns:
      The terminatedEarly.

    • getAggregationsCount

      public int getAggregationsCount()
      Description copied from interface: SearchResponseOrBuilder
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];
      Specified by:
      getAggregationsCount in interface SearchResponseOrBuilder

    • containsAggregations

      public boolean containsAggregations(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];
      Specified by:
      containsAggregations in interface SearchResponseOrBuilder

    • getAggregations

      @Deprecated public Map<String,Aggregate> getAggregations()
      Deprecated.
      Use getAggregationsMap() instead.
      Specified by:
      getAggregations in interface SearchResponseOrBuilder

    • getAggregationsMap

      public Map<String,Aggregate> getAggregationsMap()
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];
      Specified by:
      getAggregationsMap in interface SearchResponseOrBuilder

    • getAggregationsOrDefault

      public Aggregate getAggregationsOrDefault(String key, Aggregate defaultValue)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];
      Specified by:
      getAggregationsOrDefault in interface SearchResponseOrBuilder

    • getAggregationsOrThrow

      public Aggregate getAggregationsOrThrow(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregations = 14 [json_name = "aggregations"];
      Specified by:
      getAggregationsOrThrow in interface SearchResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchResponse.Builder newBuilder()

    • newBuilder

      public static SearchResponse.Builder newBuilder(SearchResponse prototype)

    • toBuilder

      public SearchResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SearchResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public SearchResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder