Interface AiConfigRpc


public interface AiConfigRpc
Read-only access to the gateway's configuration system, shaped for AI agents running in the designer. Every call is a query: nothing here creates, modifies, or deletes configuration.

Refusals are reported as the runtime exceptions documented on each method.

  • Method Details

    • listTypes

      List<ConfigTypeInfo> listTypes()
      Lists the config resource types the gateway is willing to expose, sorted by module and then type identifier.
      Returns:
      the discoverable config types.
    • describeType

      ConfigTypeDescription describeType(String moduleId, String typeId)
      Describes one config resource type, including the schema of its configuration and the subtypes it offers if it is an extension point.
      Parameters:
      moduleId - the module that owns the resource type.
      typeId - the resource type identifier within the module.
      Returns:
      the description of the type.
      Throws:
      NoSuchElementException - if the type is not registered or is not exposed to agents.
    • listResources

      List<ConfigResourceBrief> listResources(String moduleId, String typeId)
      Lists the resources of one config type by name, capped at a gateway-defined limit.
      Parameters:
      moduleId - the module that owns the resource type.
      typeId - the resource type identifier within the module.
      Returns:
      the resources of the type.
      Throws:
      NoSuchElementException - if the type is not registered or is not exposed to agents.
      UnsupportedOperationException - if the type does not allow its resources to be listed.
    • readResource

      ConfigResourceRead readResource(String moduleId, String typeId, @Nullable String name)
      Reads one resource's full configuration.
      Parameters:
      moduleId - the module that owns the resource type.
      typeId - the resource type identifier within the module.
      name - the resource name, or null for a singleton type.
      Returns:
      the resource's configuration.
      Throws:
      NoSuchElementException - if the type is not registered, is not exposed to agents, or has no resource by that name.
      IllegalArgumentException - if a name was supplied for a singleton type, or omitted for a named one.
      UnsupportedOperationException - if the type does not allow its resources to be read.
      IllegalStateException - if the resource's stored configuration cannot be decoded or rendered as JSON.