Package co.elastic.clients.elasticsearch.connector

Class ElasticsearchConnectorAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchConnectorAsyncClient>

co.elastic.clients.elasticsearch.connector.ElasticsearchConnectorAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchConnectorAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchConnectorAsyncClient>

Client for the connector namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchConnectorAsyncClient(ElasticsearchTransport transport)
ElasticsearchConnectorAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CheckInResponse>	checkIn(CheckInRequest request)	Check in a connector.
final CompletableFuture<CheckInResponse>	checkIn(Function<CheckInRequest.Builder,ObjectBuilder<CheckInRequest>> fn)	Check in a connector.
CompletableFuture<DeleteConnectorResponse>	delete(DeleteConnectorRequest request)	Delete a connector.
final CompletableFuture<DeleteConnectorResponse>	delete(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)	Delete a connector.
CompletableFuture<GetConnectorResponse>	get(GetConnectorRequest request)	Get a connector.
final CompletableFuture<GetConnectorResponse>	get(Function<GetConnectorRequest.Builder,ObjectBuilder<GetConnectorRequest>> fn)	Get a connector.
CompletableFuture<ListResponse>	list()	Get all connectors.
CompletableFuture<ListResponse>	list(ListRequest request)	Get all connectors.
final CompletableFuture<ListResponse>	list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)	Get all connectors.
CompletableFuture<PostResponse>	post()	Create a connector.
CompletableFuture<PostResponse>	post(PostRequest request)	Create a connector.
final CompletableFuture<PostResponse>	post(Function<PostRequest.Builder,ObjectBuilder<PostRequest>> fn)	Create a connector.
CompletableFuture<PutResponse>	put()	Create or update a connector.
CompletableFuture<PutResponse>	put(PutRequest request)	Create or update a connector.
final CompletableFuture<PutResponse>	put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)	Create or update a connector.
CompletableFuture<SyncJobCancelResponse>	syncJobCancel(SyncJobCancelRequest request)	Cancel a connector sync job.
final CompletableFuture<SyncJobCancelResponse>	syncJobCancel(Function<SyncJobCancelRequest.Builder,ObjectBuilder<SyncJobCancelRequest>> fn)	Cancel a connector sync job.
CompletableFuture<SyncJobCheckInResponse>	syncJobCheckIn(SyncJobCheckInRequest request)	Check in a connector sync job.
final CompletableFuture<SyncJobCheckInResponse>	syncJobCheckIn(Function<SyncJobCheckInRequest.Builder,ObjectBuilder<SyncJobCheckInRequest>> fn)	Check in a connector sync job.
CompletableFuture<SyncJobClaimResponse>	syncJobClaim(SyncJobClaimRequest request)	Claim a connector sync job.
final CompletableFuture<SyncJobClaimResponse>	syncJobClaim(Function<SyncJobClaimRequest.Builder,ObjectBuilder<SyncJobClaimRequest>> fn)	Claim a connector sync job.
CompletableFuture<SyncJobDeleteResponse>	syncJobDelete(SyncJobDeleteRequest request)	Delete a connector sync job.
final CompletableFuture<SyncJobDeleteResponse>	syncJobDelete(Function<SyncJobDeleteRequest.Builder,ObjectBuilder<SyncJobDeleteRequest>> fn)	Delete a connector sync job.
CompletableFuture<SyncJobErrorResponse>	syncJobError(SyncJobErrorRequest request)	Set a connector sync job error.
final CompletableFuture<SyncJobErrorResponse>	syncJobError(Function<SyncJobErrorRequest.Builder,ObjectBuilder<SyncJobErrorRequest>> fn)	Set a connector sync job error.
CompletableFuture<SyncJobGetResponse>	syncJobGet(SyncJobGetRequest request)	Get a connector sync job.
final CompletableFuture<SyncJobGetResponse>	syncJobGet(Function<SyncJobGetRequest.Builder,ObjectBuilder<SyncJobGetRequest>> fn)	Get a connector sync job.
CompletableFuture<SyncJobListResponse>	syncJobList()	Get all connector sync jobs.
CompletableFuture<SyncJobListResponse>	syncJobList(SyncJobListRequest request)	Get all connector sync jobs.
final CompletableFuture<SyncJobListResponse>	syncJobList(Function<SyncJobListRequest.Builder,ObjectBuilder<SyncJobListRequest>> fn)	Get all connector sync jobs.
CompletableFuture<SyncJobPostResponse>	syncJobPost(SyncJobPostRequest request)	Create a connector sync job.
final CompletableFuture<SyncJobPostResponse>	syncJobPost(Function<SyncJobPostRequest.Builder,ObjectBuilder<SyncJobPostRequest>> fn)	Create a connector sync job.
CompletableFuture<SyncJobUpdateStatsResponse>	syncJobUpdateStats(SyncJobUpdateStatsRequest request)	Set the connector sync job stats.
final CompletableFuture<SyncJobUpdateStatsResponse>	syncJobUpdateStats(Function<SyncJobUpdateStatsRequest.Builder,ObjectBuilder<SyncJobUpdateStatsRequest>> fn)	Set the connector sync job stats.
CompletableFuture<UpdateActiveFilteringResponse>	updateActiveFiltering(UpdateActiveFilteringRequest request)	Activate the connector draft filter.
final CompletableFuture<UpdateActiveFilteringResponse>	updateActiveFiltering(Function<UpdateActiveFilteringRequest.Builder,ObjectBuilder<UpdateActiveFilteringRequest>> fn)	Activate the connector draft filter.
CompletableFuture<UpdateApiKeyIdResponse>	updateApiKeyId(UpdateApiKeyIdRequest request)	Update the connector API key ID.
final CompletableFuture<UpdateApiKeyIdResponse>	updateApiKeyId(Function<UpdateApiKeyIdRequest.Builder,ObjectBuilder<UpdateApiKeyIdRequest>> fn)	Update the connector API key ID.
CompletableFuture<UpdateConfigurationResponse>	updateConfiguration(UpdateConfigurationRequest request)	Update the connector configuration.
final CompletableFuture<UpdateConfigurationResponse>	updateConfiguration(Function<UpdateConfigurationRequest.Builder,ObjectBuilder<UpdateConfigurationRequest>> fn)	Update the connector configuration.
CompletableFuture<UpdateErrorResponse>	updateError(UpdateErrorRequest request)	Update the connector error field.
final CompletableFuture<UpdateErrorResponse>	updateError(Function<UpdateErrorRequest.Builder,ObjectBuilder<UpdateErrorRequest>> fn)	Update the connector error field.
CompletableFuture<UpdateFeaturesResponse>	updateFeatures(UpdateFeaturesRequest request)	Update the connector features.
final CompletableFuture<UpdateFeaturesResponse>	updateFeatures(Function<UpdateFeaturesRequest.Builder,ObjectBuilder<UpdateFeaturesRequest>> fn)	Update the connector features.
CompletableFuture<UpdateFilteringResponse>	updateFiltering(UpdateFilteringRequest request)	Update the connector filtering.
final CompletableFuture<UpdateFilteringResponse>	updateFiltering(Function<UpdateFilteringRequest.Builder,ObjectBuilder<UpdateFilteringRequest>> fn)	Update the connector filtering.
CompletableFuture<UpdateFilteringValidationResponse>	updateFilteringValidation(UpdateFilteringValidationRequest request)	Update the connector draft filtering validation.
final CompletableFuture<UpdateFilteringValidationResponse>	updateFilteringValidation(Function<UpdateFilteringValidationRequest.Builder,ObjectBuilder<UpdateFilteringValidationRequest>> fn)	Update the connector draft filtering validation.
CompletableFuture<UpdateIndexNameResponse>	updateIndexName(UpdateIndexNameRequest request)	Update the connector index name.
final CompletableFuture<UpdateIndexNameResponse>	updateIndexName(Function<UpdateIndexNameRequest.Builder,ObjectBuilder<UpdateIndexNameRequest>> fn)	Update the connector index name.
CompletableFuture<UpdateNameResponse>	updateName(UpdateNameRequest request)	Update the connector name and description.
final CompletableFuture<UpdateNameResponse>	updateName(Function<UpdateNameRequest.Builder,ObjectBuilder<UpdateNameRequest>> fn)	Update the connector name and description.
CompletableFuture<UpdateNativeResponse>	updateNative(UpdateNativeRequest request)	Update the connector is_native flag.
final CompletableFuture<UpdateNativeResponse>	updateNative(Function<UpdateNativeRequest.Builder,ObjectBuilder<UpdateNativeRequest>> fn)	Update the connector is_native flag.
CompletableFuture<UpdatePipelineResponse>	updatePipeline(UpdatePipelineRequest request)	Update the connector pipeline.
final CompletableFuture<UpdatePipelineResponse>	updatePipeline(Function<UpdatePipelineRequest.Builder,ObjectBuilder<UpdatePipelineRequest>> fn)	Update the connector pipeline.
CompletableFuture<UpdateSchedulingResponse>	updateScheduling(UpdateSchedulingRequest request)	Update the connector scheduling.
final CompletableFuture<UpdateSchedulingResponse>	updateScheduling(Function<UpdateSchedulingRequest.Builder,ObjectBuilder<UpdateSchedulingRequest>> fn)	Update the connector scheduling.
CompletableFuture<UpdateServiceTypeResponse>	updateServiceType(UpdateServiceTypeRequest request)	Update the connector service type.
final CompletableFuture<UpdateServiceTypeResponse>	updateServiceType(Function<UpdateServiceTypeRequest.Builder,ObjectBuilder<UpdateServiceTypeRequest>> fn)	Update the connector service type.
CompletableFuture<UpdateStatusResponse>	updateStatus(UpdateStatusRequest request)	Update the connector status.
final CompletableFuture<UpdateStatusResponse>	updateStatus(Function<UpdateStatusRequest.Builder,ObjectBuilder<UpdateStatusRequest>> fn)	Update the connector status.
ElasticsearchConnectorAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchConnectorAsyncClient

