Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.transform.transforms

Class TransformConfig

java.lang.Object

org.elasticsearch.xpack.core.transform.transforms.TransformConfig

All Implemented Interfaces:

Diffable<TransformConfig>, SimpleDiffable<TransformConfig>, Writeable, ToXContent, ToXContentObject

public final class TransformConfig
extends Object
implements SimpleDiffable<TransformConfig>, Writeable, ToXContentObject

This class holds the configuration details of a data frame transform

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransformConfig.Builder
static enum	TransformConfig.Function	Specifies all the possible transform functions.

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TransformConfigVersion	CONFIG_VERSION_LAST_DEFAULTS_CHANGED	Version of the last time the config defaults have been changed.
static final ParseField	CREDENTIAL_ID
static final ParseField	HEADERS
static final String	NAME
static final TransportVersion	TRANSFORM_CLOUD_TOKEN
static final FeatureFlag	TRANSFORM_CROSS_PROJECT

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TransformConfig(String id, SourceConfig source, DestConfig dest, TimeValue frequency, SyncConfig syncConfig, Map<String,String> headers, PivotConfig pivotConfig, LatestConfig latestConfig, String description, SettingsConfig settings, Map<String,Object> metadata, RetentionPolicyConfig retentionPolicyConfig, Instant createTime, String version)
TransformConfig(String id, SourceConfig source, DestConfig dest, TimeValue frequency, SyncConfig syncConfig, Map<String,String> headers, PivotConfig pivotConfig, LatestConfig latestConfig, String description, SettingsConfig settings, Map<String,Object> metadata, RetentionPolicyConfig retentionPolicyConfig, Instant createTime, String version, String credentialId)
TransformConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static TransformConfig.Builder	builder()
List<DeprecationIssue>	checkForDeprecations(NamedXContentRegistry namedXContentRegistry)	Parses the transform configuration for deprecations
static String	documentId(String transformId)
boolean	equals(Object other)
static TransformConfig	fromXContent(XContentParser parser, String optionalTransformId, boolean lenient, TransformParsingContext transformParsingContext)
List<SourceDestValidator.SourceDestValidation>	getAdditionalSourceDestValidations()	Determines the minimum version of a cluster in multi-cluster setup that is needed to successfully run this transform config.
Instant	getCreateTime()
String	getCredentialId()
String	getDescription()
DestConfig	getDestination()
TimeValue	getFrequency()
Map<String,String>	getHeaders()
String	getId()
LatestConfig	getLatestConfig()
Map<String,Object>	getMetadata()
PivotConfig	getPivotConfig()
RetentionPolicyConfig	getRetentionPolicyConfig()
SettingsConfig	getSettings()
SourceConfig	getSource()
SyncConfig	getSyncConfig()
TransformConfigVersion	getVersion()
int	hashCode()
static TransformConfig.Builder	migrateMaxPageSearchSize(TransformConfig.Builder builder)
static TransformConfig	rewriteForUpdate(TransformConfig transformConfig)	Rewrites the transform config according to the latest format.
TransformConfig	setCreateTime(Instant createTime)
TransformConfig	setHeaders(Map<String,String> headers)
TransformConfig	setVersion(TransformConfigVersion version)
boolean	shouldAutoMigrateMaxPageSearchSize()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate(ActionRequestValidationException validationException)
ActionRequestValidationException	validateNoCrossProjectWhenCrossProjectIsDisabled(CrossProjectModeDecider crossProjectModeDecider, ActionRequestValidationException validationException)
TransformConfig	withCredentialId(String credentialId)	Returns a copy of this config with the given credentialId set.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

CONFIG_VERSION_LAST_DEFAULTS_CHANGED

public static final TransformConfigVersion CONFIG_VERSION_LAST_DEFAULTS_CHANGED

Version of the last time the config defaults have been changed. Whenever defaults change, we must re-write the config on update in a way it does not change behavior.

NAME

public static final String NAME

See Also:

• Constant Field Values

HEADERS

public static final ParseField HEADERS

CREDENTIAL_ID

public static final ParseField CREDENTIAL_ID

TRANSFORM_CROSS_PROJECT

public static final FeatureFlag TRANSFORM_CROSS_PROJECT

