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 Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TransformsRecord	build()	Builds a TransformsRecord.
final TransformsRecord.Builder	changesLastDetectionTime(String value)	changes last detected time
final TransformsRecord.Builder	checkpoint(String value)	checkpoint
final TransformsRecord.Builder	checkpointDurationTimeExpAvg(String value)	exponential average checkpoint processing time (milliseconds)
final TransformsRecord.Builder	checkpointProgress(String value)	progress of the checkpoint
final TransformsRecord.Builder	createTime(String value)	transform creation time
final TransformsRecord.Builder	deleteTime(String value)	total time spent deleting documents
final TransformsRecord.Builder	description(String value)	description
final TransformsRecord.Builder	destIndex(String value)	destination index
final TransformsRecord.Builder	docsPerSecond(String value)	docs per second
final TransformsRecord.Builder	documentsDeleted(String value)	the number of documents deleted from the destination index
final TransformsRecord.Builder	documentsIndexed(String value)	the number of documents written to the destination index
final TransformsRecord.Builder	documentsProcessed(String value)	the number of documents read from source indices and processed
final TransformsRecord.Builder	frequency(String value)	frequency of transform
final TransformsRecord.Builder	id(String value)	the id
final TransformsRecord.Builder	indexedDocumentsExpAvg(String value)	exponential average number of documents indexed
final TransformsRecord.Builder	indexFailure(String value)	total number of index failures
final TransformsRecord.Builder	indexTime(String value)	total time spent indexing documents
final TransformsRecord.Builder	indexTotal(String value)	total number of index phases done by the transform
final TransformsRecord.Builder	lastSearchTime(String value)	last time transform searched for updates
final TransformsRecord.Builder	maxPageSearchSize(String value)	max page search size
final TransformsRecord.Builder	pagesProcessed(String value)	the number of pages processed
final TransformsRecord.Builder	pipeline(String value)	transform pipeline
final TransformsRecord.Builder	processedDocumentsExpAvg(String value)	exponential average number of documents processed
final TransformsRecord.Builder	processingTime(String value)	the total time spent processing documents
final TransformsRecord.Builder	reason(String value)	reason for the current state
final TransformsRecord.Builder	searchFailure(String value)	total number of search failures
final TransformsRecord.Builder	searchTime(String value)	total search time
final TransformsRecord.Builder	searchTotal(String value)	total number of search phases
protected TransformsRecord.Builder	self()
final TransformsRecord.Builder	sourceIndex(String value)	source index
final TransformsRecord.Builder	state(String value)	transform state
final TransformsRecord.Builder	transformType(String value)	batch or continuous transform
final TransformsRecord.Builder	triggerCount(String value)	the number of times the transform has been triggered
final TransformsRecord.Builder	version(String value)	the version of Elasticsearch 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

id

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

the id

API name: id

state

public final TransformsRecord.Builder state(@Nullable
 String value)

transform state

API name: state

checkpoint

public final TransformsRecord.Builder checkpoint(@Nullable
 String value)

checkpoint

API name: checkpoint

documentsProcessed

public final TransformsRecord.Builder documentsProcessed(@Nullable
 String value)

the number of documents read from source indices and processed

API name: documents_processed

checkpointProgress

public final TransformsRecord.Builder checkpointProgress(@Nullable
 String value)

progress of the checkpoint

API name: checkpoint_progress

lastSearchTime

public final TransformsRecord.Builder lastSearchTime(@Nullable
 String value)

last time transform searched for updates

API name: last_search_time

changesLastDetectionTime

public final TransformsRecord.Builder changesLastDetectionTime(@Nullable
 String value)

changes last detected time

API name: changes_last_detection_time

createTime

public final TransformsRecord.Builder createTime(@Nullable
 String value)

transform creation time

API name: create_time

version

public final TransformsRecord.Builder version(@Nullable
 String value)

the version of Elasticsearch when the transform was created

API name: version

sourceIndex

public final TransformsRecord.Builder sourceIndex(@Nullable
 String value)

source index

API name: source_index

destIndex

public final TransformsRecord.Builder destIndex(@Nullable
 String value)

destination index

API name: dest_index

pipeline

public final TransformsRecord.Builder pipeline(@Nullable
 String value)

transform pipeline

API name: pipeline

description

public final TransformsRecord.Builder description(@Nullable
 String value)

description

API name: description

transformType

public final TransformsRecord.Builder transformType(@Nullable
 String value)

batch or continuous transform

API name: transform_type

frequency

public final TransformsRecord.Builder frequency(@Nullable
 String value)

frequency of transform

API name: frequency

maxPageSearchSize

public final TransformsRecord.Builder maxPageSearchSize(@Nullable
 String value)

max page search size

API name: max_page_search_size

docsPerSecond

public final TransformsRecord.Builder docsPerSecond(@Nullable
 String value)

docs per second

API name: docs_per_second

reason

public final TransformsRecord.Builder reason(@Nullable
 String value)

reason for the current state

API name: reason

searchTotal

public final TransformsRecord.Builder searchTotal(@Nullable
 String value)

total number of search phases

API name: search_total

searchFailure

public final TransformsRecord.Builder searchFailure(@Nullable
 String value)

total number of search failures

API name: search_failure

searchTime

public final TransformsRecord.Builder searchTime(@Nullable
 String value)

total search time

API name: search_time

indexTotal

public final TransformsRecord.Builder indexTotal(@Nullable
 String value)

total number of index phases done by the transform

API name: index_total

indexFailure

public final TransformsRecord.Builder indexFailure(@Nullable
 String value)

total number of index failures

API name: index_failure

indexTime

public final TransformsRecord.Builder indexTime(@Nullable
 String value)

total time spent indexing documents

API name: index_time

documentsIndexed

public final TransformsRecord.Builder documentsIndexed(@Nullable
 String value)

the number of documents written to the destination index

API name: documents_indexed

deleteTime

public final TransformsRecord.Builder deleteTime(@Nullable
 String value)

total time spent deleting documents

API name: delete_time

documentsDeleted

public final TransformsRecord.Builder documentsDeleted(@Nullable
 String value)

the number of documents deleted from the destination index

API name: documents_deleted

triggerCount

public final TransformsRecord.Builder triggerCount(@Nullable
 String value)

the number of times the transform has been triggered

API name: trigger_count

pagesProcessed

public final TransformsRecord.Builder pagesProcessed(@Nullable
 String value)

the number of pages processed

API name: pages_processed

processingTime

public final TransformsRecord.Builder processingTime(@Nullable
 String value)

the total time spent processing documents

API name: processing_time

checkpointDurationTimeExpAvg

public final TransformsRecord.Builder checkpointDurationTimeExpAvg(@Nullable
 String value)

exponential average checkpoint processing time (milliseconds)

API name: checkpoint_duration_time_exp_avg

indexedDocumentsExpAvg

public final TransformsRecord.Builder indexedDocumentsExpAvg(@Nullable
 String value)

exponential average number of documents indexed

API name: indexed_documents_exp_avg

processedDocumentsExpAvg

public final TransformsRecord.Builder processedDocumentsExpAvg(@Nullable
 String value)

exponential average number of documents 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.