Class TermsAggregationFields

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.opensearch.protobufs.TermsAggregationFields
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, TermsAggregationFieldsOrBuilder

public final class TermsAggregationFields extends com.google.protobuf.GeneratedMessageV3 implements TermsAggregationFieldsOrBuilder
Protobuf type org.opensearch.protobufs.TermsAggregationFields
See Also:
  • Field Details

    • COLLECT_MODE_FIELD_NUMBER

      public static final int COLLECT_MODE_FIELD_NUMBER
      See Also:
    • EXCLUDE_FIELD_NUMBER

      public static final int EXCLUDE_FIELD_NUMBER
      See Also:
    • EXECUTION_HINT_FIELD_NUMBER

      public static final int EXECUTION_HINT_FIELD_NUMBER
      See Also:
    • INCLUDE_FIELD_NUMBER

      public static final int INCLUDE_FIELD_NUMBER
      See Also:
    • MIN_DOC_COUNT_FIELD_NUMBER

      public static final int MIN_DOC_COUNT_FIELD_NUMBER
      See Also:
    • MISSING_FIELD_NUMBER

      public static final int MISSING_FIELD_NUMBER
      See Also:
    • VALUE_TYPE_FIELD_NUMBER

      public static final int VALUE_TYPE_FIELD_NUMBER
      See Also:
    • ORDER_FIELD_NUMBER

      public static final int ORDER_FIELD_NUMBER
      See Also:
    • SHARD_SIZE_FIELD_NUMBER

      public static final int SHARD_SIZE_FIELD_NUMBER
      See Also:
    • SHARD_MIN_DOC_COUNT_FIELD_NUMBER

      public static final int SHARD_MIN_DOC_COUNT_FIELD_NUMBER
      See Also:
    • SHOW_TERM_DOC_COUNT_ERROR_FIELD_NUMBER

      public static final int SHOW_TERM_DOC_COUNT_ERROR_FIELD_NUMBER
      See Also:
    • SIZE_FIELD_NUMBER

      public static final int SIZE_FIELD_NUMBER
      See Also:
    • FORMAT_FIELD_NUMBER

      public static final int FORMAT_FIELD_NUMBER
      See Also:
    • FIELD_FIELD_NUMBER

      public static final int FIELD_FIELD_NUMBER
      See Also:
    • SCRIPT_FIELD_NUMBER

      public static final int SCRIPT_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • hasCollectMode

      public boolean hasCollectMode()
      optional .org.opensearch.protobufs.TermsAggregationCollectMode collect_mode = 1 [json_name = "collectMode"];
      Specified by:
      hasCollectMode in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the collectMode field is set.
    • getCollectModeValue

      public int getCollectModeValue()
      optional .org.opensearch.protobufs.TermsAggregationCollectMode collect_mode = 1 [json_name = "collectMode"];
      Specified by:
      getCollectModeValue in interface TermsAggregationFieldsOrBuilder
      Returns:
      The enum numeric value on the wire for collectMode.
    • getCollectMode

      public TermsAggregationCollectMode getCollectMode()
      optional .org.opensearch.protobufs.TermsAggregationCollectMode collect_mode = 1 [json_name = "collectMode"];
      Specified by:
      getCollectMode in interface TermsAggregationFieldsOrBuilder
      Returns:
      The collectMode.
    • hasExclude

      public boolean hasExclude()
      optional .org.opensearch.protobufs.TermsExclude exclude = 2 [json_name = "exclude"];
      Specified by:
      hasExclude in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the exclude field is set.
    • getExclude

      public TermsExclude getExclude()
      optional .org.opensearch.protobufs.TermsExclude exclude = 2 [json_name = "exclude"];
      Specified by:
      getExclude in interface TermsAggregationFieldsOrBuilder
      Returns:
      The exclude.
    • getExcludeOrBuilder

      public TermsExcludeOrBuilder getExcludeOrBuilder()
      optional .org.opensearch.protobufs.TermsExclude exclude = 2 [json_name = "exclude"];
      Specified by:
      getExcludeOrBuilder in interface TermsAggregationFieldsOrBuilder
    • hasExecutionHint

      public boolean hasExecutionHint()
      optional .org.opensearch.protobufs.TermsAggregationExecutionHint execution_hint = 3 [json_name = "executionHint"];
      Specified by:
      hasExecutionHint in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the executionHint field is set.
    • getExecutionHintValue

      public int getExecutionHintValue()
      optional .org.opensearch.protobufs.TermsAggregationExecutionHint execution_hint = 3 [json_name = "executionHint"];
      Specified by:
      getExecutionHintValue in interface TermsAggregationFieldsOrBuilder
      Returns:
      The enum numeric value on the wire for executionHint.
    • getExecutionHint

      public TermsAggregationExecutionHint getExecutionHint()
      optional .org.opensearch.protobufs.TermsAggregationExecutionHint execution_hint = 3 [json_name = "executionHint"];
      Specified by:
      getExecutionHint in interface TermsAggregationFieldsOrBuilder
      Returns:
      The executionHint.
    • hasInclude

      public boolean hasInclude()
      optional .org.opensearch.protobufs.TermsInclude include = 4 [json_name = "include"];
      Specified by:
      hasInclude in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the include field is set.
    • getInclude

      public TermsInclude getInclude()
      optional .org.opensearch.protobufs.TermsInclude include = 4 [json_name = "include"];
      Specified by:
      getInclude in interface TermsAggregationFieldsOrBuilder
      Returns:
      The include.
    • getIncludeOrBuilder

      public TermsIncludeOrBuilder getIncludeOrBuilder()
      optional .org.opensearch.protobufs.TermsInclude include = 4 [json_name = "include"];
      Specified by:
      getIncludeOrBuilder in interface TermsAggregationFieldsOrBuilder
    • hasMinDocCount

      public boolean hasMinDocCount()
      optional int64 min_doc_count = 5 [json_name = "minDocCount"];
      Specified by:
      hasMinDocCount in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the minDocCount field is set.
    • getMinDocCount

      public long getMinDocCount()
      optional int64 min_doc_count = 5 [json_name = "minDocCount"];
      Specified by:
      getMinDocCount in interface TermsAggregationFieldsOrBuilder
      Returns:
      The minDocCount.
    • hasMissing

      public boolean hasMissing()
      optional .org.opensearch.protobufs.FieldValue missing = 6 [json_name = "missing"];
      Specified by:
      hasMissing in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the missing field is set.
    • getMissing

      public FieldValue getMissing()
      optional .org.opensearch.protobufs.FieldValue missing = 6 [json_name = "missing"];
      Specified by:
      getMissing in interface TermsAggregationFieldsOrBuilder
      Returns:
      The missing.
    • getMissingOrBuilder

      public FieldValueOrBuilder getMissingOrBuilder()
      optional .org.opensearch.protobufs.FieldValue missing = 6 [json_name = "missing"];
      Specified by:
      getMissingOrBuilder in interface TermsAggregationFieldsOrBuilder
    • hasValueType

      public boolean hasValueType()
      optional .org.opensearch.protobufs.ValueType value_type = 7 [json_name = "valueType"];
      Specified by:
      hasValueType in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the valueType field is set.
    • getValueTypeValue

      public int getValueTypeValue()
      optional .org.opensearch.protobufs.ValueType value_type = 7 [json_name = "valueType"];
      Specified by:
      getValueTypeValue in interface TermsAggregationFieldsOrBuilder
      Returns:
      The enum numeric value on the wire for valueType.
    • getValueType

      public ValueType getValueType()
      optional .org.opensearch.protobufs.ValueType value_type = 7 [json_name = "valueType"];
      Specified by:
      getValueType in interface TermsAggregationFieldsOrBuilder
      Returns:
      The valueType.
    • getOrderList

      public List<SortOrderSingleMap> getOrderList()
      repeated .org.opensearch.protobufs.SortOrderSingleMap order = 8 [json_name = "order"];
      Specified by:
      getOrderList in interface TermsAggregationFieldsOrBuilder
    • getOrderOrBuilderList

      public List<? extends SortOrderSingleMapOrBuilder> getOrderOrBuilderList()
      repeated .org.opensearch.protobufs.SortOrderSingleMap order = 8 [json_name = "order"];
      Specified by:
      getOrderOrBuilderList in interface TermsAggregationFieldsOrBuilder
    • getOrderCount

      public int getOrderCount()
      repeated .org.opensearch.protobufs.SortOrderSingleMap order = 8 [json_name = "order"];
      Specified by:
      getOrderCount in interface TermsAggregationFieldsOrBuilder
    • getOrder

      public SortOrderSingleMap getOrder(int index)
      repeated .org.opensearch.protobufs.SortOrderSingleMap order = 8 [json_name = "order"];
      Specified by:
      getOrder in interface TermsAggregationFieldsOrBuilder
    • getOrderOrBuilder

      public SortOrderSingleMapOrBuilder getOrderOrBuilder(int index)
      repeated .org.opensearch.protobufs.SortOrderSingleMap order = 8 [json_name = "order"];
      Specified by:
      getOrderOrBuilder in interface TermsAggregationFieldsOrBuilder
    • hasShardSize

      public boolean hasShardSize()
      optional int32 shard_size = 9 [json_name = "shardSize"];
      Specified by:
      hasShardSize in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the shardSize field is set.
    • getShardSize

      public int getShardSize()
      optional int32 shard_size = 9 [json_name = "shardSize"];
      Specified by:
      getShardSize in interface TermsAggregationFieldsOrBuilder
      Returns:
      The shardSize.
    • hasShardMinDocCount

      public boolean hasShardMinDocCount()
      optional int64 shard_min_doc_count = 10 [json_name = "shardMinDocCount"];
      Specified by:
      hasShardMinDocCount in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the shardMinDocCount field is set.
    • getShardMinDocCount

      public long getShardMinDocCount()
      optional int64 shard_min_doc_count = 10 [json_name = "shardMinDocCount"];
      Specified by:
      getShardMinDocCount in interface TermsAggregationFieldsOrBuilder
      Returns:
      The shardMinDocCount.
    • hasShowTermDocCountError

      public boolean hasShowTermDocCountError()
      optional bool show_term_doc_count_error = 11 [json_name = "showTermDocCountError"];
      Specified by:
      hasShowTermDocCountError in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the showTermDocCountError field is set.
    • getShowTermDocCountError

      public boolean getShowTermDocCountError()
      optional bool show_term_doc_count_error = 11 [json_name = "showTermDocCountError"];
      Specified by:
      getShowTermDocCountError in interface TermsAggregationFieldsOrBuilder
      Returns:
      The showTermDocCountError.
    • hasSize

      public boolean hasSize()
      optional int32 size = 12 [json_name = "size"];
      Specified by:
      hasSize in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the size field is set.
    • getSize

      public int getSize()
      optional int32 size = 12 [json_name = "size"];
      Specified by:
      getSize in interface TermsAggregationFieldsOrBuilder
      Returns:
      The size.
    • hasFormat

      public boolean hasFormat()
      optional string format = 13 [json_name = "format"];
      Specified by:
      hasFormat in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the format field is set.
    • getFormat

      public String getFormat()
      optional string format = 13 [json_name = "format"];
      Specified by:
      getFormat in interface TermsAggregationFieldsOrBuilder
      Returns:
      The format.
    • getFormatBytes

      public com.google.protobuf.ByteString getFormatBytes()
      optional string format = 13 [json_name = "format"];
      Specified by:
      getFormatBytes in interface TermsAggregationFieldsOrBuilder
      Returns:
      The bytes for format.
    • hasField

      public boolean hasField()
      optional string field = 14 [json_name = "field"];
      Specified by:
      hasField in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the field field is set.
    • getField

      public String getField()
      optional string field = 14 [json_name = "field"];
      Specified by:
      getField in interface TermsAggregationFieldsOrBuilder
      Returns:
      The field.
    • getFieldBytes

      public com.google.protobuf.ByteString getFieldBytes()
      optional string field = 14 [json_name = "field"];
      Specified by:
      getFieldBytes in interface TermsAggregationFieldsOrBuilder
      Returns:
      The bytes for field.
    • hasScript

      public boolean hasScript()
      optional .org.opensearch.protobufs.Script script = 15 [json_name = "script"];
      Specified by:
      hasScript in interface TermsAggregationFieldsOrBuilder
      Returns:
      Whether the script field is set.
    • getScript

      public Script getScript()
      optional .org.opensearch.protobufs.Script script = 15 [json_name = "script"];
      Specified by:
      getScript in interface TermsAggregationFieldsOrBuilder
      Returns:
      The script.
    • getScriptOrBuilder

      public ScriptOrBuilder getScriptOrBuilder()
      optional .org.opensearch.protobufs.Script script = 15 [json_name = "script"];
      Specified by:
      getScriptOrBuilder in interface TermsAggregationFieldsOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static TermsAggregationFields parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static TermsAggregationFields parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TermsAggregationFields parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TermsAggregationFields parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TermsAggregationFields parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TermsAggregationFields parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TermsAggregationFields parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public TermsAggregationFields.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static TermsAggregationFields.Builder newBuilder()
    • newBuilder

      public static TermsAggregationFields.Builder newBuilder(TermsAggregationFields prototype)
    • toBuilder

      public TermsAggregationFields.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected TermsAggregationFields.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static TermsAggregationFields getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<TermsAggregationFields> parser()
    • getParserForType

      public com.google.protobuf.Parser<TermsAggregationFields> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public TermsAggregationFields getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder