Package org.opensearch.protobufs

Interface StringTermsBucketOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StringTermsBucket, StringTermsBucket.Builder
public interface StringTermsBucketOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsAggregate(String key)
    map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];
    Map<String,Aggregate>
    getAggregate()
    Deprecated.
    int
    getAggregateCount()
    map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];
    Map<String,Aggregate>
    getAggregateMap()
    map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];
    Aggregate
    getAggregateOrDefault(String key, Aggregate defaultValue)
    map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];
    Aggregate
    getAggregateOrThrow(String key)
    map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];
    long
    getDocCount()
    int64 doc_count = 1 [json_name = "docCount"];
    long
    getDocCountErrorUpperBound()
    optional int64 doc_count_error_upper_bound = 3 [json_name = "docCountErrorUpperBound"];
    String
    getKey()
    string key = 4 [json_name = "key"];
    com.google.protobuf.ByteString
    getKeyBytes()
    string key = 4 [json_name = "key"];
    boolean
    hasDocCountErrorUpperBound()
    optional int64 doc_count_error_upper_bound = 3 [json_name = "docCountErrorUpperBound"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDocCount

      long getDocCount()
      int64 doc_count = 1 [json_name = "docCount"];
      Returns:
      The docCount.

    • getAggregateCount

      int getAggregateCount()
      map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];

    • containsAggregate

      boolean containsAggregate(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];

    • getAggregate

      @Deprecated Map<String,Aggregate> getAggregate()
      Deprecated.
      Use getAggregateMap() instead.

    • getAggregateMap

      Map<String,Aggregate> getAggregateMap()
      map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];

    • getAggregateOrDefault

      Aggregate getAggregateOrDefault(String key, Aggregate defaultValue)
      map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];

    • getAggregateOrThrow

      Aggregate getAggregateOrThrow(String key)
      map<string, .org.opensearch.protobufs.Aggregate> aggregate = 2 [json_name = "aggregate"];

    • hasDocCountErrorUpperBound

      boolean hasDocCountErrorUpperBound()
      optional int64 doc_count_error_upper_bound = 3 [json_name = "docCountErrorUpperBound"];
      Returns:
      Whether the docCountErrorUpperBound field is set.

    • getDocCountErrorUpperBound

      long getDocCountErrorUpperBound()
      optional int64 doc_count_error_upper_bound = 3 [json_name = "docCountErrorUpperBound"];
      Returns:
      The docCountErrorUpperBound.

    • getKey

      String getKey()
      string key = 4 [json_name = "key"];
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
      string key = 4 [json_name = "key"];
      Returns:
      The bytes for key.