Class TransformsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<TransformsRequest.Builder>
co.elastic.clients.elasticsearch.cat.TransformsRequest.Builder
- All Implemented Interfaces:
WithJson<TransformsRequest.Builder>
,ObjectBuilder<TransformsRequest>
- Enclosing class:
- TransformsRequest
public static class TransformsRequest.Builder
extends CatRequestBase.AbstractBuilder<TransformsRequest.Builder>
implements ObjectBuilder<TransformsRequest>
Builder for
TransformsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoMatch
(Boolean value) 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.build()
Builds aTransformsRequest
.Skips the specified number of transforms.h
(CatTransformColumn value, CatTransformColumn... values) Comma-separated list of column names to display.h
(List<CatTransformColumn> list) Comma-separated list of column names to display.s
(CatTransformColumn value, CatTransformColumn... values) Comma-separated list of column names or column aliases used to sort the response.s
(List<CatTransformColumn> list) Comma-separated list of column names or column aliases used to sort the response.protected TransformsRequest.Builder
self()
The maximum number of transforms to obtain.The unit used to display time values.transformId
(String value) A transform identifier or a wildcard expression.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toh
. -
h
Comma-separated list of column names to display.API name:
h
Adds one or more values to
h
. -
s
Comma-separated list of column names or column aliases used to sort the response.API name:
s
Adds all elements of
list
tos
. -
s
Comma-separated list of column names or column aliases used to sort the response.API name:
s
Adds one or more values to
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
-
self
- Specified by:
self
in classCatRequestBase.AbstractBuilder<TransformsRequest.Builder>
-
build
Builds aTransformsRequest
.- Specified by:
build
in interfaceObjectBuilder<TransformsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-