Package co.elastic.clients.elasticsearch.connector

Class SyncJobClaimRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.SyncJobClaimRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SyncJobClaimRequest
extends RequestBase
implements JsonpSerializable

Claim a connector sync job. This action updates the job status to in_progress and sets the last_seen and started_at timestamps to the current time. Additionally, it can set the sync_cursor property for the sync job.

This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.

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	SyncJobClaimRequest.Builder	Builder for SyncJobClaimRequest.

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<SyncJobClaimRequest>	_DESERIALIZER	Json deserializer for SyncJobClaimRequest
static final Endpoint<SyncJobClaimRequest,SyncJobClaimResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.sync_job_claim".

Method Summary

Modifier and Type	Method	Description
final String	connectorSyncJobId()	Required - The unique identifier of the connector sync job.
static SyncJobClaimRequest	of(Function<SyncJobClaimRequest.Builder,ObjectBuilder<SyncJobClaimRequest>> fn)
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	setupSyncJobClaimRequestDeserializer(ObjectDeserializer<SyncJobClaimRequest.Builder> op)
final JsonData	syncCursor()	The cursor object from the last incremental sync job.
final String	workerHostname()	Required - The host name of the current system that will run the job.

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

Json deserializer for SyncJobClaimRequest

_ENDPOINT

public static final Endpoint<SyncJobClaimRequest,SyncJobClaimResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.sync_job_claim".

Method Details

of

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

connectorSyncJobId

public final String connectorSyncJobId()

Required - The unique identifier of the connector sync job.

API name: connector_sync_job_id

syncCursor

@Nullable
public final JsonData syncCursor()

The cursor object from the last incremental sync job. This should reference the sync_cursor field in the connector state for which the job runs.

API name: sync_cursor

workerHostname

public final String workerHostname()

Required - The host name of the current system that will run the job.

API name: worker_hostname

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)

setupSyncJobClaimRequestDeserializer

protected static void setupSyncJobClaimRequestDeserializer(ObjectDeserializer<SyncJobClaimRequest.Builder> op)