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
-
Method Summary
Modifier and TypeMethodDescriptionallowNoMatch
(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.build()
Builds aGetDataFrameAnalyticsRequest
.excludeGenerated
(Boolean value) Indicates if certain fields should be removed from the configuration on retrieval.Skips the specified number of data frame analytics jobs.Identifier for the data frame analytics job.protected GetDataFrameAnalyticsRequest.Builder
self()
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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoMatch
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.
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
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
Skips the specified number of data frame analytics jobs.API name:
from
-
id
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
Specifies the maximum number of data frame analytics jobs to obtain.API name:
size
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetDataFrameAnalyticsRequest.Builder>
-
build
Builds aGetDataFrameAnalyticsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetDataFrameAnalyticsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-