Package co.elastic.clients.elasticsearch.connector

Class ElasticsearchConnectorClient

java.lang.Object

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

co.elastic.clients.elasticsearch.connector.ElasticsearchConnectorClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchConnectorClient
extends ApiClient<ElasticsearchTransport,ElasticsearchConnectorClient>

Client for the connector namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchConnectorClient

public ElasticsearchConnectorClient(ElasticsearchTransport transport)

ElasticsearchConnectorClient

public ElasticsearchConnectorClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchConnectorClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchConnectorClient>

checkIn

public CheckInResponse checkIn(CheckInRequest request)
                        throws IOException,
ElasticsearchException

Check in a connector.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

checkIn

public final CheckInResponse checkIn(Function<CheckInRequest.Builder,ObjectBuilder<CheckInRequest>> fn)
                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public DeleteConnectorResponse delete(DeleteConnectorRequest request)
                               throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

delete

public final DeleteConnectorResponse delete(Function<DeleteConnectorRequest.Builder,ObjectBuilder<DeleteConnectorRequest>> fn)
                                     throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public GetConnectorResponse get(GetConnectorRequest request)
                         throws IOException,
ElasticsearchException

Get a connector.

Get the details about a connector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

get

public final GetConnectorResponse get(Function<GetConnectorRequest.Builder,ObjectBuilder<GetConnectorRequest>> fn)
                               throws IOException,
ElasticsearchException

Get a connector.

Get the details about a connector.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list(ListRequest request)
                  throws IOException,
ElasticsearchException

Get all connectors.