TRANSFORM_CLOUD_TOKEN

public static final TransportVersion TRANSFORM_CLOUD_TOKEN

Constructor Details

TransformConfig

public TransformConfig(String id,
 SourceConfig source,
 DestConfig dest,
 TimeValue frequency,
 SyncConfig syncConfig,
 Map<String,String> headers,
 PivotConfig pivotConfig,
 LatestConfig latestConfig,
 String description,
 SettingsConfig settings,
 Map<String,Object> metadata,
 RetentionPolicyConfig retentionPolicyConfig,
 Instant createTime,
 String version)

TransformConfig

public TransformConfig(String id,
 SourceConfig source,
 DestConfig dest,
 TimeValue frequency,
 SyncConfig syncConfig,
 Map<String,String> headers,
 PivotConfig pivotConfig,
 LatestConfig latestConfig,
 String description,
 SettingsConfig settings,
 Map<String,Object> metadata,
 RetentionPolicyConfig retentionPolicyConfig,
 Instant createTime,
 String version,
 @Nullable
 String credentialId)

TransformConfig

public TransformConfig(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

documentId

public static String documentId(String transformId)

getId

public String getId()

getSource

public SourceConfig getSource()

getDestination

public DestConfig getDestination()

getFrequency

public TimeValue getFrequency()

getSyncConfig

public SyncConfig getSyncConfig()

getHeaders

public Map<String,String> getHeaders()

setHeaders

public TransformConfig setHeaders(Map<String,String> headers)

getVersion

public TransformConfigVersion getVersion()

setVersion

public TransformConfig setVersion(TransformConfigVersion version)

getCreateTime

public Instant getCreateTime()

setCreateTime

public TransformConfig setCreateTime(Instant createTime)

getPivotConfig

public PivotConfig getPivotConfig()

getLatestConfig

public LatestConfig getLatestConfig()

getDescription

@Nullable
public String getDescription()

getSettings

public SettingsConfig getSettings()

getMetadata

public Map<String,Object> getMetadata()

getRetentionPolicyConfig

@Nullable
public RetentionPolicyConfig getRetentionPolicyConfig()

getCredentialId

@Nullable
public String getCredentialId()

withCredentialId

public TransformConfig withCredentialId(@Nullable
 String credentialId)

Returns a copy of this config with the given credentialId set. Used by PUT/UPDATE flows after minting a new UIAM cloud credential, before writing the config to storage.

getAdditionalSourceDestValidations

public List<SourceDestValidator.SourceDestValidation> getAdditionalSourceDestValidations()

Determines the minimum version of a cluster in multi-cluster setup that is needed to successfully run this transform config.

Returns:

version

validate

public ActionRequestValidationException validate(ActionRequestValidationException validationException)

validateNoCrossProjectWhenCrossProjectIsDisabled

public ActionRequestValidationException validateNoCrossProjectWhenCrossProjectIsDisabled(CrossProjectModeDecider crossProjectModeDecider,
 ActionRequestValidationException validationException)

checkForDeprecations

public List<DeprecationIssue> checkForDeprecations(NamedXContentRegistry namedXContentRegistry)
                                            throws IOException

Parses the transform configuration for deprecations

Parameters:

namedXContentRegistry - XContent registry required for aggregations and query DSL

Returns:

The deprecations of this transform

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface 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

fromXContent

public static TransformConfig fromXContent(XContentParser parser,
 @Nullable
 String optionalTransformId,
 boolean lenient,
 TransformParsingContext transformParsingContext)

rewriteForUpdate

public static TransformConfig rewriteForUpdate(TransformConfig transformConfig)

Rewrites the transform config according to the latest format. Operations cover: - move deprecated settings to its new place - change configuration options so it stays compatible (given a newer version)

Parameters:

transformConfig - original config

Returns:

a rewritten transform config if a rewrite was necessary, otherwise the given transformConfig

shouldAutoMigrateMaxPageSearchSize

public boolean shouldAutoMigrateMaxPageSearchSize()

migrateMaxPageSearchSize

public static TransformConfig.Builder migrateMaxPageSearchSize(TransformConfig.Builder builder)

builder

public static TransformConfig.Builder builder()