public ElasticsearchConnectorAsyncClient(ElasticsearchTransport transport)

ElasticsearchConnectorAsyncClient

public ElasticsearchConnectorAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchConnectorAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchConnectorAsyncClient>

checkIn

public CompletableFuture<CheckInResponse> checkIn(CheckInRequest request)

Check in a connector.

Update the last_seen field in the connector and set it to the current timestamp.

See Also:

• Documentation on elastic.co

checkIn

public final CompletableFuture<CheckInResponse> checkIn(Function<CheckInRequest.Builder,ObjectBuilder<CheckInRequest>> fn)

Check in a connector.

Update the last_seen field in the connector and set it to the current timestamp.

Parameters:

fn - a function that initializes a builder to create the CheckInRequest

See Also:

• Documentation on elastic.co

delete

public CompletableFuture<DeleteConnectorResponse> delete(DeleteConnectorRequest request)

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:

• Documentation on elastic.co

delete

public final CompletableFuture<DeleteConnectorResponse> delete(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)

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.

Parameters:

fn - a function that initializes a builder to create the DeleteConnectorRequest

See Also:

• Documentation on elastic.co

get

public CompletableFuture<GetConnectorResponse> get(GetConnectorRequest request)

Get a connector.

Get the details about a connector.

See Also:

• Documentation on elastic.co

