Class DefaultPromptTestConnectionParams.Builder<ConnectionConfig>

java.lang.Object
de.xima.fc.prompt.service.defaults.DefaultPromptTestConnectionParams.Builder<ConnectionConfig>
Type Parameters:
ConnectionConfig - The type of the connection configuration model used by this prompt service.
Enclosing class:
DefaultPromptTestConnectionParams
public static final class DefaultPromptTestConnectionParams.Builder<ConnectionConfig> extends Object
Builder for IPromptTestConnectionParams.
Since:
8.5.0

  • Method Details

    • build

      public IPromptTestConnectionParams<ConnectionConfig> build()
      Builds a new test connection parameters instance. Subsequent modifications to the builder will not affect the built instance.
      Returns:
      The built instance.

    • tenantId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> tenantId(Long tenantId)
      Sets the ID of the tenant scope where the connection test was started, if any.
      Parameters:
      tenantId - The tenant ID; or null if no tenant scope is available.
      Returns:
      This builder for chaining method calls.

    • connectionConfiguration

      public <C> DefaultPromptTestConnectionParams.Builder<C> connectionConfiguration(C connectionConfiguration)
      Sets the configuration of the connection.
      Type Parameters:
      C - The type of the connection configuration.
      Parameters:
      connectionConfiguration - The connection configuration.
      Returns:
      This builder for chaining method calls.

    • formRecordId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> formRecordId(Long formRecordId)
      Sets the ID of the form record scope where the connection test was started, if any.
      Parameters:
      formRecordId - The form record ID; or null if no form record context is available.
      Returns:
      This builder for chaining method calls.

    • formRecordSessionId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> formRecordSessionId(String formRecordSessionId)
      Sets the ID of the form record session scope where the connection test was started, if any.
      Parameters:
      formRecordSessionId - The form record session ID; or null if no form record session scope is available.
      Returns:
      This builder for chaining method calls.

    • formVersionId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> formVersionId(Long formVersionId)
      Sets the ID of the form version scope where the connection test was started, if any.
      Parameters:
      formVersionId - The form version ID; or null if no form version context is available.
      Returns:
      This builder for chaining method calls.

    • locale

      public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> locale(Locale locale)
      Sets the locale for the connection test.
      Parameters:
      locale - The locale.
      Returns:
      The builder.

    • projectId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> projectId(Long projectId)
      Sets the ID of the project scope where the connection test was started, if any.
      Parameters:
      projectId - The project ID; or null if no project context is available.
      Returns:
      This builder for chaining method calls.

    • workflowVersionId

      @CanIgnoreReturnValue public DefaultPromptTestConnectionParams.Builder<ConnectionConfig> workflowVersionId(Long workflowVersionId)
      Sets the ID of the workflow version scope where the connection test was started, if any.
      Parameters:
      workflowVersionId - The workflow version ID; or null if no workflow version context is available.
      Returns:
      This builder for chaining method calls.