Put Pipeline API

Put Pipeline Request

A PutPipelineRequest requires an id argument, a source and a XContentType. The source consists of a description and a list of Processor objects.

String source =
    "{\"description\":\"my set of processors\"," +
        "\"processors\":[{\"set\":{\"field\":\"foo\",\"value\":\"bar\"}}]}";
PutPipelineRequest request = new PutPipelineRequest(
    "my-pipeline-id", 
    new BytesArray(source.getBytes(StandardCharsets.UTF_8)), 
    XContentType.JSON 
);

The pipeline id

The source for the pipeline as a ByteArray.

The XContentType for the pipeline source supplied above.

Optional arguments

The following arguments can optionally be provided:

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m"); 

Timeout to wait for the all the nodes to acknowledge the pipeline creation as a TimeValue

Timeout to wait for the all the nodes to acknowledge the pipeline creation as a String

request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m"); 

Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Execution

AcknowledgedResponse response = client.ingest().putPipeline(request, RequestOptions.DEFAULT); 

Execute the request and get back the response in a WritePipelineResponse object.

Asynchronous Execution

The asynchronous execution of a put pipeline request requires both the PutPipelineRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.ingest().putPipelineAsync(request, RequestOptions.DEFAULT, listener); 

The PutPipelineRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed.

A typical listener for WritePipelineResponse looks like:

ActionListener<AcknowledgedResponse> listener =
    new ActionListener<AcknowledgedResponse>() {
        @Override
        public void onResponse(AcknowledgedResponse response) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Put Pipeline Response

The returned WritePipelineResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = response.isAcknowledged(); 

Indicates whether all of the nodes have acknowledged the request