Package org.opensearch.protobufs
Enum Class TermsAggregationCollectMode
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<TermsAggregationCollectMode>,Constable
public enum TermsAggregationCollectMode
extends Enum<TermsAggregationCollectMode>
implements com.google.protobuf.ProtocolMessageEnum
Protobuf enum
org.opensearch.protobufs.TermsAggregationCollectMode-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionTERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST = 1;TERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST = 2;TERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED = 0; -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intTERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST = 1;static final intTERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST = 2;static final intTERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED = 0; -
Method Summary
Modifier and TypeMethodDescriptionstatic TermsAggregationCollectModeforNumber(int value) static final com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<TermsAggregationCollectMode> static TermsAggregationCollectModevalueOf(int value) Deprecated.static TermsAggregationCollectModevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name.static TermsAggregationCollectModeReturns the enum constant of this class with the specified name.static TermsAggregationCollectMode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
TERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED
TERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED = 0; -
TERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST
TERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST = 1; -
TERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST
TERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST = 2; -
UNRECOGNIZED
-
-
Field Details
-
TERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED_VALUE
public static final int TERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED_VALUETERMS_AGGREGATION_COLLECT_MODE_UNSPECIFIED = 0;- See Also:
-
TERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST_VALUE
public static final int TERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST_VALUETERMS_AGGREGATION_COLLECT_MODE_BREADTH_FIRST = 1;- See Also:
-
TERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST_VALUE
public static final int TERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST_VALUETERMS_AGGREGATION_COLLECT_MODE_DEPTH_FIRST = 2;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
value- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
forNumber
- Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
public static com.google.protobuf.Internal.EnumLiteMap<TermsAggregationCollectMode> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static TermsAggregationCollectMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
desc- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-