Package co.elastic.clients.elasticsearch.ml

Class GetInfluencersRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<GetInfluencersRequest>

Enclosing class:

GetInfluencersRequest

public static class GetInfluencersRequest.Builder
extends java.lang.Object
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(java.lang.String 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)	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
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(java.lang.String value)	Returns influencers with timestamps after this time.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobId

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

Identifier for the anomaly detection job.

API name: job_id

desc

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

If true, the results are sorted in descending order.

API name: desc

end

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

Returns influencers with timestamps earlier than this time.

API name: end

excludeInterim

public 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

influencerScore

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

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

API name: influencer_score

from

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

Skips the specified number of influencers.

API name: from

size

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

Specifies the maximum number of influencers to obtain.

API name: size

sort

public 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 GetInfluencersRequest.Builder start(@Nullable
java.lang.String value)

Returns influencers with timestamps after this time.

API name: start

page

public GetInfluencersRequest.Builder page(@Nullable
Page value)

API name: page

page

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

API name: page

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.