Package co.elastic.clients.elasticsearch.ml

Class GetInfluencersRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GetInfluencersRequest.Builder>

co.elastic.clients.elasticsearch.ml.GetInfluencersRequest.Builder

All Implemented Interfaces:

WithJson<GetInfluencersRequest.Builder>, ObjectBuilder<GetInfluencersRequest>

Enclosing class:

GetInfluencersRequest

public static class GetInfluencersRequest.Builder
extends WithJsonObjectBuilderBase<GetInfluencersRequest.Builder>
implements ObjectBuilder<GetInfluencersRequest>

Builder for GetInfluencersRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetInfluencersRequest	build()	Builds a GetInfluencersRequest.
GetInfluencersRequest.Builder	desc(java.lang.Boolean value)	If true, the results are sorted in descending order.
GetInfluencersRequest.Builder	end(DateTime value)	Returns influencers with timestamps earlier than this time.
GetInfluencersRequest.Builder	excludeInterim(java.lang.Boolean value)	If true, the output excludes interim results.
GetInfluencersRequest.Builder	from(java.lang.Integer value)	Skips the specified number of influencers.
GetInfluencersRequest.Builder	influencerScore(java.lang.Double value)	Returns influencers with anomaly scores greater than or equal to this value.
GetInfluencersRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
GetInfluencersRequest.Builder	page(Page value)	API name: page
GetInfluencersRequest.Builder	page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)	API name: page
protected GetInfluencersRequest.Builder	self()
GetInfluencersRequest.Builder	size(java.lang.Integer value)	Specifies the maximum number of influencers to obtain.
GetInfluencersRequest.Builder	sort(java.lang.String value)	Specifies the sort field for the requested influencers.
GetInfluencersRequest.Builder	start(DateTime value)	Returns influencers with timestamps after this time.

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

desc

public final GetInfluencersRequest.Builder desc(@Nullable
java.lang.Boolean value)

If true, the results are sorted in descending order.

API name: desc

end

public final GetInfluencersRequest.Builder end(@Nullable
DateTime value)

Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps.

API name: end

excludeInterim

public final GetInfluencersRequest.Builder excludeInterim(@Nullable
java.lang.Boolean value)

If true, the output excludes interim results. By default, interim results are included.

API name: exclude_interim

from

public final GetInfluencersRequest.Builder from(@Nullable
java.lang.Integer value)

Skips the specified number of influencers.

API name: from

influencerScore

public final GetInfluencersRequest.Builder influencerScore(@Nullable
java.lang.Double value)

Returns influencers with anomaly scores greater than or equal to this value.

API name: influencer_score

jobId

public final GetInfluencersRequest.Builder jobId(java.lang.String value)

Required - Identifier for the anomaly detection job.

API name: job_id

page

public final GetInfluencersRequest.Builder page(@Nullable
Page value)

API name: page

page

public final GetInfluencersRequest.Builder page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)

API name: page

size

public final GetInfluencersRequest.Builder size(@Nullable
java.lang.Integer value)

Specifies the maximum number of influencers to obtain.

API name: size

sort

public final GetInfluencersRequest.Builder sort(@Nullable
java.lang.String value)

Specifies the sort field for the requested influencers. By default, the influencers are sorted by the influencer_score value.

API name: sort

start

public final GetInfluencersRequest.Builder start(@Nullable
DateTime value)

Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps.

API name: start

self

protected GetInfluencersRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GetInfluencersRequest.Builder>

build

public GetInfluencersRequest build()

Builds a GetInfluencersRequest.

Specified by:

build in interface ObjectBuilder<GetInfluencersRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.