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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetBucketsRequest.Builder
Builder forGetBucketsRequest
.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<GetBucketsRequest>
_DESERIALIZER
Json deserializer forGetBucketsRequest
static Endpoint<GetBucketsRequest,GetBucketsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_buckets
". -
Method Summary
Modifier and Type Method Description java.lang.Double
anomalyScore()
Refer to the description for theanomaly_score
query parameter.java.lang.Boolean
desc()
Refer to the description for thedesc
query parameter.DateTime
end()
Refer to the description for theend
query parameter.java.lang.Boolean
excludeInterim()
Refer to the description for theexclude_interim
query parameter.java.lang.Boolean
expand()
Refer to the description for theexpand
query parameter.java.lang.Integer
from()
Skips the specified number of buckets.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static GetBucketsRequest
of(java.util.function.Function<GetBucketsRequest.Builder,ObjectBuilder<GetBucketsRequest>> fn)
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
setupGetBucketsRequestDeserializer(ObjectDeserializer<GetBucketsRequest.Builder> op)
java.lang.Integer
size()
Specifies the maximum number of buckets to obtain.java.lang.String
sort()
Refer to the desription for thesort
query parameter.DateTime
start()
Refer to the description for thestart
query parameter.DateTime
timestamp()
The timestamp of a single bucket result.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forGetBucketsRequest
-
_ENDPOINT
Endpoint "ml.get_buckets
".
-
-
Method Details
-
of
public static GetBucketsRequest of(java.util.function.Function<GetBucketsRequest.Builder,ObjectBuilder<GetBucketsRequest>> fn) -
anomalyScore
@Nullable public final java.lang.Double anomalyScore()Refer to the description for theanomaly_score
query parameter.API name:
anomaly_score
-
desc
@Nullable public final java.lang.Boolean 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
@Nullable public final java.lang.Boolean excludeInterim()Refer to the description for theexclude_interim
query parameter.API name:
exclude_interim
-
expand
@Nullable public final java.lang.Boolean expand()Refer to the description for theexpand
query parameter.API name:
expand
-
from
@Nullable public final java.lang.Integer from()Skips the specified number of buckets.API name:
from
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
page
API name:page
-
size
@Nullable public final java.lang.Integer size()Specifies the maximum number of buckets to obtain.API name:
size
-
sort
@Nullable public final java.lang.String 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)
-