Package org.opensearch.search.profile

Class SearchProfileShardResults

java.lang.Object
org.opensearch.search.profile.SearchProfileShardResults
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
public final class SearchProfileShardResults extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentFragment
A container class to hold all the profile results across all shards. Internally holds a map of shard ID -> Profiled results
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    INBOUND_NETWORK_FIELD
     
    static final String
    OUTBOUND_NETWORK_FIELD
     
    static final String
    PROFILE_FIELD
     

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchProfileShardResults(Map<String,ProfileShardResult> shardResults)
     
    SearchProfileShardResults(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ProfileShardResult
    buildShardResults(Profilers profilers, ShardSearchRequest request)
    Helper method to convert Profiler into InternalProfileShardResults, which can be serialized to other nodes, emitted as JSON, etc.
    static SearchProfileShardResults
    fromXContent(org.opensearch.core.xcontent.XContentParser parser)
     
    Map<String,ProfileShardResult>
    getShardResults()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • SearchProfileShardResults

      public SearchProfileShardResults(Map<String,ProfileShardResult> shardResults)

    • SearchProfileShardResults

      public SearchProfileShardResults(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • getShardResults

      public Map<String,ProfileShardResult> getShardResults()

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • fromXContent

      public static SearchProfileShardResults fromXContent(org.opensearch.core.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • buildShardResults

      public static ProfileShardResult buildShardResults(Profilers profilers, ShardSearchRequest request)
      Helper method to convert Profiler into InternalProfileShardResults, which can be serialized to other nodes, emitted as JSON, etc.
      Parameters:
      profilers - The Profilers to convert into results
      Returns:
      A ProfileShardResult representing the results for this shard