Package co.elastic.clients.elasticsearch.cat

Enum CatTransformColumn

java.lang.Object
java.lang.Enum<CatTransformColumn>
co.elastic.clients.elasticsearch.cat.CatTransformColumn
All Implemented Interfaces:
JsonEnum, JsonpSerializable, java.io.Serializable, java.lang.Comparable<CatTransformColumn>, java.lang.constant.Constable
@JsonpDeserializable
public enum CatTransformColumn
extends java.lang.Enum<CatTransformColumn>
implements JsonEnum
See Also:
API specification

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

    JsonEnum.Deserializer<T extends JsonEnum>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    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.
    DocsPerSecond
    Specifies a limit on the number of input documents per second.
    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.
    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.
    Id
    Identifier for the transform.
    IndexedDocumentsExpAvg
    Exponential moving average of the number of new documents that have been indexed.
    IndexFailure
    The number of indexing failures.
    IndexTime
    The amount of time spent indexing, in milliseconds.
    IndexTotal
    The number of index operations.
    LastSearchTime
    The timestamp of the last search in the source indices.
    MaxPageSearchSize
    Defines the initial page size to use for the composite aggregation for each checkpoint.
    PagesProcessed
    The number of search or bulk index operations processed.
    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 a failed 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.
    State
    The status of the transform, which can be one of the following values: aborting: The transform is aborting. failed: The transform failed.
    TransformType
    Indicates the type of transform: batch or continuous.
    TriggerCount
    The number of times the transform has been triggered by the scheduler.
    Version
    The version of Elasticsearch that existed on the node when the transform was created.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonEnum.Deserializer<CatTransformColumn> _DESERIALIZER  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String[] aliases()  
    java.lang.String jsonValue()  
    static CatTransformColumn valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static CatTransformColumn[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    serialize

  • Enum Constant Details

    • ChangesLastDetectionTime

      public static final CatTransformColumn ChangesLastDetectionTime
      The timestamp when changes were last detected in the source indices.

    • Checkpoint

      public static final CatTransformColumn Checkpoint
      The sequence number for the checkpoint.

    • CheckpointDurationTimeExpAvg

      public static final CatTransformColumn CheckpointDurationTimeExpAvg
      Exponential moving average of the duration of the checkpoint, in milliseconds.

    • CheckpointProgress

      public static final CatTransformColumn CheckpointProgress
      The progress of the next checkpoint that is currently in progress.

    • CreateTime

      public static final CatTransformColumn CreateTime
      The time the transform was created.

    • DeleteTime

      public static final CatTransformColumn DeleteTime
      The amount of time spent deleting, in milliseconds.

    • Description

      public static final CatTransformColumn Description
      The description of the transform.

    • DestIndex

      public static final CatTransformColumn 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

      public static final CatTransformColumn DocumentsDeleted
      The number of documents that have been deleted from the destination index due to the retention policy for this transform.

    • DocumentsIndexed

      public static final CatTransformColumn DocumentsIndexed
      The number of documents that have been indexed into the destination index for the transform.

    • DocsPerSecond

      public static final CatTransformColumn 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 is null, which disables throttling.

    • DocumentsProcessed

      public static final CatTransformColumn DocumentsProcessed
      The number of documents that have been processed from the source index of the transform.

    • Frequency

      public static final CatTransformColumn 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 is 1s and the maximum is 1h. The default value is 1m.

    • Id

      public static final CatTransformColumn Id
      Identifier for the transform.

    • IndexFailure

      public static final CatTransformColumn IndexFailure
      The number of indexing failures.

    • IndexTime

      public static final CatTransformColumn IndexTime
      The amount of time spent indexing, in milliseconds.

    • IndexTotal

      public static final CatTransformColumn IndexTotal
      The number of index operations.

    • IndexedDocumentsExpAvg

      public static final CatTransformColumn IndexedDocumentsExpAvg
      Exponential moving average of the number of new documents that have been indexed.

    • LastSearchTime

      public static final CatTransformColumn LastSearchTime
      The timestamp of the last search in the source indices. This field is only shown if the transform is running.

    • MaxPageSearchSize

      public static final CatTransformColumn 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 is 10 and the maximum is 65,536. The default value is 500.

    • PagesProcessed

      public static final CatTransformColumn PagesProcessed
      The number of search or bulk index operations processed. Documents are processed in batches instead of individually.

    • Pipeline

      public static final CatTransformColumn Pipeline
      The unique identifier for an ingest pipeline.

    • ProcessedDocumentsExpAvg

      public static final CatTransformColumn ProcessedDocumentsExpAvg
      Exponential moving average of the number of documents that have been processed.

    • ProcessingTime

      public static final CatTransformColumn ProcessingTime
      The amount of time spent processing results, in milliseconds.

    • Reason

      public static final CatTransformColumn Reason
      If a transform has a failed state, this property provides details about the reason for the failure.

    • SearchFailure

      public static final CatTransformColumn SearchFailure
      The number of search failures.

    • SearchTime

      public static final CatTransformColumn SearchTime
      The amount of time spent searching, in milliseconds.

    • SearchTotal

      public static final CatTransformColumn SearchTotal
      The number of search operations on the source index for the transform.

    • SourceIndex

      public static final CatTransformColumn 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 the remote_cluster_client node role.

    • State

      public static final CatTransformColumn 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

      public static final CatTransformColumn TransformType
      Indicates the type of transform: batch or continuous.

    • TriggerCount

      public static final CatTransformColumn 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.

    • Version

      public static final CatTransformColumn Version
      The version of Elasticsearch that existed on the node when the transform was created.

  • Field Details

  • Method Details

    • values

      public static CatTransformColumn[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CatTransformColumn valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • jsonValue

      public java.lang.String jsonValue()
      Specified by:
      jsonValue in interface JsonEnum

    • aliases

      public java.lang.String[] aliases()
      Specified by:
      aliases in interface JsonEnum