get

public final CompletableFuture<GetConnectorResponse> get(Function<GetConnectorRequest.Builder,ObjectBuilder<GetConnectorRequest>> fn)

Get a connector.

Get the details about a connector.

Parameters:

fn - a function that initializes a builder to create the GetConnectorRequest

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list(ListRequest request)

Get all connectors.

Get information about all connectors.

See Also:

• Documentation on elastic.co

list

public final CompletableFuture<ListResponse> list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

Get all connectors.

Get information about all connectors.

Parameters:

fn - a function that initializes a builder to create the ListRequest

See Also:

• Documentation on elastic.co

list

public CompletableFuture<ListResponse> list()

Get all connectors.

Get information about all connectors.

See Also:

• Documentation on elastic.co

post

public CompletableFuture<PostResponse> post(PostRequest request)

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

See Also:

• Documentation on elastic.co

post

public final CompletableFuture<PostResponse> post(Function<PostRequest.Builder,ObjectBuilder<PostRequest>> fn)

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

Parameters:

fn - a function that initializes a builder to create the PostRequest

See Also:

• Documentation on elastic.co

post

public CompletableFuture<PostResponse> post()

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.

See Also:

• Documentation on elastic.co

put

public CompletableFuture<PutResponse> put(PutRequest request)

Create or update a connector.

See Also:

• Documentation on elastic.co

put

public final CompletableFuture<PutResponse> put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)

Create or update a connector.

Parameters:

fn - a function that initializes a builder to create the PutRequest

See Also:

• Documentation on elastic.co

put

public CompletableFuture<PutResponse> put()

Create or update a connector.

See Also:

• Documentation on elastic.co

syncJobCancel

public CompletableFuture<SyncJobCancelResponse> syncJobCancel(SyncJobCancelRequest request)

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:

