Class ElasticsearchConnectorClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchConnectorClient>
co.elastic.clients.elasticsearch.connector.ElasticsearchConnectorClient
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
ConstructorsConstructorDescriptionElasticsearchConnectorClient(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptioncheckIn(CheckInRequest request) Updates the last_seen field in the connector, and sets it to current timestampfinal CheckInResponseUpdates the last_seen field in the connector, and sets it to current timestampdelete(DeleteConnectorRequest request) Deletes a connector.final DeleteConnectorResponseDeletes a connector.get(GetConnectorRequest request) Retrieves a connector.final GetConnectorResponseRetrieves a connector.list()Returns existing connectors.list(ListRequest request) Returns existing connectors.final ListResponseReturns existing connectors.post()Creates a connector.post(PostRequest request) Creates a connector.final PostResponseCreates a connector.put()Creates or updates a connector.put(PutRequest request) Creates or updates a connector.final PutResponseCreates or updates a connector.syncJobCancel(SyncJobCancelRequest request) Cancels a connector sync job.final SyncJobCancelResponseCancels a connector sync job.syncJobDelete(SyncJobDeleteRequest request) Deletes a connector sync job.final SyncJobDeleteResponseDeletes a connector sync job.syncJobGet(SyncJobGetRequest request) Retrieves a connector sync job.final SyncJobGetResponseRetrieves a connector sync job.Lists connector sync jobs.syncJobList(SyncJobListRequest request) Lists connector sync jobs.final SyncJobListResponseLists connector sync jobs.syncJobPost(SyncJobPostRequest request) Creates a connector sync job.final SyncJobPostResponseCreates a connector sync job.Activates the valid draft filtering for a connector.updateActiveFiltering(Function<UpdateActiveFilteringRequest.Builder, ObjectBuilder<UpdateActiveFilteringRequest>> fn) Activates the valid draft filtering for a connector.updateApiKeyId(UpdateApiKeyIdRequest request) Updates the API key id in the connector documentfinal UpdateApiKeyIdResponseUpdates the API key id in the connector documentUpdates the configuration field in the connector documentupdateConfiguration(Function<UpdateConfigurationRequest.Builder, ObjectBuilder<UpdateConfigurationRequest>> fn) Updates the configuration field in the connector documentupdateError(UpdateErrorRequest request) Updates the filtering field in the connector documentfinal UpdateErrorResponseUpdates the filtering field in the connector documentupdateFiltering(UpdateFilteringRequest request) Updates the filtering field in the connector documentfinal UpdateFilteringResponseUpdates the filtering field in the connector documentUpdates the draft filtering validation info for a connector.updateFilteringValidation(Function<UpdateFilteringValidationRequest.Builder, ObjectBuilder<UpdateFilteringValidationRequest>> fn) Updates the draft filtering validation info for a connector.updateIndexName(UpdateIndexNameRequest request) Updates the index_name in the connector documentfinal UpdateIndexNameResponseUpdates the index_name in the connector documentupdateName(UpdateNameRequest request) Updates the name and description fields in the connector documentfinal UpdateNameResponseUpdates the name and description fields in the connector documentupdateNative(UpdateNativeRequest request) Updates the is_native flag in the connector documentfinal UpdateNativeResponseUpdates the is_native flag in the connector documentupdatePipeline(UpdatePipelineRequest request) Updates the pipeline field in the connector documentfinal UpdatePipelineResponseUpdates the pipeline field in the connector documentupdateScheduling(UpdateSchedulingRequest request) Updates the scheduling field in the connector documentfinal UpdateSchedulingResponseupdateScheduling(Function<UpdateSchedulingRequest.Builder, ObjectBuilder<UpdateSchedulingRequest>> fn) Updates the scheduling field in the connector documentUpdates the service type of the connectorupdateServiceType(Function<UpdateServiceTypeRequest.Builder, ObjectBuilder<UpdateServiceTypeRequest>> fn) Updates the service type of the connectorupdateStatus(UpdateStatusRequest request) Updates the status of the connectorfinal UpdateStatusResponseUpdates the status of the connectorwithTransportOptions(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchConnectorClient
-
ElasticsearchConnectorClient
public ElasticsearchConnectorClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
public ElasticsearchConnectorClient withTransportOptions(@Nullable TransportOptions transportOptions) Description copied from class:ApiClientCreates a new client with some request options- Specified by:
withTransportOptionsin classApiClient<ElasticsearchTransport,ElasticsearchConnectorClient>
-
checkIn
Updates the last_seen field in the connector, and sets it to current timestamp- Throws:
IOExceptionElasticsearchException- See Also:
-
checkIn
public final CheckInResponse checkIn(Function<CheckInRequest.Builder, ObjectBuilder<CheckInRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the last_seen field in the connector, and sets it to current timestamp- Parameters:
fn- a function that initializes a builder to create theCheckInRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
delete
public DeleteConnectorResponse delete(DeleteConnectorRequest request) throws IOException, ElasticsearchException Deletes a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
delete
public final DeleteConnectorResponse delete(Function<DeleteConnectorRequest.Builder, ObjectBuilder<DeleteConnectorRequest>> fn) throws IOException, ElasticsearchExceptionDeletes a connector.- Parameters:
fn- a function that initializes a builder to create theDeleteConnectorRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
get
public GetConnectorResponse get(GetConnectorRequest request) throws IOException, ElasticsearchException Retrieves a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
get
public final GetConnectorResponse get(Function<GetConnectorRequest.Builder, ObjectBuilder<GetConnectorRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves a connector.- Parameters:
fn- a function that initializes a builder to create theGetConnectorRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
list
Returns existing connectors.- Throws:
IOExceptionElasticsearchException- See Also:
-
list
public final ListResponse list(Function<ListRequest.Builder, ObjectBuilder<ListRequest>> fn) throws IOException, ElasticsearchExceptionReturns existing connectors.- Parameters:
fn- a function that initializes a builder to create theListRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
list
Returns existing connectors.- Throws:
IOExceptionElasticsearchException- See Also:
-
post
Creates a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
post
public final PostResponse post(Function<PostRequest.Builder, ObjectBuilder<PostRequest>> fn) throws IOException, ElasticsearchExceptionCreates a connector.- Parameters:
fn- a function that initializes a builder to create thePostRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
post
Creates a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
put
Creates or updates a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
put
public final PutResponse put(Function<PutRequest.Builder, ObjectBuilder<PutRequest>> fn) throws IOException, ElasticsearchExceptionCreates or updates a connector.- Parameters:
fn- a function that initializes a builder to create thePutRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
put
Creates or updates a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobCancel
public SyncJobCancelResponse syncJobCancel(SyncJobCancelRequest request) throws IOException, ElasticsearchException Cancels a connector sync job.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobCancel
public final SyncJobCancelResponse syncJobCancel(Function<SyncJobCancelRequest.Builder, ObjectBuilder<SyncJobCancelRequest>> fn) throws IOException, ElasticsearchExceptionCancels a connector sync job.- Parameters:
fn- a function that initializes a builder to create theSyncJobCancelRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobDelete
public SyncJobDeleteResponse syncJobDelete(SyncJobDeleteRequest request) throws IOException, ElasticsearchException Deletes a connector sync job.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobDelete
public final SyncJobDeleteResponse syncJobDelete(Function<SyncJobDeleteRequest.Builder, ObjectBuilder<SyncJobDeleteRequest>> fn) throws IOException, ElasticsearchExceptionDeletes a connector sync job.- Parameters:
fn- a function that initializes a builder to create theSyncJobDeleteRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobGet
public SyncJobGetResponse syncJobGet(SyncJobGetRequest request) throws IOException, ElasticsearchException Retrieves a connector sync job.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobGet
public final SyncJobGetResponse syncJobGet(Function<SyncJobGetRequest.Builder, ObjectBuilder<SyncJobGetRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves a connector sync job.- Parameters:
fn- a function that initializes a builder to create theSyncJobGetRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobList
public SyncJobListResponse syncJobList(SyncJobListRequest request) throws IOException, ElasticsearchException Lists connector sync jobs.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobList
public final SyncJobListResponse syncJobList(Function<SyncJobListRequest.Builder, ObjectBuilder<SyncJobListRequest>> fn) throws IOException, ElasticsearchExceptionLists connector sync jobs.- Parameters:
fn- a function that initializes a builder to create theSyncJobListRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobList
Lists connector sync jobs.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobPost
public SyncJobPostResponse syncJobPost(SyncJobPostRequest request) throws IOException, ElasticsearchException Creates a connector sync job.- Throws:
IOExceptionElasticsearchException- See Also:
-
syncJobPost
public final SyncJobPostResponse syncJobPost(Function<SyncJobPostRequest.Builder, ObjectBuilder<SyncJobPostRequest>> fn) throws IOException, ElasticsearchExceptionCreates a connector sync job.- Parameters:
fn- a function that initializes a builder to create theSyncJobPostRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateActiveFiltering
public UpdateActiveFilteringResponse updateActiveFiltering(UpdateActiveFilteringRequest request) throws IOException, ElasticsearchException Activates the valid draft filtering for a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
updateActiveFiltering
public final UpdateActiveFilteringResponse updateActiveFiltering(Function<UpdateActiveFilteringRequest.Builder, ObjectBuilder<UpdateActiveFilteringRequest>> fn) throws IOException, ElasticsearchExceptionActivates the valid draft filtering for a connector.- Parameters:
fn- a function that initializes a builder to create theUpdateActiveFilteringRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateApiKeyId
public UpdateApiKeyIdResponse updateApiKeyId(UpdateApiKeyIdRequest request) throws IOException, ElasticsearchException Updates the API key id in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateApiKeyId
public final UpdateApiKeyIdResponse updateApiKeyId(Function<UpdateApiKeyIdRequest.Builder, ObjectBuilder<UpdateApiKeyIdRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the API key id in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateApiKeyIdRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateConfiguration
public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request) throws IOException, ElasticsearchException Updates the configuration field in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateConfiguration
public final UpdateConfigurationResponse updateConfiguration(Function<UpdateConfigurationRequest.Builder, ObjectBuilder<UpdateConfigurationRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the configuration field in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateConfigurationRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateError
public UpdateErrorResponse updateError(UpdateErrorRequest request) throws IOException, ElasticsearchException Updates the filtering field in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateError
public final UpdateErrorResponse updateError(Function<UpdateErrorRequest.Builder, ObjectBuilder<UpdateErrorRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the filtering field in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateErrorRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateFiltering
public UpdateFilteringResponse updateFiltering(UpdateFilteringRequest request) throws IOException, ElasticsearchException Updates the filtering field in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateFiltering
public final UpdateFilteringResponse updateFiltering(Function<UpdateFilteringRequest.Builder, ObjectBuilder<UpdateFilteringRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the filtering field in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateFilteringRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateFilteringValidation
public UpdateFilteringValidationResponse updateFilteringValidation(UpdateFilteringValidationRequest request) throws IOException, ElasticsearchException Updates the draft filtering validation info for a connector.- Throws:
IOExceptionElasticsearchException- See Also:
-
updateFilteringValidation
public final UpdateFilteringValidationResponse updateFilteringValidation(Function<UpdateFilteringValidationRequest.Builder, ObjectBuilder<UpdateFilteringValidationRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the draft filtering validation info for a connector.- Parameters:
fn- a function that initializes a builder to create theUpdateFilteringValidationRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateIndexName
public UpdateIndexNameResponse updateIndexName(UpdateIndexNameRequest request) throws IOException, ElasticsearchException Updates the index_name in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateIndexName
public final UpdateIndexNameResponse updateIndexName(Function<UpdateIndexNameRequest.Builder, ObjectBuilder<UpdateIndexNameRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the index_name in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateIndexNameRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateName
public UpdateNameResponse updateName(UpdateNameRequest request) throws IOException, ElasticsearchException Updates the name and description fields in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateName
public final UpdateNameResponse updateName(Function<UpdateNameRequest.Builder, ObjectBuilder<UpdateNameRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the name and description fields in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateNameRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateNative
public UpdateNativeResponse updateNative(UpdateNativeRequest request) throws IOException, ElasticsearchException Updates the is_native flag in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateNative
public final UpdateNativeResponse updateNative(Function<UpdateNativeRequest.Builder, ObjectBuilder<UpdateNativeRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the is_native flag in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateNativeRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updatePipeline
public UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request) throws IOException, ElasticsearchException Updates the pipeline field in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updatePipeline
public final UpdatePipelineResponse updatePipeline(Function<UpdatePipelineRequest.Builder, ObjectBuilder<UpdatePipelineRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the pipeline field in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdatePipelineRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateScheduling
public UpdateSchedulingResponse updateScheduling(UpdateSchedulingRequest request) throws IOException, ElasticsearchException Updates the scheduling field in the connector document- Throws:
IOExceptionElasticsearchException- See Also:
-
updateScheduling
public final UpdateSchedulingResponse updateScheduling(Function<UpdateSchedulingRequest.Builder, ObjectBuilder<UpdateSchedulingRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the scheduling field in the connector document- Parameters:
fn- a function that initializes a builder to create theUpdateSchedulingRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateServiceType
public UpdateServiceTypeResponse updateServiceType(UpdateServiceTypeRequest request) throws IOException, ElasticsearchException Updates the service type of the connector- Throws:
IOExceptionElasticsearchException- See Also:
-
updateServiceType
public final UpdateServiceTypeResponse updateServiceType(Function<UpdateServiceTypeRequest.Builder, ObjectBuilder<UpdateServiceTypeRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the service type of the connector- Parameters:
fn- a function that initializes a builder to create theUpdateServiceTypeRequest- Throws:
IOExceptionElasticsearchException- See Also:
-
updateStatus
public UpdateStatusResponse updateStatus(UpdateStatusRequest request) throws IOException, ElasticsearchException Updates the status of the connector- Throws:
IOExceptionElasticsearchException- See Also:
-
updateStatus
public final UpdateStatusResponse updateStatus(Function<UpdateStatusRequest.Builder, ObjectBuilder<UpdateStatusRequest>> fn) throws IOException, ElasticsearchExceptionUpdates the status of the connector- Parameters:
fn- a function that initializes a builder to create theUpdateStatusRequest- Throws:
IOExceptionElasticsearchException- See Also:
-