Interface IPromptTestConnectionParams<ConnectionConfig>

Type Parameters:
ConnectionConfig - The type of the connection configuration model used by this prompt service.
public interface IPromptTestConnectionParams<ConnectionConfig>
Represents the parameters of a prompt connection test, see testConnection.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    ConnectionConfig
    connectionConfiguration()
    The connection configuration to test.
    Long
    formRecordId()
    Gets the ID of the form record scope where the connection test was started, if any.
    String
    formRecordSessionId()
    Gets the ID of the form record session where the connection test was started, if any.
    Long
    formVersionId()
    Gets the scope of the form record where the connection test was started, if any.
    Locale
    locale()
    The locale to use for localizing error message when the connection test fails.
    Long
    projectId()
    Gets the ID of the project scope where the connection test was started, if any.
    Long
    tenantId()
    Gets the ID of the tenant scope where the connection test was started, if any.
    Long
    workflowVersionId()
    Gets the ID of the workflow version where the connection test was started, if any.

  • Method Details

    • tenantId

      Long tenantId()
      Gets the ID of the tenant scope where the connection test was started, if any.
      Returns:
      The tenant ID; or null if no tenant scope is available.

    • connectionConfiguration

      ConnectionConfig connectionConfiguration()
      The connection configuration to test.
      Returns:
      The connection configuration to test.

    • formRecordId

      Long formRecordId()
      Gets the ID of the form record scope where the connection test was started, if any.
      Returns:
      The form record ID; or null if no form record scope is available.

    • formRecordSessionId

      String formRecordSessionId()
      Gets the ID of the form record session where the connection test was started, if any.
      Returns:
      The form record session ID; or null if no form record session scope is available.

    • formVersionId

      Long formVersionId()
      Gets the scope of the form record where the connection test was started, if any.
      Returns:
      The form record scope; or null if no form record scope is available.

    • locale

      Locale locale()
      The locale to use for localizing error message when the connection test fails.
      Returns:
      The locale to use for error messages.

    • projectId

      Long projectId()
      Gets the ID of the project scope where the connection test was started, if any.
      Returns:
      The project ID; or null if no project scope is available.

    • workflowVersionId

      Long workflowVersionId()
      Gets the ID of the workflow version where the connection test was started, if any.
      Returns:
      The workflow version ID; or null if no workflow version scope is available.