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

Class TransformsRecord.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<TransformsRecord.Builder>
co.elastic.clients.elasticsearch.cat.transforms.TransformsRecord.Builder
All Implemented Interfaces:
WithJson<TransformsRecord.Builder>, ObjectBuilder<TransformsRecord>
Enclosing class:
TransformsRecord
public static class TransformsRecord.Builder extends WithJsonObjectBuilderBase<TransformsRecord.Builder> implements ObjectBuilder<TransformsRecord>
Builder for TransformsRecord.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

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

      API name: id

    • state

      public final TransformsRecord.Builder state(@Nullable String value)
      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

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

      API name: checkpoint

    • documentsProcessed

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

      API name: documents_processed

    • checkpointProgress

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

      API name: checkpoint_progress

    • lastSearchTime

      public final TransformsRecord.Builder lastSearchTime(@Nullable String value)
      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

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

      API name: changes_last_detection_time

    • createTime

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

      API name: create_time

    • version

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

      API name: version

    • sourceIndex

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

      API name: source_index

    • destIndex

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

      API name: dest_index

    • pipeline

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

      API name: pipeline

    • description

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

      API name: description

    • transformType

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

      API name: transform_type

    • frequency

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

      API name: frequency

    • maxPageSearchSize

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

      API name: max_page_search_size

    • docsPerSecond

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

      API name: docs_per_second

    • reason

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

      API name: reason

    • searchTotal

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

      API name: search_total

    • searchFailure

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

      API name: search_failure

    • searchTime

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

      API name: search_time

    • indexTotal

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

      API name: index_total

    • indexFailure

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

      API name: index_failure

    • indexTime

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

      API name: index_time

    • documentsIndexed

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

      API name: documents_indexed

    • deleteTime

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

      API name: delete_time

    • documentsDeleted

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

      API name: documents_deleted

    • triggerCount

      public final TransformsRecord.Builder triggerCount(@Nullable String value)
      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

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

      API name: pages_processed

    • processingTime

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

      API name: processing_time

    • checkpointDurationTimeExpAvg

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

      API name: checkpoint_duration_time_exp_avg

    • indexedDocumentsExpAvg

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

      API name: indexed_documents_exp_avg

    • processedDocumentsExpAvg

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

      API name: processed_documents_exp_avg

    • self

      protected TransformsRecord.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<TransformsRecord.Builder>

    • build

      public TransformsRecord build()
      Builds a TransformsRecord.
      Specified by:
      build in interface ObjectBuilder<TransformsRecord>
      Throws:
      NullPointerException - if some of the required fields are null.