• Documentation on elastic.co

syncJobCancel

public final CompletableFuture<SyncJobCancelResponse> syncJobCancel(Function<SyncJobCancelRequest.Builder,ObjectBuilder<SyncJobCancelRequest>> fn)

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.

Parameters:

fn - a function that initializes a builder to create the SyncJobCancelRequest

See Also:

• Documentation on elastic.co

syncJobCheckIn

public CompletableFuture<SyncJobCheckInResponse> syncJobCheckIn(SyncJobCheckInRequest request)

Check in a connector sync job. Check in a connector sync job and set the last_seen field to the current time before updating it in the internal index.

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:

• Documentation on elastic.co

syncJobCheckIn

public final CompletableFuture<SyncJobCheckInResponse> syncJobCheckIn(Function<SyncJobCheckInRequest.Builder,ObjectBuilder<SyncJobCheckInRequest>> fn)

Check in a connector sync job. Check in a connector sync job and set the last_seen field to the current time before updating it in the internal index.

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.

Parameters:

fn - a function that initializes a builder to create the SyncJobCheckInRequest

See Also:

• Documentation on elastic.co

syncJobClaim

public CompletableFuture<SyncJobClaimResponse> syncJobClaim(SyncJobClaimRequest request)

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:

• Documentation on elastic.co

syncJobClaim

public final CompletableFuture<SyncJobClaimResponse> syncJobClaim(Function<SyncJobClaimRequest.Builder,ObjectBuilder<SyncJobClaimRequest>> fn)

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.

Parameters:

fn - a function that initializes a builder to create the SyncJobClaimRequest

See Also:

• Documentation on elastic.co

syncJobDelete

public CompletableFuture<SyncJobDeleteResponse> syncJobDelete(SyncJobDeleteRequest request)

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

See Also:

• Documentation on elastic.co

syncJobDelete

public final CompletableFuture<SyncJobDeleteResponse> syncJobDelete(Function<SyncJobDeleteRequest.Builder,ObjectBuilder<SyncJobDeleteRequest>> fn)

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.

Parameters:

fn - a function that initializes a builder to create the SyncJobDeleteRequest

See Also:

• Documentation on elastic.co

syncJobError

public CompletableFuture<SyncJobErrorResponse> syncJobError(SyncJobErrorRequest request)

Set a connector sync job error. Set the error field for a connector sync job and set its status to error.

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:

• Documentation on elastic.co

syncJobError

public final CompletableFuture<SyncJobErrorResponse> syncJobError(Function<SyncJobErrorRequest.Builder,ObjectBuilder<SyncJobErrorRequest>> fn)

Set a connector sync job error. Set the error field for a connector sync job and set its status to error.

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.

Parameters:

fn - a function that initializes a builder to create the SyncJobErrorRequest

See Also:

• Documentation on elastic.co

syncJobGet

public CompletableFuture<SyncJobGetResponse> syncJobGet(SyncJobGetRequest request)

Get a connector sync job.

See Also:

• Documentation on elastic.co

syncJobGet

public final CompletableFuture<SyncJobGetResponse> syncJobGet(Function<SyncJobGetRequest.Builder,ObjectBuilder<SyncJobGetRequest>> fn)

Get a connector sync job.

Parameters:

fn - a function that initializes a builder to create the SyncJobGetRequest

See Also:

• Documentation on elastic.co

syncJobList

public CompletableFuture<SyncJobListResponse> syncJobList(SyncJobListRequest request)

Get all connector sync jobs.

Get information about all stored connector sync jobs listed by their creation date in ascending order.

See Also:

• Documentation on elastic.co

syncJobList

public final CompletableFuture<SyncJobListResponse> syncJobList(Function<SyncJobListRequest.Builder,ObjectBuilder<SyncJobListRequest>> fn)

Get all connector sync jobs.

Get information about all stored connector sync jobs listed by their creation date in ascending order.

Parameters:

fn - a function that initializes a builder to create the SyncJobListRequest

See Also:

• Documentation on elastic.co

syncJobList

public CompletableFuture<SyncJobListResponse> syncJobList()

Get all connector sync jobs.

Get information about all stored connector sync jobs listed by their creation date in ascending order.

See Also:

• Documentation on elastic.co

syncJobPost

public CompletableFuture<SyncJobPostResponse> syncJobPost(SyncJobPostRequest request)

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

See Also:

• Documentation on elastic.co

syncJobPost

