Package co.elastic.clients.elasticsearch.cat.transforms

Class TransformsRecord

java.lang.Object
co.elastic.clients.elasticsearch.cat.transforms.TransformsRecord
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class TransformsRecord extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static TransformsRecord of(Function<TransformsRecord.Builder,ObjectBuilder<TransformsRecord>> fn)

    • id

      @Nullable public final String id()
      The transform identifier.

      API name: id

    • state

      @Nullable public final String state()
      The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check the reasonfield.indexing: The transform is actively processing data and creating new documents. started: The transform is running but not actively indexing data. stopped: The transform is stopped. stopping`: The transform is stopping.

      API name: state

    • checkpoint

      @Nullable public final String checkpoint()
      The sequence number for the checkpoint.

      API name: checkpoint

    • documentsProcessed

      @Nullable public final String documentsProcessed()
      The number of documents that have been processed from the source index of the transform.

      API name: documents_processed

    • checkpointProgress

      @Nullable public final String checkpointProgress()
      The progress of the next checkpoint that is currently in progress.

      API name: checkpoint_progress

    • lastSearchTime

      @Nullable public final String lastSearchTime()
      The timestamp of the last search in the source indices. This field is shown only if the transform is running.

      API name: last_search_time

    • changesLastDetectionTime

      @Nullable public final String changesLastDetectionTime()
      The timestamp when changes were last detected in the source indices.

      API name: changes_last_detection_time

    • createTime

      @Nullable public final String createTime()
      The time the transform was created.

      API name: create_time

    • version

      @Nullable public final String version()
      The version of Elasticsearch that existed on the node when the transform was created.

      API name: version

    • sourceIndex

      @Nullable public final String sourceIndex()
      The source indices for the transform.

      API name: source_index

    • destIndex

      @Nullable public final String destIndex()
      The destination index for the transform.

      API name: dest_index

    • pipeline

      @Nullable public final String pipeline()
      The unique identifier for the ingest pipeline.

      API name: pipeline

    • description

      @Nullable public final String description()
      The description of the transform.

      API name: description

    • transformType

      @Nullable public final String transformType()
      The type of transform: batch or continuous.

      API name: transform_type

    • frequency

      @Nullable public final String frequency()
      The interval between checks for changes in the source indices when the transform is running continuously.

      API name: frequency

    • maxPageSearchSize

      @Nullable public final String maxPageSearchSize()
      The initial page size that is used for the composite aggregation for each checkpoint.

      API name: max_page_search_size

    • docsPerSecond

      @Nullable public final String docsPerSecond()
      The number of input documents per second.

      API name: docs_per_second

    • reason

      @Nullable public final String reason()
      If a transform has a failed state, these details describe the reason for failure.

      API name: reason

    • searchTotal

      @Nullable public final String searchTotal()
      The total number of search operations on the source index for the transform.

      API name: search_total

    • searchFailure

      @Nullable public final String searchFailure()
      The total number of search failures.

      API name: search_failure

    • searchTime

      @Nullable public final String searchTime()
      The total amount of search time, in milliseconds.

      API name: search_time

    • indexTotal

      @Nullable public final String indexTotal()
      The total number of index operations done by the transform.

      API name: index_total

    • indexFailure

      @Nullable public final String indexFailure()
      The total number of indexing failures.

      API name: index_failure

    • indexTime

      @Nullable public final String indexTime()
      The total time spent indexing documents, in milliseconds.

      API name: index_time

    • documentsIndexed

      @Nullable public final String documentsIndexed()
      The number of documents that have been indexed into the destination index for the transform.

      API name: documents_indexed

    • deleteTime

      @Nullable public final String deleteTime()
      The total time spent deleting documents, in milliseconds.

      API name: delete_time

    • documentsDeleted

      @Nullable public final String documentsDeleted()
      The number of documents deleted from the destination index due to the retention policy for the transform.

      API name: documents_deleted

    • triggerCount

      @Nullable public final String triggerCount()
      The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

      API name: trigger_count

    • pagesProcessed

      @Nullable public final String pagesProcessed()
      The number of search or bulk index operations processed. Documents are processed in batches instead of individually.

      API name: pages_processed

    • processingTime

      @Nullable public final String processingTime()
      The total time spent processing results, in milliseconds.

      API name: processing_time

    • checkpointDurationTimeExpAvg

      @Nullable public final String checkpointDurationTimeExpAvg()
      The exponential moving average of the duration of the checkpoint, in milliseconds.

      API name: checkpoint_duration_time_exp_avg

    • indexedDocumentsExpAvg

      @Nullable public final String indexedDocumentsExpAvg()
      The exponential moving average of the number of new documents that have been indexed.

      API name: indexed_documents_exp_avg

    • processedDocumentsExpAvg

      @Nullable public final String processedDocumentsExpAvg()
      The exponential moving average of the number of documents that have been processed.

      API name: processed_documents_exp_avg

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupTransformsRecordDeserializer

      protected static void setupTransformsRecordDeserializer(ObjectDeserializer<TransformsRecord.Builder> op)