Class BucketSortAggregation
java.lang.Object
org.opensearch.client.opensearch._types.aggregations.AggregationBase
org.opensearch.client.opensearch._types.aggregations.BucketSortAggregation
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,AggregationVariant,ToCopyableBuilder<BucketSortAggregation.Builder,BucketSortAggregation>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class BucketSortAggregation
extends AggregationBase
implements AggregationVariant, ToCopyableBuilder<BucketSortAggregation.Builder,BucketSortAggregation>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase
AggregationBase.AbstractBuilder<BuilderT extends AggregationBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<BucketSortAggregation> Json deserializer forBucketSortAggregation -
Method Summary
Modifier and TypeMethodDescriptionAggregationvariant kind.builder()booleanfinal Integerfrom()Buckets in positions prior tofromwill be truncated.final GapPolicyAPI name:gap_policyinthashCode()static BucketSortAggregationprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal Integersize()The number of buckets to return.final List<SortOptions> sort()API name:sortCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant
toAggregationMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forBucketSortAggregation
-
-
Method Details
-
of
public static BucketSortAggregation of(Function<BucketSortAggregation.Builder, ObjectBuilder<BucketSortAggregation>> fn) -
_aggregationKind
Aggregationvariant kind.- Specified by:
_aggregationKindin interfaceAggregationVariant
-
from
Buckets in positions prior tofromwill be truncated.API name:
from -
gapPolicy
API name:gap_policy -
size
The number of buckets to return. Defaults to all buckets of the parent aggregation.API name:
size -
sort
API name:sort -
serializeInternal
- Overrides:
serializeInternalin classAggregationBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<BucketSortAggregation.Builder,BucketSortAggregation> - Returns:
- a new builder instance.
-
builder
-
setupBucketSortAggregationDeserializer
protected static void setupBucketSortAggregationDeserializer(ObjectDeserializer<BucketSortAggregation.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classAggregationBase
-
equals
- Overrides:
equalsin classAggregationBase
-