Interface IPromptConnectionExportInfo

All Superinterfaces:
Serializable
public interface IPromptConnectionExportInfo extends Serializable
Model representing metadata about an exported prompt connection.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Gets the internal description of the prompt connection.
    default PromptObjectIdentifier
    getId()
    Gets the ID of the prompt connection, which is a combination of the scope and the UUID.
    String
    getName()
    Gets the name of the prompt connection.
    PromptScope
    getScope()
    The scope to which the prompt connection is assigned.
    String
    getType()
    The technical type of the prompt connection, i.e. the prompt service used for the connection.
    UUID
    getUuid()
    Gets the UUID of the prompt connection.

  • Method Details

    • getDescription

      String getDescription()
      Gets the internal description of the prompt connection.
      Returns:
      The internal description of the prompt connection.

    • getId

      default PromptObjectIdentifier getId()
      Gets the ID of the prompt connection, which is a combination of the scope and the UUID.
      Returns:
      The ID of the prompt connection.

    • getName

      String getName()
      Gets the name of the prompt connection.
      Returns:
      The name of the prompt connection.

    • getScope

      PromptScope getScope()
      The scope to which the prompt connection is assigned.
      Returns:
      The scope of the prompt connection.

    • getType

      String getType()
      The technical type of the prompt connection, i.e. the prompt service used for the connection. Each type must have a registered service, either built-in or provided by a plugin.
      Returns:
      The technical type of the prompt connection.

    • getUuid

      UUID getUuid()
      Gets the UUID of the prompt connection. The UUID is unique within its scope.
      Returns:
      The UUID of the prompt connection.