Package co.elastic.clients.elasticsearch.ml

Class GetDataFrameAnalyticsStatsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsStatsRequest.Builder

All Implemented Interfaces:

WithJson<GetDataFrameAnalyticsStatsRequest.Builder>, ObjectBuilder<GetDataFrameAnalyticsStatsRequest>

Enclosing class:

GetDataFrameAnalyticsStatsRequest

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

Builder for GetDataFrameAnalyticsStatsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetDataFrameAnalyticsStatsRequest.Builder	allowNoMatch(Boolean value)	Specifies what to do when the request: Contains wildcard expressions and there are no data frame analytics jobs that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.
GetDataFrameAnalyticsStatsRequest	build()	Builds a GetDataFrameAnalyticsStatsRequest.
final GetDataFrameAnalyticsStatsRequest.Builder	from(Integer value)	Skips the specified number of data frame analytics jobs.
final GetDataFrameAnalyticsStatsRequest.Builder	id(String value)	Identifier for the data frame analytics job.
protected GetDataFrameAnalyticsStatsRequest.Builder	self()
final GetDataFrameAnalyticsStatsRequest.Builder	size(Integer value)	Specifies the maximum number of data frame analytics jobs to obtain.
final GetDataFrameAnalyticsStatsRequest.Builder	verbose(Boolean value)	Defines whether the stats response should be verbose.

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

Specifies what to do when the request:

1. Contains wildcard expressions and there are no data frame analytics jobs 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.

The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are 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

from

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

Skips the specified number of data frame analytics jobs.

API name: from

id

public final GetDataFrameAnalyticsStatsRequest.Builder id(@Nullable
 String value)

Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.

API name: id

size

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

Specifies the maximum number of data frame analytics jobs to obtain.

API name: size

verbose

public final GetDataFrameAnalyticsStatsRequest.Builder verbose(@Nullable
 Boolean value)

Defines whether the stats response should be verbose.

API name: verbose

self

protected GetDataFrameAnalyticsStatsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDataFrameAnalyticsStatsRequest.Builder>

build

public GetDataFrameAnalyticsStatsRequest build()

Builds a GetDataFrameAnalyticsStatsRequest.

Specified by:

build in interface ObjectBuilder<GetDataFrameAnalyticsStatsRequest>

Throws:

NullPointerException - if some of the required fields are null.