Package co.elastic.clients.elasticsearch.cat

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TransformsRequest.Builder	allowNoMatch(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.
TransformsRequest	build()	Builds a TransformsRequest.
final TransformsRequest.Builder	from(Integer value)	Skips the specified number of transforms.
final TransformsRequest.Builder	h(CatTransformColumn value, CatTransformColumn... values)	Comma-separated list of column names to display.
final TransformsRequest.Builder	h(List<CatTransformColumn> list)	Comma-separated list of column names to display.
final TransformsRequest.Builder	s(CatTransformColumn value, CatTransformColumn... values)	Comma-separated list of column names or column aliases used to sort the response.
final TransformsRequest.Builder	s(List<CatTransformColumn> list)	Comma-separated list of column names or column aliases used to sort the response.
protected TransformsRequest.Builder	self()
final TransformsRequest.Builder	size(Integer value)	The maximum number of transforms to obtain.
final TransformsRequest.Builder	time(TimeUnit value)	The unit used to display time values.
final TransformsRequest.Builder	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoMatch

public final TransformsRequest.Builder allowNoMatch(@Nullable
 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. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

API name: allow_no_match

from

public final TransformsRequest.Builder from(@Nullable
 Integer value)

Skips the specified number of transforms.

API name: from

h

public final TransformsRequest.Builder h(List<CatTransformColumn> list)

Comma-separated list of column names to display.

API name: h

Adds all elements of list to h.

h

public final TransformsRequest.Builder h(CatTransformColumn value,
 CatTransformColumn... values)

Comma-separated list of column names to display.

API name: h

Adds one or more values to h.

s

public final TransformsRequest.Builder s(List<CatTransformColumn> list)

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

API name: s

Adds all elements of list to s.

s

public final TransformsRequest.Builder s(CatTransformColumn value,
 CatTransformColumn... values)

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

public final TransformsRequest.Builder size(@Nullable
 Integer value)

The maximum number of transforms to obtain.

API name: size

time

public final TransformsRequest.Builder time(@Nullable
 TimeUnit value)

The unit used to display time values.

API name: time

transformId

public final TransformsRequest.Builder transformId(@Nullable
 String value)

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

protected TransformsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<TransformsRequest.Builder>

build

public TransformsRequest build()

Builds a TransformsRequest.

Specified by:

build in interface ObjectBuilder<TransformsRequest>

Throws:

NullPointerException - if some of the required fields are null.