Package org.opensearch.client.opensearch._types

Class SegmentsStats

java.lang.Object
org.opensearch.client.opensearch._types.SegmentsStats
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SegmentsStats.Builder,SegmentsStats>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class SegmentsStats extends Object implements PlainJsonSerializable, ToCopyableBuilder<SegmentsStats.Builder,SegmentsStats>
The statistics about segments.

  • Field Details

  • Method Details

    • of

      public static SegmentsStats of(Function<SegmentsStats.Builder,ObjectBuilder<SegmentsStats>> fn)

    • count

      public final int count()
      Required - The total number of segments across all shards assigned to the selected nodes.

      API name: count

    • docValuesMemory

      @Nullable public final String docValuesMemory()
      The human-readable amount of memory used for doc values.

      API name: doc_values_memory

    • docValuesMemoryInBytes

      public final long docValuesMemoryInBytes()
      Required - The total amount, in bytes, of memory used for document values across all shards assigned to the selected nodes.

      API name: doc_values_memory_in_bytes

    • fileSizes

      @Nonnull public final Map<String,ShardFileSizeInfo> fileSizes()
      Required - This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.

      API name: file_sizes

    • fixedBitSet

      @Nullable public final String fixedBitSet()
      API name: fixed_bit_set

    • fixedBitSetMemoryInBytes

      public final long fixedBitSetMemoryInBytes()
      Required - The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes.

      API name: fixed_bit_set_memory_in_bytes

    • indexWriterMaxMemoryInBytes

      @Nullable public final Long indexWriterMaxMemoryInBytes()
      The maximum amount of memory, in bytes, used by index writers.

      API name: index_writer_max_memory_in_bytes

    • indexWriterMemory

      @Nullable public final String indexWriterMemory()
      The human-readable amount of memory used by index writers.

      API name: index_writer_memory

    • indexWriterMemoryInBytes

      public final long indexWriterMemoryInBytes()
      Required - The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes.

      API name: index_writer_memory_in_bytes

    • maxUnsafeAutoIdTimestamp

      public final long maxUnsafeAutoIdTimestamp()
      Required - The Unix timestamp, in milliseconds, of the most recently retried indexing request.

      API name: max_unsafe_auto_id_timestamp

    • memory

      @Nullable public final String memory()
      The total amount of memory used for segments across all shards assigned to the selected nodes.

      API name: memory

    • memoryInBytes

      public final long memoryInBytes()
      Required - The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes.

      API name: memory_in_bytes

    • normsMemory

      @Nullable public final String normsMemory()
      The total amount of memory used for normalization factors across all shards assigned to the selected nodes.

      API name: norms_memory

    • normsMemoryInBytes

      public final long normsMemoryInBytes()
      Required - The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes.

      API name: norms_memory_in_bytes

    • pointsMemory

      @Nullable public final String pointsMemory()
      The total amount of memory used for points across all shards assigned to the selected nodes.

      API name: points_memory

    • pointsMemoryInBytes

      public final long pointsMemoryInBytes()
      Required - The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes.

      API name: points_memory_in_bytes

    • remoteStore

      @Nullable public final RemoteStoreStats remoteStore()
      API name: remote_store

    • segmentReplication

      @Nullable public final SegmentReplicationStats segmentReplication()
      API name: segment_replication

    • storedFieldsMemory

      @Nullable public final String storedFieldsMemory()
      The total amount of memory used for stored fields across all shards assigned to the selected nodes.

      API name: stored_fields_memory

    • storedFieldsMemoryInBytes

      public final long storedFieldsMemoryInBytes()
      Required - The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes.

      API name: stored_fields_memory_in_bytes

    • termVectorsMemory

      @Nullable public final String termVectorsMemory()
      The total amount of memory used for term vectors across all shards assigned to the selected nodes.

      API name: term_vectors_memory

    • termVectorsMemoryInBytes

      public final long termVectorsMemoryInBytes()
      Required - The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes.

      API name: term_vectors_memory_in_bytes

    • termsMemory

      @Nullable public final String termsMemory()
      The total amount of memory used for terms across all shards assigned to the selected nodes.

      API name: terms_memory

    • termsMemoryInBytes

      public final long termsMemoryInBytes()
      Required - The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes.

      API name: terms_memory_in_bytes

    • versionMapMemory

      @Nullable public final String versionMapMemory()
      The total amount of memory used by all version maps across all shards assigned to the selected nodes.

      API name: version_map_memory

    • versionMapMemoryInBytes

      public final long versionMapMemoryInBytes()
      Required - The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes.

      API name: version_map_memory_in_bytes

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public SegmentsStats.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SegmentsStats.Builder,SegmentsStats>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SegmentsStats.Builder builder()

    • setupSegmentsStatsDeserializer

      protected static void setupSegmentsStatsDeserializer(ObjectDeserializer<SegmentsStats.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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