GroupBy (java-client 2.14.0 API)

java.lang.Object
- java.lang.Enum<GroupBy>
- - org.opensearch.client.opensearch.tasks.GroupBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GroupBy>, JsonEnum, JsonpSerializable
```
@JsonpDeserializable
public enum GroupBy
extends java.lang.Enum<GroupBy>
implements JsonEnum
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum
  JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants
Enum Constant Description

Nodes

None

Parents

Field Summary

Fields
Modifier and Type Field Description

static JsonEnum.Deserializer<GroupBy> _DESERIALIZER

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`jsonValue()`
`static GroupBy`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static GroupBy[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.JsonEnum
aliases, serialize

- Enum Constant Detail
  - Nodes
```
public static final GroupBy Nodes
```
  - Parents
```
public static final GroupBy Parents
```
  - None
```
public static final GroupBy None
```
- Field Detail
  - _DESERIALIZER
```
public static final JsonEnum.Deserializer<GroupBy> _DESERIALIZER
```
- Method Detail
  - values
```
public static GroupBy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (GroupBy c : GroupBy.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GroupBy valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - jsonValue
```
public java.lang.String jsonValue()
```
    Specified by:
    
    jsonValue in interface JsonEnum