Package co.elastic.clients.elasticsearch.rollup

Class GetRollupCapsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.rollup.GetRollupCapsRequest

@Deprecated
public class GetRollupCapsRequest
extends RequestBase

Deprecated.

8.11.0

Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine:

1. Does this index have associated rollup data somewhere in the cluster?
2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetRollupCapsRequest.Builder	Deprecated.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetRollupCapsRequest,GetRollupCapsResponse,ErrorResponse>	_ENDPOINT	Deprecated. Endpoint "rollup.get_rollup_caps".

Method Summary

Modifier and Type	Method	Description
final String	id()	Deprecated. Index, indices or index-pattern to return rollup capabilities for.
static GetRollupCapsRequest	of(Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)	Deprecated.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetRollupCapsRequest,GetRollupCapsResponse,ErrorResponse> _ENDPOINT

Deprecated.

Endpoint "rollup.get_rollup_caps".

Method Details

of

public static GetRollupCapsRequest of(Function<GetRollupCapsRequest.Builder,ObjectBuilder<GetRollupCapsRequest>> fn)

Deprecated.

id

@Nullable
public final String id()

Deprecated.

Index, indices or index-pattern to return rollup capabilities for. _all may be used to fetch rollup capabilities from all jobs.

API name: id