public final CompletableFuture<SyncJobPostResponse> syncJobPost(Function<SyncJobPostRequest.Builder,ObjectBuilder<SyncJobPostRequest>> fn)

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

Parameters:

fn - a function that initializes a builder to create the SyncJobPostRequest

See Also:

• Documentation on elastic.co

syncJobUpdateStats

public CompletableFuture<SyncJobUpdateStatsResponse> syncJobUpdateStats(SyncJobUpdateStatsRequest request)

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:

• Documentation on elastic.co

syncJobUpdateStats

public final CompletableFuture<SyncJobUpdateStatsResponse> syncJobUpdateStats(Function<SyncJobUpdateStatsRequest.Builder,ObjectBuilder<SyncJobUpdateStatsRequest>> fn)

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.

Parameters:

fn - a function that initializes a builder to create the SyncJobUpdateStatsRequest

See Also:

• Documentation on elastic.co

updateActiveFiltering

public CompletableFuture<UpdateActiveFilteringResponse> updateActiveFiltering(UpdateActiveFilteringRequest request)

Activate the connector draft filter.

Activates the valid draft filtering for a connector.

See Also:

• Documentation on elastic.co

updateActiveFiltering

public final CompletableFuture<UpdateActiveFilteringResponse> updateActiveFiltering(Function<UpdateActiveFilteringRequest.Builder,ObjectBuilder<UpdateActiveFilteringRequest>> fn)

Activate the connector draft filter.

Activates the valid draft filtering for a connector.

Parameters:

fn - a function that initializes a builder to create the UpdateActiveFilteringRequest

See Also:

• Documentation on elastic.co

updateApiKeyId

public CompletableFuture<UpdateApiKeyIdResponse> updateApiKeyId(UpdateApiKeyIdRequest request)

Update the connector API key ID.

Update the api_key_id and api_key_secret_id fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

See Also:

• Documentation on elastic.co

updateApiKeyId

public final CompletableFuture<UpdateApiKeyIdResponse> updateApiKeyId(Function<UpdateApiKeyIdRequest.Builder,ObjectBuilder<UpdateApiKeyIdRequest>> fn)

Update the connector API key ID.

Update the api_key_id and api_key_secret_id fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

Parameters:

fn - a function that initializes a builder to create the UpdateApiKeyIdRequest

See Also:

• Documentation on elastic.co

updateConfiguration

public CompletableFuture<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request)

Update the connector configuration.

Update the configuration field in the connector document.

See Also:

• Documentation on elastic.co

updateConfiguration

public final CompletableFuture<UpdateConfigurationResponse> updateConfiguration(Function<UpdateConfigurationRequest.Builder,ObjectBuilder<UpdateConfigurationRequest>> fn)

Update the connector configuration.

Update the configuration field in the connector document.

Parameters:

fn - a function that initializes a builder to create the UpdateConfigurationRequest

See Also:

• Documentation on elastic.co

updateError

public CompletableFuture<UpdateErrorResponse> updateError(UpdateErrorRequest request)

Update the connector error field.

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

See Also:

• Documentation on elastic.co

updateError

public final CompletableFuture<UpdateErrorResponse> updateError(Function<UpdateErrorRequest.Builder,ObjectBuilder<UpdateErrorRequest>> fn)

Update the connector error field.

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

Parameters:

fn - a function that initializes a builder to create the UpdateErrorRequest

See Also:

• Documentation on elastic.co

updateFeatures

public CompletableFuture<UpdateFeaturesResponse> updateFeatures(UpdateFeaturesRequest request)

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:

• Documentation on elastic.co

updateFeatures

public final CompletableFuture<UpdateFeaturesResponse> updateFeatures(Function<UpdateFeaturesRequest.Builder,ObjectBuilder<UpdateFeaturesRequest>> fn)

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.

Parameters:

fn - a function that initializes a builder to create the UpdateFeaturesRequest

See Also:

• Documentation on elastic.co

updateFiltering

public CompletableFuture<UpdateFilteringResponse> updateFiltering(UpdateFilteringRequest request)

Update the connector filtering.

Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.

See Also:

• Documentation on elastic.co

updateFiltering

public final CompletableFuture<UpdateFilteringResponse> updateFiltering(Function<UpdateFilteringRequest.Builder,ObjectBuilder<UpdateFilteringRequest>> fn)

Update the connector filtering.

Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.

Parameters:

fn - a function that initializes a builder to create the UpdateFilteringRequest

