Class GetBucketsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetBucketsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class GetBucketsRequest
extends RequestBase
implements JsonpSerializable
Retrieves anomaly detection job results for one or more buckets. The API
presents a chronological view of the records, grouped by bucket.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetBucketsRequest>
Json deserializer forGetBucketsRequest
static final Endpoint<GetBucketsRequest,
GetBucketsResponse, ErrorResponse> Endpoint "ml.get_buckets
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Double
Refer to the description for theanomaly_score
query parameter.final Boolean
desc()
Refer to the description for thedesc
query parameter.final DateTime
end()
Refer to the description for theend
query parameter.final Boolean
Refer to the description for theexclude_interim
query parameter.final Boolean
expand()
Refer to the description for theexpand
query parameter.final Integer
from()
Skips the specified number of buckets.final String
jobId()
Required - Identifier for the anomaly detection job.static GetBucketsRequest
final Page
page()
API name:page
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
final Integer
size()
Specifies the maximum number of buckets to obtain.final String
sort()
Refer to the desription for thesort
query parameter.final DateTime
start()
Refer to the description for thestart
query parameter.final DateTime
The timestamp of a single bucket result.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forGetBucketsRequest
-
_ENDPOINT
Endpoint "ml.get_buckets
".
-
-
Method Details
-
of
public static GetBucketsRequest of(Function<GetBucketsRequest.Builder, ObjectBuilder<GetBucketsRequest>> fn) -
anomalyScore
Refer to the description for theanomaly_score
query parameter.API name:
anomaly_score
-
desc
Refer to the description for thedesc
query parameter.API name:
desc
-
end
Refer to the description for theend
query parameter.API name:
end
-
excludeInterim
Refer to the description for theexclude_interim
query parameter.API name:
exclude_interim
-
expand
Refer to the description for theexpand
query parameter.API name:
expand
-
from
Skips the specified number of buckets.API name:
from
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
page
API name:page
-
size
Specifies the maximum number of buckets to obtain.API name:
size
-
sort
Refer to the desription for thesort
query parameter.API name:
sort
-
start
Refer to the description for thestart
query parameter.API name:
start
-
timestamp
The timestamp of a single bucket result. If you do not specify this parameter, the API returns information about all buckets.API name:
timestamp
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetBucketsRequestDeserializer
protected static void setupGetBucketsRequestDeserializer(ObjectDeserializer<GetBucketsRequest.Builder> op)
-