Class TransformsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.TransformsRequest
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<TransformsRequest,
TransformsResponse, ErrorResponse> Endpoint "cat.transforms
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the_all
string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.final Integer
from()
Skips the specified number of transforms.final List<CatTransformColumn>
h()
Comma-separated list of column names to display.static TransformsRequest
final List<CatTransformColumn>
s()
Comma-separated list of column names or column aliases used to sort the response.final Integer
size()
The maximum number of transforms to obtain.final TimeUnit
time()
The unit used to display time values.final String
A transform identifier or a wildcard expression.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.transforms
".
-
-
Method Details
-
of
public static TransformsRequest of(Function<TransformsRequest.Builder, ObjectBuilder<TransformsRequest>> fn) -
allowNoMatch
Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the_all
string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. Iftrue
, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. Iffalse
, the request returns a 404 status code when there are no matches or only partial matches.API name:
allow_no_match
-
from
Skips the specified number of transforms.API name:
from
-
h
Comma-separated list of column names to display.API name:
h
-
s
Comma-separated list of column names or column aliases used to sort the response.API name:
s
-
size
The maximum number of transforms to obtain.API name:
size
-
time
The unit used to display time values.API name:
time
-
transformId
A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.API name:
transform_id
-