Package org.elasticsearch.client

Class TransformClient

java.lang.Object
org.elasticsearch.client.TransformClient
public final class TransformClient
extends java.lang.Object

  • Method Details

    • putTransform

      public AcknowledgedResponse putTransform​(PutTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Creates a new transform

      For additional info see Create transform documentation

      Parameters:
      request - The PutTransformRequest containing the TransformConfig.
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      An AcknowledgedResponse object indicating request success
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • putTransformAsync

      public org.elasticsearch.client.Cancellable putTransformAsync​(PutTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Creates a new transform asynchronously and notifies listener on completion

      For additional info see Create transform documentation

      Parameters:
      request - The PutTransformRequest containing the TransformConfig.
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • updateTransform

      public UpdateTransformResponse updateTransform​(UpdateTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Updates an existing transform

      For additional info see Create transform documentation

      Parameters:
      request - The UpdateTransformRequest containing the TransformConfigUpdate.
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      An UpdateTransformResponse object containing the updated configuration
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • updateTransformAsync

      public org.elasticsearch.client.Cancellable updateTransformAsync​(UpdateTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<UpdateTransformResponse> listener)
      Updates an existing transform asynchronously and notifies listener on completion

      For additional info see Create transform documentation

      Parameters:
      request - The UpdateTransformRequest containing the TransformConfigUpdate.
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getTransformStats

      public GetTransformStatsResponse getTransformStats​(GetTransformStatsRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get the running statistics of a transform

      For additional info see Get transform stats documentation

      Parameters:
      request - Specifies which transforms to get the stats for
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      The transform stats
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • getTransformStatsAsync

      public org.elasticsearch.client.Cancellable getTransformStatsAsync​(GetTransformStatsRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTransformStatsResponse> listener)
      Get the running statistics of a transform asynchronously and notifies listener on completion

      For additional info see Get transform stats documentation

      Parameters:
      request - Specifies which transforms to get the stats for
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • deleteTransform

      public AcknowledgedResponse deleteTransform​(DeleteTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Delete a transform

      For additional info see Delete transform documentation

      Parameters:
      request - The delete transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      An AcknowledgedResponse object indicating request success
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • deleteTransformAsync

      public org.elasticsearch.client.Cancellable deleteTransformAsync​(DeleteTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<AcknowledgedResponse> listener)
      Delete a transform asynchronously and notifies listener on completion

      For additional info see Delete transform documentation

      Parameters:
      request - The delete transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • previewTransform

      public PreviewTransformResponse previewTransform​(PreviewTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Preview the result of a transform

      For additional info see Preview transform documentation

      Parameters:
      request - The preview transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      A response containing the results of the applied transform
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • previewTransformAsync

      public org.elasticsearch.client.Cancellable previewTransformAsync​(PreviewTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<PreviewTransformResponse> listener)
      Preview the result of a transform asynchronously and notifies listener on completion

      see Preview transform documentation

      Parameters:
      request - The preview transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • startTransform

      public StartTransformResponse startTransform​(StartTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Start a transform

      For additional info see Start transform documentation

      Parameters:
      request - The start transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      A response object indicating request success
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • startTransformAsync

      public org.elasticsearch.client.Cancellable startTransformAsync​(StartTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StartTransformResponse> listener)
      Start a transform asynchronously and notifies listener on completion

      For additional info see Start transform documentation

      Parameters:
      request - The start transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • stopTransform

      public StopTransformResponse stopTransform​(StopTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Stop a transform

      For additional info see Stop transform documentation

      Parameters:
      request - The stop transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      A response object indicating request success
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • stopTransformAsync

      public org.elasticsearch.client.Cancellable stopTransformAsync​(StopTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<StopTransformResponse> listener)
      Stop a transform asynchronously and notifies listener on completion

      For additional info see Stop transform documentation

      Parameters:
      request - The stop transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request

    • getTransform

      public GetTransformResponse getTransform​(GetTransformRequest request, org.elasticsearch.client.RequestOptions options) throws java.io.IOException
      Get one or more transform configurations

      For additional info see Get transform documentation

      Parameters:
      request - The get transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      Returns:
      An GetTransformResponse containing the requested transforms
      Throws:
      java.io.IOException - when there is a serialization issue sending the request or receiving the response

    • getTransformAsync

      public org.elasticsearch.client.Cancellable getTransformAsync​(GetTransformRequest request, org.elasticsearch.client.RequestOptions options, org.elasticsearch.action.ActionListener<GetTransformResponse> listener)
      Get one or more transform configurations asynchronously and notifies listener on completion

      For additional info see Get data transform documentation

      Parameters:
      request - The get transform request
      options - Additional request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized
      listener - Listener to be notified upon request completion
      Returns:
      cancellable that may be used to cancel the request