Package co.elastic.clients.elasticsearch.ml

Class PreviewDatafeedRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.ml.PreviewDatafeedRequest.Builder

All Implemented Interfaces:

WithJson<PreviewDatafeedRequest.Builder>, ObjectBuilder<PreviewDatafeedRequest>

Enclosing class:

PreviewDatafeedRequest

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

Builder for PreviewDatafeedRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PreviewDatafeedRequest	build()	Builds a PreviewDatafeedRequest.
final PreviewDatafeedRequest.Builder	datafeedConfig(DatafeedConfig value)	The datafeed definition to preview.
final PreviewDatafeedRequest.Builder	datafeedConfig(Function<DatafeedConfig.Builder,ObjectBuilder<DatafeedConfig>> fn)	The datafeed definition to preview.
final PreviewDatafeedRequest.Builder	datafeedId(String value)	A numerical character string that uniquely identifies the datafeed.
final PreviewDatafeedRequest.Builder	end(DateTime value)	The end time when the datafeed preview should stop
final PreviewDatafeedRequest.Builder	jobConfig(JobConfig value)	The configuration details for the anomaly detection job that is associated with the datafeed.
final PreviewDatafeedRequest.Builder	jobConfig(Function<JobConfig.Builder,ObjectBuilder<JobConfig>> fn)	The configuration details for the anomaly detection job that is associated with the datafeed.
protected PreviewDatafeedRequest.Builder	self()
final PreviewDatafeedRequest.Builder	start(DateTime value)	The start time from where the datafeed preview should begin

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

datafeedConfig

public final PreviewDatafeedRequest.Builder datafeedConfig(@Nullable
 DatafeedConfig value)

The datafeed definition to preview.

API name: datafeed_config

datafeedConfig

public final PreviewDatafeedRequest.Builder datafeedConfig(Function<DatafeedConfig.Builder,ObjectBuilder<DatafeedConfig>> fn)

The datafeed definition to preview.

API name: datafeed_config

datafeedId

public final PreviewDatafeedRequest.Builder datafeedId(@Nullable
 String value)

A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job configuration details in the request body.

API name: datafeed_id

end

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

The end time when the datafeed preview should stop

API name: end

jobConfig

public final PreviewDatafeedRequest.Builder jobConfig(@Nullable
 JobConfig value)

The configuration details for the anomaly detection job that is associated with the datafeed. If the datafeed_config object does not include a job_id that references an existing anomaly detection job, you must supply this job_config object. If you include both a job_id and a job_config, the latter information is used. You cannot specify a job_config object unless you also supply a datafeed_config object.

API name: job_config

jobConfig

public final PreviewDatafeedRequest.Builder jobConfig(Function<JobConfig.Builder,ObjectBuilder<JobConfig>> fn)

The configuration details for the anomaly detection job that is associated with the datafeed. If the datafeed_config object does not include a job_id that references an existing anomaly detection job, you must supply this job_config object. If you include both a job_id and a job_config, the latter information is used. You cannot specify a job_config object unless you also supply a datafeed_config object.

API name: job_config

start

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

The start time from where the datafeed preview should begin

API name: start

self

protected PreviewDatafeedRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PreviewDatafeedRequest.Builder>

build

public PreviewDatafeedRequest build()

Builds a PreviewDatafeedRequest.

Specified by:

build in interface ObjectBuilder<PreviewDatafeedRequest>

Throws:

NullPointerException - if some of the required fields are null.