Class ColumnStatsTableConfig

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData

com.kingsrook.qqq.backend.core.processes.implementations.columnstats.ColumnStatsTableConfig

All Implemented Interfaces:

Serializable, Cloneable

public class ColumnStatsTableConfig
extends QSupplementalTableMetaData
implements Serializable

Object with properties to allow configuring behavior of the ColumnStats process.

Can be deployed various ways:

• As supplementalTableMetaData (e.g., set on individual tables in QInstance)

   ColumnStatsTableConfig.ofOrWithNew(myTableMetaData).withFailIfCountOverLimit(47)
         

• As a value in the process, named "ColumnStatsTableConfig":
  • Where one can set a default value for the process (e.g., across all tables) as in:

     processMetaData.getInputField("ColumnStatsTableConfig").ifPresent(f ->
        f.setDefaultValue(new ColumnStatsTableConfig().withFailIfCountOverLimit(42)));
           

  • Or an application can insert a custom step into this process to dynamically build the config when the process runs

     processMetaData.withStep(0, new QBackendStepMetaData()
        .withName("setConfig")
        .withCode(new QCodeReference(ColumnStatusConfigBuilderStep.class)));
           

    and then in that step:

     runBackendStepOutput.addValue("ColumnStatsTableConfig", new ColumnStatsTableConfig());
           

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
ColumnStatsTableConfig()

Method Summary

Modifier and Type	Method	Description
Integer	getFailIfCountOverLimit()	Getter for failIfCountOverLimit
Integer	getQueryTimeoutSeconds()	Getter for queryTimeoutSeconds
String	getType()	Getter for type
static ColumnStatsTableConfig	of(QTableMetaData tableMetaData)
static ColumnStatsTableConfig	ofOrWithNew(QTableMetaData tableMetaData)
void	setFailIfCountOverLimit(Integer failIfCountOverLimit)	Setter for failIfCountOverLimit
void	setQueryTimeoutSeconds(Integer queryTimeoutSeconds)	Setter for queryTimeoutSeconds
ColumnStatsTableConfig	withFailIfCountOverLimit(Integer failIfCountOverLimit)	Fluent setter for failIfCountOverLimit
ColumnStatsTableConfig	withQueryTimeoutSeconds(Integer queryTimeoutSeconds)	Fluent setter for queryTimeoutSeconds

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData

clone, enrich, finishClone, includeInFullFrontendMetaData, includeInPartialFrontendMetaData, of, ofOrWithNew, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

Constructor Details

ColumnStatsTableConfig

public ColumnStatsTableConfig()

Method Details

getType

public String getType()

Description copied from class: QSupplementalTableMetaData

Getter for type

Specified by:

getType in class QSupplementalTableMetaData

of

public static ColumnStatsTableConfig of(QTableMetaData tableMetaData)

ofOrWithNew

public static ColumnStatsTableConfig ofOrWithNew(QTableMetaData tableMetaData)

getFailIfCountOverLimit

public Integer getFailIfCountOverLimit()

Getter for failIfCountOverLimit

See Also:

• withFailIfCountOverLimit(Integer)

setFailIfCountOverLimit

public void setFailIfCountOverLimit(Integer failIfCountOverLimit)

Setter for failIfCountOverLimit

See Also:

• withFailIfCountOverLimit(Integer)

withFailIfCountOverLimit

public ColumnStatsTableConfig withFailIfCountOverLimit(Integer failIfCountOverLimit)

Fluent setter for failIfCountOverLimit

Parameters:

failIfCountOverLimit - TODO document this property

Returns:

this

getQueryTimeoutSeconds

public Integer getQueryTimeoutSeconds()

Getter for queryTimeoutSeconds

See Also:

• withQueryTimeoutSeconds(Integer)

setQueryTimeoutSeconds

public void setQueryTimeoutSeconds(Integer queryTimeoutSeconds)

Setter for queryTimeoutSeconds

See Also:

• withQueryTimeoutSeconds(Integer)

withQueryTimeoutSeconds

public ColumnStatsTableConfig withQueryTimeoutSeconds(Integer queryTimeoutSeconds)

Fluent setter for queryTimeoutSeconds

Parameters:

queryTimeoutSeconds - TODO document this property

Returns:

this