Class SegmentsStats.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.SegmentsStats.Builder
All Implemented Interfaces:
CopyableBuilder<SegmentsStats.Builder,SegmentsStats>, MutableBuilder<SegmentsStats.Builder,SegmentsStats>, ObjectBuilder<SegmentsStats>
Enclosing class:
SegmentsStats

public static class SegmentsStats.Builder extends ObjectBuilderBase implements CopyableBuilder<SegmentsStats.Builder,SegmentsStats>
Builder for SegmentsStats.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • copy

      @Nonnull public SegmentsStats.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<SegmentsStats.Builder,SegmentsStats>
      Returns:
      a new builder instance.
    • count

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

      API name: count

    • docValuesMemory

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

      API name: doc_values_memory

    • docValuesMemoryInBytes

      @Nonnull public final SegmentsStats.Builder docValuesMemoryInBytes(long value)
      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 SegmentsStats.Builder fileSizes(Map<String,ShardFileSizeInfo> map)
      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

      Adds all elements of map to fileSizes.

    • fileSizes

      @Nonnull public final SegmentsStats.Builder fileSizes(String key, ShardFileSizeInfo value)
      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

      Adds an entry to fileSizes.

    • 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

      Adds a value to fileSizes using a builder lambda.

    • fixedBitSet

      @Nonnull public final SegmentsStats.Builder fixedBitSet(@Nullable String value)
      API name: fixed_bit_set
    • fixedBitSetMemoryInBytes

      @Nonnull public final SegmentsStats.Builder fixedBitSetMemoryInBytes(long value)
      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

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

      API name: index_writer_max_memory_in_bytes

    • indexWriterMemory

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

      API name: index_writer_memory

    • indexWriterMemoryInBytes

      @Nonnull public final SegmentsStats.Builder indexWriterMemoryInBytes(long value)
      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

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

      API name: max_unsafe_auto_id_timestamp

    • memory

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

      API name: memory

    • memoryInBytes

      @Nonnull public final SegmentsStats.Builder memoryInBytes(long value)
      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

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

      API name: norms_memory

    • normsMemoryInBytes

      @Nonnull public final SegmentsStats.Builder normsMemoryInBytes(long value)
      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

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

      API name: points_memory

    • pointsMemoryInBytes

      @Nonnull public final SegmentsStats.Builder pointsMemoryInBytes(long value)
      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

      @Nonnull public final SegmentsStats.Builder remoteStore(@Nullable RemoteStoreStats value)
      API name: remote_store
    • remoteStore

      API name: remote_store
    • segmentReplication

      @Nonnull public final SegmentsStats.Builder segmentReplication(@Nullable SegmentReplicationStats value)
      API name: segment_replication
    • segmentReplication

      API name: segment_replication
    • storedFieldsMemory

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

      API name: stored_fields_memory

    • storedFieldsMemoryInBytes

      @Nonnull public final SegmentsStats.Builder storedFieldsMemoryInBytes(long value)
      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

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

      API name: term_vectors_memory

    • termVectorsMemoryInBytes

      @Nonnull public final SegmentsStats.Builder termVectorsMemoryInBytes(long value)
      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

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

      API name: terms_memory

    • termsMemoryInBytes

      @Nonnull public final SegmentsStats.Builder termsMemoryInBytes(long value)
      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

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

      API name: version_map_memory

    • versionMapMemoryInBytes

      @Nonnull public final SegmentsStats.Builder versionMapMemoryInBytes(long value)
      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

    • build

      @Nonnull public SegmentsStats build()
      Builds a SegmentsStats.
      Specified by:
      build in interface ObjectBuilder<SegmentsStats>
      Throws:
      NullPointerException - if some of the required fields are null.