Enum Class CatTransformColumn
- All Implemented Interfaces:
JsonEnum
,JsonpSerializable
,Serializable
,Comparable<CatTransformColumn>
,Constable
@JsonpDeserializable
public enum CatTransformColumn
extends Enum<CatTransformColumn>
implements JsonEnum
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum
JsonEnum.Deserializer<T extends JsonEnum>
-
Enum Constant Summary
Enum ConstantDescriptionThe timestamp when changes were last detected in the source indices.The sequence number for the checkpoint.Exponential moving average of the duration of the checkpoint, in milliseconds.The progress of the next checkpoint that is currently in progress.The time the transform was created.The amount of time spent deleting, in milliseconds.The description of the transform.The destination index for the transform.Specifies a limit on the number of input documents per second.The number of documents that have been deleted from the destination index due to the retention policy for this transform.The number of documents that have been indexed into the destination index for the transform.The number of documents that have been processed from the source index of the transform.The interval between checks for changes in the source indices when the transform is running continuously.Identifier for the transform.Exponential moving average of the number of new documents that have been indexed.The number of indexing failures.The amount of time spent indexing, in milliseconds.The number of index operations.The timestamp of the last search in the source indices.Defines the initial page size to use for the composite aggregation for each checkpoint.The number of search or bulk index operations processed.The unique identifier for an ingest pipeline.Exponential moving average of the number of documents that have been processed.The amount of time spent processing results, in milliseconds.If a transform has afailed
state, this property provides details about the reason for the failure.The number of search failures.The amount of time spent searching, in milliseconds.The number of search operations on the source index for the transform.The source indices for the transform.The status of the transform, which can be one of the following values:aborting
: The transform is aborting.failed
: The transform failed.Indicates the type of transform:batch
orcontinuous
.The number of times the transform has been triggered by the scheduler.The version of Elasticsearch that existed on the node when the transform was created. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionString[]
aliases()
static CatTransformColumn
Returns the enum constant of this class with the specified name.static CatTransformColumn[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ChangesLastDetectionTime
The timestamp when changes were last detected in the source indices. -
Checkpoint
The sequence number for the checkpoint. -
CheckpointDurationTimeExpAvg
Exponential moving average of the duration of the checkpoint, in milliseconds. -
CheckpointProgress
The progress of the next checkpoint that is currently in progress. -
CreateTime
The time the transform was created. -
DeleteTime
The amount of time spent deleting, in milliseconds. -
Description
The description of the transform. -
DestIndex
The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform. -
DocumentsDeleted
The number of documents that have been deleted from the destination index due to the retention policy for this transform. -
DocumentsIndexed
The number of documents that have been indexed into the destination index for the transform. -
DocsPerSecond
Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value isnull
, which disables throttling. -
DocumentsProcessed
The number of documents that have been processed from the source index of the transform. -
Frequency
The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is1s
and the maximum is1h
. The default value is1m
. -
Id
Identifier for the transform. -
IndexFailure
The number of indexing failures. -
IndexTime
The amount of time spent indexing, in milliseconds. -
IndexTotal
The number of index operations. -
IndexedDocumentsExpAvg
Exponential moving average of the number of new documents that have been indexed. -
LastSearchTime
The timestamp of the last search in the source indices. This field is only shown if the transform is running. -
MaxPageSearchSize
Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is10
and the maximum is65,536
. The default value is500
. -
PagesProcessed
The number of search or bulk index operations processed. Documents are processed in batches instead of individually. -
Pipeline
The unique identifier for an ingest pipeline. -
ProcessedDocumentsExpAvg
Exponential moving average of the number of documents that have been processed. -
ProcessingTime
The amount of time spent processing results, in milliseconds. -
Reason
If a transform has afailed
state, this property provides details about the reason for the failure. -
SearchFailure
The number of search failures. -
SearchTime
The amount of time spent searching, in milliseconds. -
SearchTotal
The number of search operations on the source index for the transform. -
SourceIndex
The source indices for the transform. It can be a single index, an index pattern (for example,"my-index-*"
), an array of indices (for example,["my-index-000001", "my-index-000002"]
), or an array of index patterns (for example,["my-index-*", "my-other-index-*"]
. For remote indices use the syntax"remote_name:index_name"
. If any indices are in remote clusters then the master node and at least one transform node must have theremote_cluster_client
node role. -
State
The status of the transform, which can be one of the following values:aborting
: The transform is aborting.failed
: The transform failed. For more information about the failure, check the reason field.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.
-
TransformType
Indicates the type of transform:batch
orcontinuous
. -
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. -
Version
The version of Elasticsearch that existed on the node when the transform was created.
-
-
Field Details
-
_DESERIALIZER
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
jsonValue
-
aliases
-