Package org.elasticsearch.client.transform.transforms

Class TransformConfig

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

  • Field Details

    • ID

      public static final org.elasticsearch.xcontent.ParseField ID

    • SOURCE

      public static final org.elasticsearch.xcontent.ParseField SOURCE

    • DEST

      public static final org.elasticsearch.xcontent.ParseField DEST

    • FREQUENCY

      public static final org.elasticsearch.xcontent.ParseField FREQUENCY

    • DESCRIPTION

      public static final org.elasticsearch.xcontent.ParseField DESCRIPTION

    • SYNC

      public static final org.elasticsearch.xcontent.ParseField SYNC

    • SETTINGS

      public static final org.elasticsearch.xcontent.ParseField SETTINGS

    • METADATA

      public static final org.elasticsearch.xcontent.ParseField METADATA

    • VERSION

      public static final org.elasticsearch.xcontent.ParseField VERSION

    • CREATE_TIME

      public static final org.elasticsearch.xcontent.ParseField CREATE_TIME

    • RETENTION_POLICY

      public static final org.elasticsearch.xcontent.ParseField RETENTION_POLICY

    • PIVOT_TRANSFORM

      public static final org.elasticsearch.xcontent.ParseField PIVOT_TRANSFORM

    • LATEST_TRANSFORM

      public static final org.elasticsearch.xcontent.ParseField LATEST_TRANSFORM

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<TransformConfig,Void> PARSER

  • Method Details

    • fromXContent

      public static TransformConfig fromXContent(org.elasticsearch.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 - Config to preview
      Returns:
      A TransformConfig to preview, NOTE it will have a null id, destination and index.

    • forPreview

      public static TransformConfig forPreview(SourceConfig source, LatestConfig latestConfig)
      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
      latestConfig - Config to preview
      Returns:
      A TransformConfig to preview, NOTE it will have a null id, destination and index.

    • getId

      public String getId()

    • getSource

      public SourceConfig getSource()

    • getDestination

      public DestConfig getDestination()

    • getFrequency

      public org.elasticsearch.core.TimeValue getFrequency()

    • getSyncConfig

      public SyncConfig getSyncConfig()

    • getPivotConfig

      public PivotConfig getPivotConfig()

    • getLatestConfig

      public LatestConfig getLatestConfig()

    • getVersion

      public org.elasticsearch.Version getVersion()

    • getCreateTime

      public Instant getCreateTime()

    • getDescription

      @Nullable public String getDescription()

    • getSettings

      @Nullable public SettingsConfig getSettings()

    • getMetadata

      @Nullable public Map<String,Object> getMetadata()

    • getRetentionPolicyConfig

      @Nullable public RetentionPolicyConfig getRetentionPolicyConfig()

    • toXContent

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

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static TransformConfig.Builder builder()