Class APIBackendMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData
com.kingsrook.qqq.backend.module.api.model.metadata.APIBackendMetaData
All Implemented Interfaces:
MetaDataProducerOutput, QMetaDataObject, TopLevelMetaDataInterface, Serializable
public class APIBackendMetaData extends QBackendMetaData
Meta-data to provide details of an API backend (e.g., connection params)
See Also:

  • Constructor Details

    • APIBackendMetaData

      public APIBackendMetaData()
      Default Constructor.

  • Method Details

    • withName

      public APIBackendMetaData withName(String name)
      Fluent setter, override to help fluent flows
      Overrides:
      withName in class QBackendMetaData

    • getBaseUrl

      public String getBaseUrl()
      Getter for baseUrl

    • setBaseUrl

      public void setBaseUrl(String baseUrl)
      Setter for baseUrl

    • withBaseUrl

      public APIBackendMetaData withBaseUrl(String baseUrl)
      Fluent setter for baseUrl

    • getApiKey

      public String getApiKey()
      Getter for apiKey

    • setApiKey

      public void setApiKey(String apiKey)
      Setter for apiKey

    • withApiKey

      public APIBackendMetaData withApiKey(String apiKey)
      Fluent setter for apiKey

    • getClientId

      public String getClientId()
      Getter for clientId

    • setClientId

      public void setClientId(String clientId)
      Setter for clientId

    • withClientId

      public APIBackendMetaData withClientId(String clientId)
      Fluent setter for clientId

    • getClientSecret

      public String getClientSecret()
      Getter for clientSecret

    • setClientSecret

      public void setClientSecret(String clientSecret)
      Setter for clientSecret

    • withClientSecret

      public APIBackendMetaData withClientSecret(String clientSecret)
      Fluent setter for clientSecret

    • getUsername

      public String getUsername()
      Getter for username

    • setUsername

      public void setUsername(String username)
      Setter for username

    • withUsername

      public APIBackendMetaData withUsername(String username)
      Fluent setter for username

    • getPassword

      public String getPassword()
      Getter for password

    • setPassword

      public void setPassword(String password)
      Setter for password

    • withPassword

      public APIBackendMetaData withPassword(String password)
      Fluent setter for password

    • getAuthorizationType

      public AuthorizationType getAuthorizationType()
      Getter for authorizationType

    • setAuthorizationType

      public void setAuthorizationType(AuthorizationType authorizationType)
      Setter for authorizationType

    • withAuthorizationType

      public APIBackendMetaData withAuthorizationType(AuthorizationType authorizationType)
      Fluent setter for authorizationType

    • getContentType

      public String getContentType()
      Getter for contentType

    • setContentType

      public void setContentType(String contentType)
      Setter for contentType

    • withContentType

      public APIBackendMetaData withContentType(String contentType)
      Fluent setter for contentType

    • getActionUtil

      public QCodeReference getActionUtil()
      Getter for actionUtil

    • setActionUtil

      public void setActionUtil(QCodeReference actionUtil)
      Setter for actionUtil

    • withActionUtil

      public APIBackendMetaData withActionUtil(QCodeReference actionUtil)
      Fluent setter for actionUtil

    • getCustomValues

      public HashMap<String,Serializable> getCustomValues()
      Getter for customValues

    • getCustomValue

      public Serializable getCustomValue(String key)
      Getter for a single customValue

    • setCustomValues

      public void setCustomValues(HashMap<String,Serializable> customValues)
      Setter for customValues

    • withCustomValues

      public APIBackendMetaData withCustomValues(HashMap<String,Serializable> customValues)
      Fluent setter for customValues

    • withCustomValue

      public APIBackendMetaData withCustomValue(String key, Serializable value)
      Fluent setter for a single customValue

    • performValidation

      public void performValidation(QInstanceValidator qInstanceValidator)
      Overrides:
      performValidation in class QBackendMetaData

    • requiresPrimaryKeyOnTables

      public boolean requiresPrimaryKeyOnTables()
      Overrides:
      requiresPrimaryKeyOnTables in class QBackendMetaData

    • getApiKeyQueryParamName

      public String getApiKeyQueryParamName()
      Getter for apiKeyQueryParamName

    • setApiKeyQueryParamName

      public void setApiKeyQueryParamName(String apiKeyQueryParamName)
      Setter for apiKeyQueryParamName

    • withApiKeyQueryParamName

      public APIBackendMetaData withApiKeyQueryParamName(String apiKeyQueryParamName)
      Fluent setter for apiKeyQueryParamName