Get information about all connectors.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public final ListResponse list(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
                        throws IOException,
ElasticsearchException

Get all connectors.

Get information about all connectors.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

list

public ListResponse list()
                  throws IOException,
ElasticsearchException

Get all connectors.

Get information about all connectors.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public PostResponse post(PostRequest request)
                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public final PostResponse post(Function<PostRequest.Builder,ObjectBuilder<PostRequest>> fn)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

post

public PostResponse post()
                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

put

public PutResponse put(PutRequest request)
                throws IOException,
ElasticsearchException

Create or update a connector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

put

public final PutResponse put(Function<PutRequest.Builder,ObjectBuilder<PutRequest>> fn)
                      throws IOException,
ElasticsearchException

Create or update a connector.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

put

public PutResponse put()
                throws IOException,
ElasticsearchException

Create or update a connector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobCancel

public SyncJobCancelResponse syncJobCancel(SyncJobCancelRequest request)
                                    throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobCancel

public final SyncJobCancelResponse syncJobCancel(Function<SyncJobCancelRequest.Builder,ObjectBuilder<SyncJobCancelRequest>> fn)
                                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobCheckIn

public SyncJobCheckInResponse syncJobCheckIn(SyncJobCheckInRequest request)
                                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobCheckIn

public final SyncJobCheckInResponse syncJobCheckIn(Function<SyncJobCheckInRequest.Builder,ObjectBuilder<SyncJobCheckInRequest>> fn)
                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobClaim

public SyncJobClaimResponse syncJobClaim(SyncJobClaimRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobClaim

public final SyncJobClaimResponse syncJobClaim(Function<SyncJobClaimRequest.Builder,ObjectBuilder<SyncJobClaimRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobDelete

public SyncJobDeleteResponse syncJobDelete(SyncJobDeleteRequest request)
                                    throws IOException,
ElasticsearchException

Delete a connector sync job.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobDelete

public final SyncJobDeleteResponse syncJobDelete(Function<SyncJobDeleteRequest.Builder,ObjectBuilder<SyncJobDeleteRequest>> fn)
                                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobError

public SyncJobErrorResponse syncJobError(SyncJobErrorRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobError

public final SyncJobErrorResponse syncJobError(Function<SyncJobErrorRequest.Builder,ObjectBuilder<SyncJobErrorRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobGet

public SyncJobGetResponse syncJobGet(SyncJobGetRequest request)
                              throws IOException,
ElasticsearchException

Get a connector sync job.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobGet

public final SyncJobGetResponse syncJobGet(Function<SyncJobGetRequest.Builder,ObjectBuilder<SyncJobGetRequest>> fn)
                                    throws IOException,
ElasticsearchException

Get a connector sync job.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobList

public SyncJobListResponse syncJobList(SyncJobListRequest request)
                                throws IOException,
ElasticsearchException

Get all connector sync jobs.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobList

public final SyncJobListResponse syncJobList(Function<SyncJobListRequest.Builder,ObjectBuilder<SyncJobListRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobList

public SyncJobListResponse syncJobList()
                                throws IOException,
ElasticsearchException

Get all connector sync jobs.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobPost

public SyncJobPostResponse syncJobPost(SyncJobPostRequest request)
                                throws IOException,
ElasticsearchException

Create a connector sync job.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobPost

public final SyncJobPostResponse syncJobPost(Function<SyncJobPostRequest.Builder,ObjectBuilder<SyncJobPostRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobUpdateStats

public SyncJobUpdateStatsResponse syncJobUpdateStats(SyncJobUpdateStatsRequest request)
                                              throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

syncJobUpdateStats

public final SyncJobUpdateStatsResponse syncJobUpdateStats(Function<SyncJobUpdateStatsRequest.Builder,ObjectBuilder<SyncJobUpdateStatsRequest>> fn)
                                                    throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateActiveFiltering

public UpdateActiveFilteringResponse updateActiveFiltering(UpdateActiveFilteringRequest request)
                                                    throws IOException,
ElasticsearchException

Activate the connector draft filter.

Activates the valid draft filtering for a connector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateActiveFiltering

public final UpdateActiveFilteringResponse updateActiveFiltering(Function<UpdateActiveFilteringRequest.Builder,ObjectBuilder<UpdateActiveFilteringRequest>> fn)
                                                          throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateApiKeyId

public UpdateApiKeyIdResponse updateApiKeyId(UpdateApiKeyIdRequest request)
                                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateApiKeyId

public final UpdateApiKeyIdResponse updateApiKeyId(Function<UpdateApiKeyIdRequest.Builder,ObjectBuilder<UpdateApiKeyIdRequest>> fn)
                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateConfiguration

public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
                                                throws IOException,
ElasticsearchException

Update the connector configuration.

Update the configuration field in the connector document.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateConfiguration

public final UpdateConfigurationResponse updateConfiguration(Function<UpdateConfigurationRequest.Builder,ObjectBuilder<UpdateConfigurationRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Update the connector configuration.

Update the configuration field in the connector document.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateError

public UpdateErrorResponse updateError(UpdateErrorRequest request)
                                throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateError

public final UpdateErrorResponse updateError(Function<UpdateErrorRequest.Builder,ObjectBuilder<UpdateErrorRequest>> fn)
                                      throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFeatures

public UpdateFeaturesResponse updateFeatures(UpdateFeaturesRequest request)
                                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFeatures

public final UpdateFeaturesResponse updateFeatures(Function<UpdateFeaturesRequest.Builder,ObjectBuilder<UpdateFeaturesRequest>> fn)
                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFiltering

public UpdateFilteringResponse updateFiltering(UpdateFilteringRequest request)
                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFiltering

public final UpdateFilteringResponse updateFiltering(Function<UpdateFilteringRequest.Builder,ObjectBuilder<UpdateFilteringRequest>> fn)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFilteringValidation

public UpdateFilteringValidationResponse updateFilteringValidation(UpdateFilteringValidationRequest request)
                                                            throws IOException,
ElasticsearchException

Update the connector draft filtering validation.

Update the draft filtering validation info for a connector.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateFilteringValidation

public final UpdateFilteringValidationResponse updateFilteringValidation(Function<UpdateFilteringValidationRequest.Builder,ObjectBuilder<UpdateFilteringValidationRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateIndexName

public UpdateIndexNameResponse updateIndexName(UpdateIndexNameRequest request)
                                        throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateIndexName

public final UpdateIndexNameResponse updateIndexName(Function<UpdateIndexNameRequest.Builder,ObjectBuilder<UpdateIndexNameRequest>> fn)
                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateName

public UpdateNameResponse updateName(UpdateNameRequest request)
                              throws IOException,
ElasticsearchException

Update the connector name and description.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateName

public final UpdateNameResponse updateName(Function<UpdateNameRequest.Builder,ObjectBuilder<UpdateNameRequest>> fn)
                                    throws IOException,
ElasticsearchException

Update the connector name and description.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateNative

public UpdateNativeResponse updateNative(UpdateNativeRequest request)
                                  throws IOException,
ElasticsearchException

Update the connector is_native flag.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateNative

public final UpdateNativeResponse updateNative(Function<UpdateNativeRequest.Builder,ObjectBuilder<UpdateNativeRequest>> fn)
                                        throws IOException,
ElasticsearchException

Update the connector is_native flag.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updatePipeline

public UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request)
                                      throws IOException,
ElasticsearchException

Update the connector pipeline.

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updatePipeline

public final UpdatePipelineResponse updatePipeline(Function<UpdatePipelineRequest.Builder,ObjectBuilder<UpdatePipelineRequest>> fn)
                                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateScheduling

public UpdateSchedulingResponse updateScheduling(UpdateSchedulingRequest request)
                                          throws IOException,
ElasticsearchException

Update the connector scheduling.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateScheduling

public final UpdateSchedulingResponse updateScheduling(Function<UpdateSchedulingRequest.Builder,ObjectBuilder<UpdateSchedulingRequest>> fn)
                                                throws IOException,
ElasticsearchException

Update the connector scheduling.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateServiceType

public UpdateServiceTypeResponse updateServiceType(UpdateServiceTypeRequest request)
                                            throws IOException,
ElasticsearchException

Update the connector service type.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateServiceType

public final UpdateServiceTypeResponse updateServiceType(Function<UpdateServiceTypeRequest.Builder,ObjectBuilder<UpdateServiceTypeRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Update the connector service type.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateStatus

public UpdateStatusResponse updateStatus(UpdateStatusRequest request)
                                  throws IOException,
ElasticsearchException

Update the connector status.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateStatus

public final UpdateStatusResponse updateStatus(Function<UpdateStatusRequest.Builder,ObjectBuilder<UpdateStatusRequest>> fn)
                                        throws IOException,
ElasticsearchException

Update the connector status.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co