Package co.elastic.clients.elasticsearch.connector

Class SyncJobCancelRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.SyncJobCancelRequest

public class SyncJobCancelRequest
extends RequestBase

Cancel a connector sync job.

Cancel a connector sync job, which sets the status to cancelling and updates cancellation_requested_at to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<SyncJobCancelRequest,SyncJobCancelResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.sync_job_cancel".

Method Summary

Modifier and Type	Method	Description
final String	connectorSyncJobId()	Required - The unique identifier of the connector sync job
static SyncJobCancelRequest	of(Function<SyncJobCancelRequest.Builder,ObjectBuilder<SyncJobCancelRequest>> fn)

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

_ENDPOINT

public static final Endpoint<SyncJobCancelRequest,SyncJobCancelResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.sync_job_cancel".

Method Details

of

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

connectorSyncJobId

public final String connectorSyncJobId()

Required - The unique identifier of the connector sync job

API name: connector_sync_job_id