Package co.elastic.clients.elasticsearch.ml

Class GetDataFrameAnalyticsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsRequest.Builder

All Implemented Interfaces:

WithJson<GetDataFrameAnalyticsRequest.Builder>, ObjectBuilder<GetDataFrameAnalyticsRequest>

Enclosing class:

GetDataFrameAnalyticsRequest

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

Builder for GetDataFrameAnalyticsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetDataFrameAnalyticsRequest.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.
GetDataFrameAnalyticsRequest	build()	Builds a GetDataFrameAnalyticsRequest.
final GetDataFrameAnalyticsRequest.Builder	excludeGenerated(Boolean value)	Indicates if certain fields should be removed from the configuration on retrieval.
final GetDataFrameAnalyticsRequest.Builder	from(Integer value)	Skips the specified number of data frame analytics jobs.
final GetDataFrameAnalyticsRequest.Builder	id(String value)	Identifier for the data frame analytics job.
protected GetDataFrameAnalyticsRequest.Builder	self()
final GetDataFrameAnalyticsRequest.Builder	size(Integer value)	Specifies the maximum number of data frame analytics jobs to obtain.

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 GetDataFrameAnalyticsRequest.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

excludeGenerated

public final GetDataFrameAnalyticsRequest.Builder excludeGenerated(@Nullable
 Boolean value)

Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

API name: exclude_generated

from

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

Skips the specified number of data frame analytics jobs.

API name: from

id

public final GetDataFrameAnalyticsRequest.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 GetDataFrameAnalyticsRequest.Builder size(@Nullable
 Integer value)

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

API name: size

self

protected GetDataFrameAnalyticsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDataFrameAnalyticsRequest.Builder>

build

public GetDataFrameAnalyticsRequest build()

Builds a GetDataFrameAnalyticsRequest.

Specified by:

build in interface ObjectBuilder<GetDataFrameAnalyticsRequest>

Throws:

NullPointerException - if some of the required fields are null.