Package co.elastic.clients.elasticsearch.transform

Class GetTransformStatsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTransformStatsRequest.Builder>

co.elastic.clients.elasticsearch.transform.GetTransformStatsRequest.Builder

All Implemented Interfaces:

WithJson<GetTransformStatsRequest.Builder>, ObjectBuilder<GetTransformStatsRequest>

Enclosing class:

GetTransformStatsRequest

public static class GetTransformStatsRequest.Builder
extends RequestBase.AbstractBuilder<GetTransformStatsRequest.Builder>
implements ObjectBuilder<GetTransformStatsRequest>

Builder for GetTransformStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetTransformStatsRequest.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.
final GetTransformStatsRequest.Builder	basic(Boolean value)	If true, the response includes id, state, node, stats, health, and basic checkpointing information (the last and next checkpoint numbers, and the next checkpoint's position and progress).
GetTransformStatsRequest	build()	Builds a GetTransformStatsRequest.
final GetTransformStatsRequest.Builder	from(Long value)	Skips the specified number of transforms.
protected GetTransformStatsRequest.Builder	self()
final GetTransformStatsRequest.Builder	size(Long value)	Specifies the maximum number of transforms to obtain.
final GetTransformStatsRequest.Builder	timeout(Time value)	Controls the time to wait for the stats
final GetTransformStatsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Controls the time to wait for the stats
final GetTransformStatsRequest.Builder	transformId(String value, String... values)	Required - Identifier for the transform.
final GetTransformStatsRequest.Builder	transformId(List<String> list)	Required - Identifier for the transform.

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 GetTransformStatsRequest.Builder allowNoMatch(@Nullable
 Boolean value)

Specifies what to do when the request:

1. Contains wildcard expressions and there are no transforms that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches.

If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

API name: allow_no_match

basic

public final GetTransformStatsRequest.Builder basic(@Nullable
 Boolean value)

If true, the response includes id, state, node, stats, health, and basic checkpointing information (the last and next checkpoint numbers, and the next checkpoint's position and progress). Skips statistics that require heavy computations to calculate: operations_behind, changes_last_detected_at, last_search_time, and the checkpoint timestamps.

API name: basic

from

public final GetTransformStatsRequest.Builder from(@Nullable
 Long value)

Skips the specified number of transforms.

API name: from

size

public final GetTransformStatsRequest.Builder size(@Nullable
 Long value)

Specifies the maximum number of transforms to obtain.

API name: size

timeout

public final GetTransformStatsRequest.Builder timeout(@Nullable
 Time value)

Controls the time to wait for the stats

API name: timeout

timeout

public final GetTransformStatsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Controls the time to wait for the stats

API name: timeout

transformId

public final GetTransformStatsRequest.Builder transformId(List<String> list)

Required - Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

API name: transform_id

Adds all elements of list to transformId.

transformId

public final GetTransformStatsRequest.Builder transformId(String value,
 String... values)

Required - Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

API name: transform_id

Adds one or more values to transformId.

self

protected GetTransformStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTransformStatsRequest.Builder>

build

public GetTransformStatsRequest build()

Builds a GetTransformStatsRequest.

Specified by:

build in interface ObjectBuilder<GetTransformStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.