Package co.elastic.clients.elasticsearch.cat

Class TransformsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.TransformsRequest

public class TransformsRequest
extends CatRequestBase

Returns configuration and usage information about transforms.

IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransformsRequest.Builder	Builder for TransformsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<TransformsRequest,TransformsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.transforms".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoMatch()	Whether to ignore if a wildcard expression matches no transforms.
final Integer	from()	skips a number of transform configs, defaults to 0
final List<CatTransformColumn>	h()	Comma-separated list of column names to display.
static TransformsRequest	of(Function<TransformsRequest.Builder,ObjectBuilder<TransformsRequest>> fn)
final List<CatTransformColumn>	s()	Comma-separated list of column names or column aliases used to sort the response.
final Integer	size()	specifies a max number of transforms to get, defaults to 100
final TimeUnit	time()	Unit used to display time values.
final String	transformId()	The id of the transform for which to get stats.

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<TransformsRequest,TransformsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.transforms".

Method Details

of

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

allowNoMatch

@Nullable
public final Boolean allowNoMatch()

Whether to ignore if a wildcard expression matches no transforms. (This includes _all string or when no transforms have been specified)

API name: allow_no_match

from

@Nullable
public final Integer from()

skips a number of transform configs, defaults to 0

API name: from

h

public final List<CatTransformColumn> h()

Comma-separated list of column names to display.

API name: h

s

public final List<CatTransformColumn> s()

Comma-separated list of column names or column aliases used to sort the response.

API name: s

size

@Nullable
public final Integer size()

specifies a max number of transforms to get, defaults to 100

API name: size

time

@Nullable
public final TimeUnit time()

Unit used to display time values.

API name: time

transformId

@Nullable
public final String transformId()

The id of the transform for which to get stats. '_all' or '*' implies all transforms

API name: transform_id