Package co.elastic.clients.elasticsearch.connector

Class DeleteConnectorRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.DeleteConnectorRequest

public class DeleteConnectorRequest
extends RequestBase

Delete a connector.

Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteConnectorRequest,DeleteConnectorResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.delete".

Method Summary

Modifier and Type	Method	Description
final String	connectorId()	Required - The unique identifier of the connector to be deleted
final Boolean	deleteSyncJobs()	A flag indicating if associated sync jobs should be also removed.
final Boolean	hard()	A flag indicating if the connector should be hard deleted.
static DeleteConnectorRequest	of(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> 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<DeleteConnectorRequest,DeleteConnectorResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.delete".

Method Details

of

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

connectorId

public final String connectorId()

Required - The unique identifier of the connector to be deleted

API name: connector_id

deleteSyncJobs

@Nullable
public final Boolean deleteSyncJobs()

A flag indicating if associated sync jobs should be also removed. Defaults to false.

API name: delete_sync_jobs

hard

@Nullable
public final Boolean hard()

A flag indicating if the connector should be hard deleted.

API name: hard