PreviewDataFrameAnalyticsRequest (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.PreviewDataFrameAnalyticsRequest

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class PreviewDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable

Previews the extracted features used by a data frame analytics config.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PreviewDataFrameAnalyticsRequest.Builder
Builder for PreviewDataFrameAnalyticsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<PreviewDataFrameAnalyticsRequest>`	`_DESERIALIZER`	Json deserializer for `PreviewDataFrameAnalyticsRequest`
`static Endpoint<PreviewDataFrameAnalyticsRequest,PreviewDataFrameAnalyticsResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`ml.preview_data_frame_analytics`".

Method Summary

Modifier and Type	Method	Description
`DataframePreviewConfig`	`config()`	A data frame analytics config as described in Create data frame analytics jobs.
`java.lang.String`	`id()`	Identifier for the data frame analytics job.
`static PreviewDataFrameAnalyticsRequest`	`of(java.util.function.Function<PreviewDataFrameAnalyticsRequest.Builder,ObjectBuilder<PreviewDataFrameAnalyticsRequest>> fn)`
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupPreviewDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<PreviewDataFrameAnalyticsRequest.Builder> op)`

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<PreviewDataFrameAnalyticsRequest> _DESERIALIZER
  
  Json deserializer for PreviewDataFrameAnalyticsRequest
- _ENDPOINT
  
  public static final Endpoint<PreviewDataFrameAnalyticsRequest,PreviewDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "ml.preview_data_frame_analytics".
Method Details
- of
  
  public static PreviewDataFrameAnalyticsRequest of(java.util.function.Function<PreviewDataFrameAnalyticsRequest.Builder,ObjectBuilder<PreviewDataFrameAnalyticsRequest>> fn)
- config
  
  @Nullable public final DataframePreviewConfig config()
  
  A data frame analytics config as described in Create data frame analytics jobs. Note that id and dest don’t need to be provided in the context of this API.
  API name: config
- id
  
  @Nullable public final java.lang.String id()
  
  Identifier for the data frame analytics job.
  API name: id
- serialize
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Serialize this object to JSON.
  
  Specified by:
  
  serialize in interface JsonpSerializable
- serializeInternal
  
  protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
- setupPreviewDataFrameAnalyticsRequestDeserializer
  
  protected static void setupPreviewDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<PreviewDataFrameAnalyticsRequest.Builder> op)