Package org.elasticsearch.client.transform.transforms

Class TransformConfig

java.lang.Object
org.elasticsearch.client.transform.transforms.TransformConfig
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class TransformConfig
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  TransformConfig.Builder  

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField CREATE_TIME  
    static org.elasticsearch.common.ParseField DESCRIPTION  
    static org.elasticsearch.common.ParseField DEST  
    static org.elasticsearch.common.ParseField FREQUENCY  
    static org.elasticsearch.common.ParseField ID  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<TransformConfig,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField PIVOT_TRANSFORM  
    static org.elasticsearch.common.ParseField SETTINGS  
    static org.elasticsearch.common.ParseField SOURCE  
    static org.elasticsearch.common.ParseField SYNC  
    static org.elasticsearch.common.ParseField VERSION  

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    static TransformConfig.Builder builder()  
    boolean equals​(java.lang.Object other)  
    static TransformConfig forPreview​(SourceConfig source, PivotConfig pivotConfig)
    Helper method for previewing a transform configuration The TransformConfig returned from this method should only be used for previewing the resulting data.
    static TransformConfig fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.time.Instant getCreateTime()  
    java.lang.String getDescription()  
    DestConfig getDestination()  
    org.elasticsearch.common.unit.TimeValue getFrequency()  
    java.lang.String getId()  
    PivotConfig getPivotConfig()  
    SettingsConfig getSettings()  
    SourceConfig getSource()  
    SyncConfig getSyncConfig()  
    org.elasticsearch.Version getVersion()  
    int hashCode()  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • ID

      public static final org.elasticsearch.common.ParseField ID

    • SOURCE

      public static final org.elasticsearch.common.ParseField SOURCE

    • DEST

      public static final org.elasticsearch.common.ParseField DEST

    • FREQUENCY

      public static final org.elasticsearch.common.ParseField FREQUENCY

    • DESCRIPTION

      public static final org.elasticsearch.common.ParseField DESCRIPTION

    • SYNC

      public static final org.elasticsearch.common.ParseField SYNC

    • SETTINGS

      public static final org.elasticsearch.common.ParseField SETTINGS

    • VERSION

      public static final org.elasticsearch.common.ParseField VERSION

    • CREATE_TIME

      public static final org.elasticsearch.common.ParseField CREATE_TIME

    • PIVOT_TRANSFORM

      public static final org.elasticsearch.common.ParseField PIVOT_TRANSFORM

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<TransformConfig,​java.lang.Void> PARSER

  • Method Details

    • fromXContent

      public static TransformConfig fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)

    • forPreview

      public static TransformConfig forPreview​(SourceConfig source, PivotConfig pivotConfig)
      Helper method for previewing a transform configuration The TransformConfig returned from this method should only be used for previewing the resulting data. A new, valid, TransformConfig with an appropriate destination and ID will have to be constructed to create the transform.
      Parameters:
      source - Source configuration for gathering the data
      pivotConfig - Pivot config to preview
      Returns:
      A TransformConfig to preview, NOTE it will have a null id, destination and index.

    • getId

      public java.lang.String getId()

    • getSource

      public SourceConfig getSource()

    • getDestination

      public DestConfig getDestination()

    • getFrequency

      public org.elasticsearch.common.unit.TimeValue getFrequency()

    • getSyncConfig

      public SyncConfig getSyncConfig()

    • getPivotConfig

      public PivotConfig getPivotConfig()

    • getVersion

      public org.elasticsearch.Version getVersion()

    • getCreateTime

      public java.time.Instant getCreateTime()

    • getDescription

      @Nullable public java.lang.String getDescription()

    • getSettings

      @Nullable public SettingsConfig getSettings()

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • builder

      public static TransformConfig.Builder builder()