Class TransformsRecord.Builder
- All Implemented Interfaces:
WithJson<TransformsRecord.Builder>
,ObjectBuilder<TransformsRecord>
- Enclosing class:
- TransformsRecord
TransformsRecord
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aTransformsRecord
.final TransformsRecord.Builder
changesLastDetectionTime
(String value) The timestamp when changes were last detected in the source indices.final TransformsRecord.Builder
checkpoint
(String value) The sequence number for the checkpoint.final TransformsRecord.Builder
The exponential moving average of the duration of the checkpoint, in milliseconds.final TransformsRecord.Builder
checkpointProgress
(String value) The progress of the next checkpoint that is currently in progress.final TransformsRecord.Builder
createTime
(String value) The time the transform was created.final TransformsRecord.Builder
deleteTime
(String value) The total time spent deleting documents, in milliseconds.final TransformsRecord.Builder
description
(String value) The description of the transform.final TransformsRecord.Builder
The destination index for the transform.final TransformsRecord.Builder
docsPerSecond
(String value) The number of input documents per second.final TransformsRecord.Builder
documentsDeleted
(String value) The number of documents deleted from the destination index due to the retention policy for the transform.final TransformsRecord.Builder
documentsIndexed
(String value) The number of documents that have been indexed into the destination index for the transform.final TransformsRecord.Builder
documentsProcessed
(String value) The number of documents that have been processed from the source index of the transform.final TransformsRecord.Builder
The interval between checks for changes in the source indices when the transform is running continuously.final TransformsRecord.Builder
The transform identifier.final TransformsRecord.Builder
indexedDocumentsExpAvg
(String value) The exponential moving average of the number of new documents that have been indexed.final TransformsRecord.Builder
indexFailure
(String value) The total number of indexing failures.final TransformsRecord.Builder
The total time spent indexing documents, in milliseconds.final TransformsRecord.Builder
indexTotal
(String value) The total number of index operations done by the transform.final TransformsRecord.Builder
lastSearchTime
(String value) The timestamp of the last search in the source indices.final TransformsRecord.Builder
maxPageSearchSize
(String value) The initial page size that is used for the composite aggregation for each checkpoint.final TransformsRecord.Builder
pagesProcessed
(String value) The number of search or bulk index operations processed.final TransformsRecord.Builder
The unique identifier for the ingest pipeline.final TransformsRecord.Builder
processedDocumentsExpAvg
(String value) The exponential moving average of the number of documents that have been processed.final TransformsRecord.Builder
processingTime
(String value) The total time spent processing results, in milliseconds.final TransformsRecord.Builder
If a transform has afailed
state, these details describe the reason for failure.final TransformsRecord.Builder
searchFailure
(String value) The total number of search failures.final TransformsRecord.Builder
searchTime
(String value) The total amount of search time, in milliseconds.final TransformsRecord.Builder
searchTotal
(String value) The total number of search operations on the source index for the transform.protected TransformsRecord.Builder
self()
final TransformsRecord.Builder
sourceIndex
(String value) The source indices for the transform.final TransformsRecord.Builder
The status of the transform.final TransformsRecord.Builder
transformType
(String value) The type of transform:batch
orcontinuous
.final TransformsRecord.Builder
triggerCount
(String value) The number of times the transform has been triggered by the scheduler.final TransformsRecord.Builder
The version of Elasticsearch that existed on the node when the transform was created.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
The transform identifier.API name:
id
-
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
The sequence number for the checkpoint.API name:
checkpoint
-
documentsProcessed
The number of documents that have been processed from the source index of the transform.API name:
documents_processed
-
checkpointProgress
The progress of the next checkpoint that is currently in progress.API name:
checkpoint_progress
-
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
The timestamp when changes were last detected in the source indices.API name:
changes_last_detection_time
-
createTime
The time the transform was created.API name:
create_time
-
version
The version of Elasticsearch that existed on the node when the transform was created.API name:
version
-
sourceIndex
The source indices for the transform.API name:
source_index
-
destIndex
The destination index for the transform.API name:
dest_index
-
pipeline
The unique identifier for the ingest pipeline.API name:
pipeline
-
description
The description of the transform.API name:
description
-
transformType
The type of transform:batch
orcontinuous
.API name:
transform_type
-
frequency
The interval between checks for changes in the source indices when the transform is running continuously.API name:
frequency
-
maxPageSearchSize
The initial page size that is used for the composite aggregation for each checkpoint.API name:
max_page_search_size
-
docsPerSecond
The number of input documents per second.API name:
docs_per_second
-
reason
If a transform has afailed
state, these details describe the reason for failure.API name:
reason
-
searchTotal
The total number of search operations on the source index for the transform.API name:
search_total
-
searchFailure
The total number of search failures.API name:
search_failure
-
searchTime
The total amount of search time, in milliseconds.API name:
search_time
-
indexTotal
The total number of index operations done by the transform.API name:
index_total
-
indexFailure
The total number of indexing failures.API name:
index_failure
-
indexTime
The total time spent indexing documents, in milliseconds.API name:
index_time
-
documentsIndexed
The number of documents that have been indexed into the destination index for the transform.API name:
documents_indexed
-
deleteTime
The total time spent deleting documents, in milliseconds.API name:
delete_time
-
documentsDeleted
The number of documents deleted from the destination index due to the retention policy for the transform.API name:
documents_deleted
-
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 thefrequency
property.API name:
trigger_count
-
pagesProcessed
The number of search or bulk index operations processed. Documents are processed in batches instead of individually.API name:
pages_processed
-
processingTime
The total time spent processing results, in milliseconds.API name:
processing_time
-
checkpointDurationTimeExpAvg
The exponential moving average of the duration of the checkpoint, in milliseconds.API name:
checkpoint_duration_time_exp_avg
-
indexedDocumentsExpAvg
The exponential moving average of the number of new documents that have been indexed.API name:
indexed_documents_exp_avg
-
processedDocumentsExpAvg
The exponential moving average of the number of documents that have been processed.API name:
processed_documents_exp_avg
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<TransformsRecord.Builder>
-
build
Builds aTransformsRecord
.- Specified by:
build
in interfaceObjectBuilder<TransformsRecord>
- Throws:
NullPointerException
- if some of the required fields are null.
-