Class DefaultTestPromptConnectionParams.Builder

java.lang.Object
de.xima.fc.prompt.mgmt.defaults.DefaultTestPromptConnectionParams.Builder
Enclosing class:
DefaultTestPromptConnectionParams
public static final class DefaultTestPromptConnectionParams.Builder extends Object
A builder for DefaultTestPromptConnectionParams.
Since:
8.5.0

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public ITestPromptConnectionParams build()
      Creates a new prompt connection parameters instance with the current configuration.
      Returns:
      A new prompt connection parameters instance.

    • tenantId

      @CanIgnoreReturnValue public DefaultTestPromptConnectionParams.Builder 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.

    • formRecordId

      @CanIgnoreReturnValue public DefaultTestPromptConnectionParams.Builder 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 DefaultTestPromptConnectionParams.Builder 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 DefaultTestPromptConnectionParams.Builder 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

      @CanIgnoreReturnValue public DefaultTestPromptConnectionParams.Builder locale(Locale locale)
      Sets the locale for the connection test, used e.g. for localizing error messages.
      Parameters:
      locale - The locale to set. If null, will use a default locale.
      Returns:
      The builder for chaining method calls.

    • projectId

      @CanIgnoreReturnValue public DefaultTestPromptConnectionParams.Builder 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 DefaultTestPromptConnectionParams.Builder 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.