Package co.elastic.clients.elasticsearch.connector

Class UpdateFeaturesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.connector.UpdateFeaturesRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateFeaturesRequest
extends RequestBase
implements JsonpSerializable

Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector:

• document-level security
• incremental syncs
• advanced sync rules
• basic sync rules

Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior.

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

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<UpdateFeaturesRequest>	_DESERIALIZER	Json deserializer for UpdateFeaturesRequest
static final Endpoint<UpdateFeaturesRequest,UpdateFeaturesResponse,ErrorResponse>	_ENDPOINT	Endpoint "connector.update_features".

Method Summary

Modifier and Type	Method	Description
final String	connectorId()	Required - The unique identifier of the connector to be updated.
final ConnectorFeatures	features()	Required - API name: features
static UpdateFeaturesRequest	of(Function<UpdateFeaturesRequest.Builder,ObjectBuilder<UpdateFeaturesRequest>> 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	setupUpdateFeaturesRequestDeserializer(ObjectDeserializer<UpdateFeaturesRequest.Builder> op)

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

Json deserializer for UpdateFeaturesRequest

_ENDPOINT

public static final Endpoint<UpdateFeaturesRequest,UpdateFeaturesResponse,ErrorResponse> _ENDPOINT

Endpoint "connector.update_features".

Method Details

of

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

connectorId

public final String connectorId()

Required - The unique identifier of the connector to be updated.

API name: connector_id

features

public final ConnectorFeatures features()

Required - API name: features

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)

setupUpdateFeaturesRequestDeserializer

protected static void setupUpdateFeaturesRequestDeserializer(ObjectDeserializer<UpdateFeaturesRequest.Builder> op)