See Also:

• Documentation on elastic.co

updateFilteringValidation

public CompletableFuture<UpdateFilteringValidationResponse> updateFilteringValidation(UpdateFilteringValidationRequest request)

Update the connector draft filtering validation.

Update the draft filtering validation info for a connector.

See Also:

• Documentation on elastic.co

updateFilteringValidation

public final CompletableFuture<UpdateFilteringValidationResponse> updateFilteringValidation(Function<UpdateFilteringValidationRequest.Builder,ObjectBuilder<UpdateFilteringValidationRequest>> fn)

Update the connector draft filtering validation.

Update the draft filtering validation info for a connector.

Parameters:

fn - a function that initializes a builder to create the UpdateFilteringValidationRequest

See Also:

• Documentation on elastic.co

updateIndexName

public CompletableFuture<UpdateIndexNameResponse> updateIndexName(UpdateIndexNameRequest request)

Update the connector index name.

Update the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

See Also:

• Documentation on elastic.co

updateIndexName

public final CompletableFuture<UpdateIndexNameResponse> updateIndexName(Function<UpdateIndexNameRequest.Builder,ObjectBuilder<UpdateIndexNameRequest>> fn)

Update the connector index name.

Update the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

Parameters:

fn - a function that initializes a builder to create the UpdateIndexNameRequest

See Also:

• Documentation on elastic.co

updateName

public CompletableFuture<UpdateNameResponse> updateName(UpdateNameRequest request)

Update the connector name and description.

See Also:

• Documentation on elastic.co

updateName

public final CompletableFuture<UpdateNameResponse> updateName(Function<UpdateNameRequest.Builder,ObjectBuilder<UpdateNameRequest>> fn)

Update the connector name and description.

Parameters:

fn - a function that initializes a builder to create the UpdateNameRequest

See Also:

• Documentation on elastic.co

updateNative

public CompletableFuture<UpdateNativeResponse> updateNative(UpdateNativeRequest request)

Update the connector is_native flag.

See Also:

• Documentation on elastic.co

updateNative

public final CompletableFuture<UpdateNativeResponse> updateNative(Function<UpdateNativeRequest.Builder,ObjectBuilder<UpdateNativeRequest>> fn)

Update the connector is_native flag.

Parameters:

fn - a function that initializes a builder to create the UpdateNativeRequest

See Also:

• Documentation on elastic.co

updatePipeline

public CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest request)

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

See Also:

• Documentation on elastic.co

updatePipeline

public final CompletableFuture<UpdatePipelineResponse> updatePipeline(Function<UpdatePipelineRequest.Builder,ObjectBuilder<UpdatePipelineRequest>> fn)

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

Parameters:

fn - a function that initializes a builder to create the UpdatePipelineRequest

See Also:

• Documentation on elastic.co

updateScheduling

public CompletableFuture<UpdateSchedulingResponse> updateScheduling(UpdateSchedulingRequest request)

Update the connector scheduling.

See Also:

• Documentation on elastic.co

updateScheduling

public final CompletableFuture<UpdateSchedulingResponse> updateScheduling(Function<UpdateSchedulingRequest.Builder,ObjectBuilder<UpdateSchedulingRequest>> fn)

Update the connector scheduling.

Parameters:

fn - a function that initializes a builder to create the UpdateSchedulingRequest

See Also:

• Documentation on elastic.co

updateServiceType

public CompletableFuture<UpdateServiceTypeResponse> updateServiceType(UpdateServiceTypeRequest request)

Update the connector service type.

See Also:

• Documentation on elastic.co

updateServiceType

public final CompletableFuture<UpdateServiceTypeResponse> updateServiceType(Function<UpdateServiceTypeRequest.Builder,ObjectBuilder<UpdateServiceTypeRequest>> fn)

Update the connector service type.

Parameters:

fn - a function that initializes a builder to create the UpdateServiceTypeRequest

See Also:

• Documentation on elastic.co

updateStatus

public CompletableFuture<UpdateStatusResponse> updateStatus(UpdateStatusRequest request)

Update the connector status.

See Also:

• Documentation on elastic.co

updateStatus

public final CompletableFuture<UpdateStatusResponse> updateStatus(Function<UpdateStatusRequest.Builder,ObjectBuilder<UpdateStatusRequest>> fn)

Update the connector status.

Parameters:

fn - a function that initializes a builder to create the UpdateStatusRequest

See Also:

• Documentation on elastic.co