Class QBackendMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData
All Implemented Interfaces:
MetaDataProducerOutput, QMetaDataObject, TopLevelMetaDataInterface, Serializable
Direct Known Subclasses:
AbstractFilesystemBackendMetaData, APIBackendMetaData, MongoDBBackendMetaData, RDBMSBackendMetaData
public class QBackendMetaData extends Object implements TopLevelMetaDataInterface
Meta-data to provide details of a backend (e.g., RDBMS instance, S3 buckets, NoSQL table, etc) within a qqq instance
See Also:

  • Constructor Details

    • QBackendMetaData

      public QBackendMetaData()
      Default Constructor.

  • Method Details

    • requiresPrimaryKeyOnTables

      public boolean requiresPrimaryKeyOnTables()

    • getName

      public String getName()
      Specified by:
      getName in interface TopLevelMetaDataInterface

    • setName

      public void setName(String name)

    • withName

      public QBackendMetaData withName(String name)
      Fluent setter, returning generically, to help sub-class fluent flows

    • getBackendType

      public String getBackendType()
      Getter for backendType

    • setBackendType

      public void setBackendType(String backendType)
      Setter for backendType

    • setBackendType

      public void setBackendType(Class<? extends QBackendModuleInterface> backendModuleClass)
      Setter for backendType

    • withBackendType

      public QBackendMetaData withBackendType(Class<? extends QBackendModuleInterface> backendModuleClass)

    • enrich

      public void enrich()
      Called by the QInstanceEnricher - to do backend-type-specific enrichments. Original use case is: reading secrets into fields (e.g., passwords).

    • getEnabledCapabilities

      public Set<Capability> getEnabledCapabilities()
      Getter for enabledCapabilities

    • setEnabledCapabilities

      public void setEnabledCapabilities(Set<Capability> enabledCapabilities)
      Setter for enabledCapabilities

    • withEnabledCapabilities

      public QBackendMetaData withEnabledCapabilities(Set<Capability> enabledCapabilities)
      Fluent setter for enabledCapabilities

    • withCapabilities

      public QBackendMetaData withCapabilities(Set<Capability> enabledCapabilities)
      Alternative fluent setter for enabledCapabilities

    • withCapability

      public QBackendMetaData withCapability(Capability capability)
      Alternative fluent setter for a single enabledCapabilities

    • withCapabilities

      public QBackendMetaData withCapabilities(Capability... enabledCapabilities)
      Fluent setter for enabledCapabilities

    • getDisabledCapabilities

      public Set<Capability> getDisabledCapabilities()
      Getter for disabledCapabilities

    • setDisabledCapabilities

      public void setDisabledCapabilities(Set<Capability> disabledCapabilities)
      Setter for disabledCapabilities

    • withDisabledCapabilities

      public QBackendMetaData withDisabledCapabilities(Set<Capability> disabledCapabilities)
      Fluent setter for disabledCapabilities

    • withoutCapabilities

      public QBackendMetaData withoutCapabilities(Capability... disabledCapabilities)
      Fluent setter for disabledCapabilities

    • withoutCapabilities

      public QBackendMetaData withoutCapabilities(Set<Capability> disabledCapabilities)
      Alternative fluent setter for disabledCapabilities

    • withoutCapability

      public QBackendMetaData withoutCapability(Capability capability)
      Alternative fluent setter for a single disabledCapabilities

    • performValidation

      public void performValidation(QInstanceValidator qInstanceValidator)

    • getUsesVariants

      public Boolean getUsesVariants()
      Getter for usesVariants

    • setUsesVariants

      public void setUsesVariants(Boolean usesVariants)
      Setter for usesVariants

    • withUsesVariants

      public QBackendMetaData withUsesVariants(Boolean usesVariants)
      Fluent setter for usesVariants

    • setVariantOptionsTableIdField

      @Deprecated(since="backendVariantsConfig will infer this from the variant options table's primary key") public void setVariantOptionsTableIdField(String variantOptionsTableIdField)
      Deprecated.
      Setter for variantOptionsTableIdField

    • withVariantOptionsTableIdField

      @Deprecated(since="backendVariantsConfig will infer this from the variant options table's primary key") public QBackendMetaData withVariantOptionsTableIdField(String variantOptionsTableIdField)
      Deprecated.
      Fluent setter for variantOptionsTableIdField

    • setVariantOptionsTableNameField

      @Deprecated(since="backendVariantsConfig will infer this from the variant options table's recordLabel") public void setVariantOptionsTableNameField(String variantOptionsTableNameField)
      Deprecated.
      Setter for variantOptionsTableNameField

    • withVariantOptionsTableNameField

      @Deprecated(since="backendVariantsConfig will infer this from the variant options table's recordLabel") public QBackendMetaData withVariantOptionsTableNameField(String variantOptionsTableNameField)
      Deprecated.
      Fluent setter for variantOptionsTableNameField

    • setVariantOptionsTableTypeField

      @Deprecated(since="Replaced by fieldName in filter in backendVariantsConfig - but leaving as field to pair with ...TypeValue for building filter") public void setVariantOptionsTableTypeField(String variantOptionsTableTypeField)
      Deprecated.
      Setter for variantOptionsTableTypeField

    • withVariantOptionsTableTypeField

      @Deprecated(since="Replaced by fieldName in filter in backendVariantsConfig - but leaving as field to pair with ...TypeValue for building filter") public QBackendMetaData withVariantOptionsTableTypeField(String variantOptionsTableTypeField)
      Deprecated.
      Fluent setter for variantOptionsTableTypeField

    • setVariantOptionsTableTypeValue

      @Deprecated(since="Replaced by variantTypeKey and value in filter in backendVariantsConfig - but leaving as field to pair with ...TypeField for building filter") public void setVariantOptionsTableTypeValue(String variantOptionsTableTypeValue)
      Deprecated.
      Setter for variantOptionsTableTypeValue

    • withVariantOptionsTableTypeValue

      @Deprecated(since="Replaced by variantTypeKey and value in filter in backendVariantsConfig - but leaving as field to pair with ...TypeField for building filter") public QBackendMetaData withVariantOptionsTableTypeValue(String variantOptionsTableTypeValue)
      Deprecated.
      Fluent setter for variantOptionsTableTypeValue

    • setVariantOptionsTableUsernameField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public void setVariantOptionsTableUsernameField(String variantOptionsTableUsernameField)
      Deprecated.
      Setter for variantOptionsTableUsernameField

    • withVariantOptionsTableUsernameField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public QBackendMetaData withVariantOptionsTableUsernameField(String variantOptionsTableUsernameField)
      Deprecated.
      Fluent setter for variantOptionsTableUsernameField

    • setVariantOptionsTablePasswordField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public void setVariantOptionsTablePasswordField(String variantOptionsTablePasswordField)
      Deprecated.
      Setter for variantOptionsTablePasswordField

    • withVariantOptionsTablePasswordField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public QBackendMetaData withVariantOptionsTablePasswordField(String variantOptionsTablePasswordField)
      Deprecated.
      Fluent setter for variantOptionsTablePasswordField

    • setVariantOptionsTableApiKeyField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public void setVariantOptionsTableApiKeyField(String variantOptionsTableApiKeyField)
      Deprecated.
      Setter for variantOptionsTableApiKeyField

    • withVariantOptionsTableApiKeyField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public QBackendMetaData withVariantOptionsTableApiKeyField(String variantOptionsTableApiKeyField)
      Deprecated.
      Fluent setter for variantOptionsTableApiKeyField

    • setVariantOptionsTableName

      @Deprecated(since="Replaced by backendVariantsConfig.tableName") public void setVariantOptionsTableName(String variantOptionsTableName)
      Deprecated.
      Setter for variantOptionsTableName

    • withVariantOptionsTableName

      @Deprecated(since="Replaced by backendVariantsConfig.tableName") public QBackendMetaData withVariantOptionsTableName(String variantOptionsTableName)
      Deprecated.
      Fluent setter for variantOptionsTableName

    • addSelfToInstance

      public void addSelfToInstance(QInstance qInstance)
      Description copied from interface: MetaDataProducerOutput
      call the appropriate methods on a QInstance to add ourselves to it.
      Specified by:
      addSelfToInstance in interface MetaDataProducerOutput
      Specified by:
      addSelfToInstance in interface TopLevelMetaDataInterface

    • setVariantOptionsTableClientIdField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public void setVariantOptionsTableClientIdField(String variantOptionsTableClientIdField)
      Deprecated.
      Setter for variantOptionsTableClientIdField

    • withVariantOptionsTableClientIdField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public QBackendMetaData withVariantOptionsTableClientIdField(String variantOptionsTableClientIdField)
      Deprecated.
      Fluent setter for variantOptionsTableClientIdField

    • setVariantOptionsTableClientSecretField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public void setVariantOptionsTableClientSecretField(String variantOptionsTableClientSecretField)
      Deprecated.
      Setter for variantOptionsTableClientSecretField

    • withVariantOptionsTableClientSecretField

      @Deprecated(since="Replaced by backendVariantsConfig.backendSettingSourceFieldNameMap") public QBackendMetaData withVariantOptionsTableClientSecretField(String variantOptionsTableClientSecretField)
      Deprecated.
      Fluent setter for variantOptionsTableClientSecretField

    • getBackendVariantsConfig

      public BackendVariantsConfig getBackendVariantsConfig()
      Getter for backendVariantsConfig

    • setBackendVariantsConfig

      public void setBackendVariantsConfig(BackendVariantsConfig backendVariantsConfig)
      Setter for backendVariantsConfig

    • withBackendVariantsConfig

      public QBackendMetaData withBackendVariantsConfig(BackendVariantsConfig backendVariantsConfig)
      Fluent setter for backendVariantsConfig