Package org.opensearch.action.admin.indices.datastream

Class DataStreamsStatsAction.Response

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.support.broadcast.BroadcastResponse
org.opensearch.action.admin.indices.datastream.DataStreamsStatsAction.Response
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
Enclosing class:
DataStreamsStatsAction
public static class DataStreamsStatsAction.Response extends BroadcastResponse
Response for Data Streams Stats
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    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 inherited from class org.opensearch.action.support.broadcast.BroadcastResponse

    EMPTY

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    Response(int totalShards, int successfulShards, int failedShards, List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures, int dataStreamCount, int backingIndices, org.opensearch.core.common.unit.ByteSizeValue totalStoreSize, DataStreamsStatsAction.DataStreamStats[] dataStreams)
     
    Response(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addCustomXContentFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
    Override in subclass to add custom fields following the common `_shards` field
    boolean
    equals(Object obj)
     
    int
    getBackingIndices()
     
    int
    getDataStreamCount()
     
    DataStreamsStatsAction.DataStreamStats[]
    getDataStreams()
     
    org.opensearch.core.common.unit.ByteSizeValue
    getTotalStoreSize()
     
    int
    hashCode()
     
    String
    toString()
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.opensearch.action.support.broadcast.BroadcastResponse

    declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards, toXContent

    Methods inherited from class org.opensearch.core.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

    isFragment

  • Constructor Details

    • Response

      public Response(int totalShards, int successfulShards, int failedShards, List<org.opensearch.core.action.support.DefaultShardOperationFailedException> shardFailures, int dataStreamCount, int backingIndices, org.opensearch.core.common.unit.ByteSizeValue totalStoreSize, DataStreamsStatsAction.DataStreamStats[] dataStreams)

    • Response

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

  • Method Details

    • 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
      Overrides:
      writeTo in class BroadcastResponse
      Throws:
      IOException

    • addCustomXContentFields

      protected void addCustomXContentFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Description copied from class: BroadcastResponse
      Override in subclass to add custom fields following the common `_shards` field
      Overrides:
      addCustomXContentFields in class BroadcastResponse
      Throws:
      IOException

    • getDataStreamCount

      public int getDataStreamCount()

    • getBackingIndices

      public int getBackingIndices()

    • getTotalStoreSize

      public org.opensearch.core.common.unit.ByteSizeValue getTotalStoreSize()

    • getDataStreams

      public DataStreamsStatsAction.DataStreamStats[] getDataStreams()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object