Package co.elastic.clients.elasticsearch.connector

Class SyncJobUpdateStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.SyncJobUpdateStatsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SyncJobUpdateStatsRequest
extends RequestBase
implements JsonpSerializable

Set the connector sync job stats. Stats include: deleted_document_count, indexed_document_count, indexed_document_volume, and total_document_count. You can also update last_seen. This API is mainly used by the connector service for updating sync job information.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncJobUpdateStatsRequest.Builder	Builder for SyncJobUpdateStatsRequest.

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 final JsonpDeserializer<SyncJobUpdateStatsRequest>	_DESERIALIZER	Json deserializer for SyncJobUpdateStatsRequest
static final Endpoint<SyncJobUpdateStatsRequest,SyncJobUpdateStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.sync_job_update_stats".

Method Summary

Modifier and Type	Method	Description
final String	connectorSyncJobId()	Required - The unique identifier of the connector sync job.
final long	deletedDocumentCount()	Required - The number of documents the sync job deleted.
final long	indexedDocumentCount()	Required - The number of documents the sync job indexed.
final long	indexedDocumentVolume()	Required - The total size of the data (in MiB) the sync job indexed.
final Time	lastSeen()	The timestamp to use in the last_seen property for the connector sync job.
final Map<String,JsonData>	metadata()	The connector-specific metadata.
static SyncJobUpdateStatsRequest	of(Function<SyncJobUpdateStatsRequest.Builder,ObjectBuilder<SyncJobUpdateStatsRequest>> fn)
SyncJobUpdateStatsRequest.Builder	rebuild()
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	setupSyncJobUpdateStatsRequestDeserializer(ObjectDeserializer<SyncJobUpdateStatsRequest.Builder> op)
final Integer	totalDocumentCount()	The total number of documents in the target index after the sync job finished.

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<SyncJobUpdateStatsRequest> _DESERIALIZER

Json deserializer for SyncJobUpdateStatsRequest

_ENDPOINT

public static final Endpoint<SyncJobUpdateStatsRequest,SyncJobUpdateStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.sync_job_update_stats".

Method Details

of

public static SyncJobUpdateStatsRequest of(Function<SyncJobUpdateStatsRequest.Builder,ObjectBuilder<SyncJobUpdateStatsRequest>> fn)

connectorSyncJobId

public final String connectorSyncJobId()

Required - The unique identifier of the connector sync job.

API name: connector_sync_job_id

deletedDocumentCount

public final long deletedDocumentCount()

Required - The number of documents the sync job deleted.

API name: deleted_document_count

indexedDocumentCount

public final long indexedDocumentCount()

Required - The number of documents the sync job indexed.

API name: indexed_document_count

indexedDocumentVolume

public final long indexedDocumentVolume()

Required - The total size of the data (in MiB) the sync job indexed.

API name: indexed_document_volume

lastSeen

@Nullable
public final Time lastSeen()

The timestamp to use in the last_seen property for the connector sync job.

API name: last_seen

metadata

public final Map<String,JsonData> metadata()

The connector-specific metadata.

API name: metadata

totalDocumentCount

@Nullable
public final Integer totalDocumentCount()

The total number of documents in the target index after the sync job finished.

API name: total_document_count

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)

rebuild

public SyncJobUpdateStatsRequest.Builder rebuild()

Returns:

New SyncJobUpdateStatsRequest.Builder initialized with field values of this instance

setupSyncJobUpdateStatsRequestDeserializer

protected static void setupSyncJobUpdateStatsRequestDeserializer(ObjectDeserializer<SyncJobUpdateStatsRequest.Builder> op)