Class DataDescription.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DataDescription.Builder>
co.elastic.clients.elasticsearch.ml.DataDescription.Builder
- All Implemented Interfaces:
WithJson<DataDescription.Builder>
,ObjectBuilder<DataDescription>
- Enclosing class:
- DataDescription
public static class DataDescription.Builder
extends WithJsonObjectBuilderBase<DataDescription.Builder>
implements ObjectBuilder<DataDescription>
Builder for
DataDescription
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aDataDescription
.final DataDescription.Builder
fieldDelimiter
(String value) API name:field_delimiter
final DataDescription.Builder
Only JSON format is supported at this time.protected DataDescription.Builder
self()
final DataDescription.Builder
Required - The name of the field that contains the timestamp.final DataDescription.Builder
timeFormat
(String value) The time format, which can beepoch
,epoch_ms
, or a custom pattern.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
format
Only JSON format is supported at this time.API name:
format
-
timeField
Required - The name of the field that contains the timestamp.API name:
time_field
-
timeFormat
The time format, which can beepoch
,epoch_ms
, or a custom pattern. The valueepoch
refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The valueepoch_ms
indicates that time is measured in milliseconds since the epoch. Theepoch
andepoch_ms
time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.API name:
time_format
-
fieldDelimiter
API name:field_delimiter
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<DataDescription.Builder>
-
build
Builds aDataDescription
.- Specified by:
build
in interfaceObjectBuilder<DataDescription>
- Throws:
NullPointerException
- if some of the required fields are null.
-