All Downloads are FREE. Search and download functionalities are using the official Maven repository.

co.elastic.clients.elasticsearch.simulate.ElasticsearchSimulateAsyncClient Maven / Gradle / Ivy

The newest version!
/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package co.elastic.clients.elasticsearch.simulate;

import co.elastic.clients.ApiClient;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.JsonEndpoint;
import co.elastic.clients.transport.Transport;
import co.elastic.clients.transport.TransportOptions;
import co.elastic.clients.util.ObjectBuilder;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import javax.annotation.Nullable;

//----------------------------------------------------------------
//       THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------

/**
 * Client for the simulate namespace.
 */
public class ElasticsearchSimulateAsyncClient
		extends
			ApiClient {

	public ElasticsearchSimulateAsyncClient(ElasticsearchTransport transport) {
		super(transport, null);
	}

	public ElasticsearchSimulateAsyncClient(ElasticsearchTransport transport,
			@Nullable TransportOptions transportOptions) {
		super(transport, transportOptions);
	}

	@Override
	public ElasticsearchSimulateAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions) {
		return new ElasticsearchSimulateAsyncClient(this.transport, transportOptions);
	}

	// ----- Endpoint: simulate.ingest

	/**
	 * Simulate data ingestion. Run ingest pipelines against a set of provided
	 * documents, optionally with substitute pipeline definitions, to simulate
	 * ingesting data into an index.
	 * 

* This API is meant to be used for troubleshooting or pipeline development, as * it does not actually index any data into Elasticsearch. *

* The API runs the default and final pipeline for that index against a set of * documents provided in the body of the request. If a pipeline contains a * reroute processor, it follows that reroute processor to the new index, * running that index's pipelines as well the same way that a non-simulated * ingest would. No data is indexed into Elasticsearch. Instead, the transformed * document is returned, along with the list of pipelines that have been run and * the name of the index where the document would have been indexed if this were * not a simulation. The transformed document is validated against the mappings * that would apply to this index, and any validation error is reported in the * result. *

* This API differs from the simulate pipeline API in that you specify a single * pipeline for that API, and it runs only that one pipeline. The simulate * pipeline API is more useful for developing a single pipeline, while the * simulate ingest API is more useful for troubleshooting the interaction of the * various pipelines that get applied when ingesting into an index. *

* By default, the pipeline definitions that are currently in the system are * used. However, you can supply substitute pipeline definitions in the body of * the request. These will be used in place of the pipeline definitions that are * already in the system. This can be used to replace existing pipeline * definitions or to create new ones. The pipeline substitutions are used only * within this request. * * @see Documentation * on elastic.co */ public CompletableFuture ingest(IngestRequest request) { @SuppressWarnings("unchecked") JsonEndpoint endpoint = (JsonEndpoint) IngestRequest._ENDPOINT; return this.transport.performRequestAsync(request, endpoint, this.transportOptions); } /** * Simulate data ingestion. Run ingest pipelines against a set of provided * documents, optionally with substitute pipeline definitions, to simulate * ingesting data into an index. *

* This API is meant to be used for troubleshooting or pipeline development, as * it does not actually index any data into Elasticsearch. *

* The API runs the default and final pipeline for that index against a set of * documents provided in the body of the request. If a pipeline contains a * reroute processor, it follows that reroute processor to the new index, * running that index's pipelines as well the same way that a non-simulated * ingest would. No data is indexed into Elasticsearch. Instead, the transformed * document is returned, along with the list of pipelines that have been run and * the name of the index where the document would have been indexed if this were * not a simulation. The transformed document is validated against the mappings * that would apply to this index, and any validation error is reported in the * result. *

* This API differs from the simulate pipeline API in that you specify a single * pipeline for that API, and it runs only that one pipeline. The simulate * pipeline API is more useful for developing a single pipeline, while the * simulate ingest API is more useful for troubleshooting the interaction of the * various pipelines that get applied when ingesting into an index. *

* By default, the pipeline definitions that are currently in the system are * used. However, you can supply substitute pipeline definitions in the body of * the request. These will be used in place of the pipeline definitions that are * already in the system. This can be used to replace existing pipeline * definitions or to create new ones. The pipeline substitutions are used only * within this request. * * @param fn * a function that initializes a builder to create the * {@link IngestRequest} * @see Documentation * on elastic.co */ public final CompletableFuture ingest( Function> fn) { return ingest(fn.apply(new IngestRequest.Builder()).build()); } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy