Package com.oracle.bmc.generativeaiagent.model

Class Agent.Builder

  • Enclosing class:
    Agent
    public static class Agent.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Agent.Builder id​(String id)
        The OCID of the agent.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Agent.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public Agent.Builder description​(String description)
        Description about the agent.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public Agent.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • knowledgeBaseIds

        public Agent.Builder knowledgeBaseIds​(List<String> knowledgeBaseIds)
        List of OCID of the knowledgeBases associated with agent.

        This field is deprecated and will be removed after March 26 2026.

        Parameters:
        knowledgeBaseIds - the value to set
        Returns:
        this builder

      • welcomeMessage

        public Agent.Builder welcomeMessage​(String welcomeMessage)
        Details about purpose and responsibility of the agent
        Parameters:
        welcomeMessage - the value to set
        Returns:
        this builder

      • timeCreated

        public Agent.Builder timeCreated​(Date timeCreated)
        The date and time the agent was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Agent.Builder timeUpdated​(Date timeUpdated)
        The date and time the agent was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public Agent.Builder lifecycleState​(Agent.LifecycleState lifecycleState)
        The current state of the agent.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Agent.Builder lifecycleDetails​(String lifecycleDetails)
        A message that describes the current state of the agent in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public Agent.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public Agent.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public Agent.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • build

        public Agent build()