AgentEndpoint.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.generativeaiagent.model.AgentEndpoint.Builder

Enclosing class:: AgentEndpoint

public static class AgentEndpoint.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AgentEndpoint.Builder`	`agentId(String agentId)` The OCID of the agent that this endpoint is associated with.
`AgentEndpoint`	`build()`
`AgentEndpoint.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment.
`AgentEndpoint.Builder`	`contentModerationConfig(ContentModerationConfig contentModerationConfig)`
`AgentEndpoint.Builder`	`copy(AgentEndpoint model)`
`AgentEndpoint.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`AgentEndpoint.Builder`	`description(String description)` An optional description of the endpoint.
`AgentEndpoint.Builder`	`displayName(String displayName)` A user-friendly name.
`AgentEndpoint.Builder`	`freeformTags(Map<String,String> freeformTags)` Free-form tags for this resource.
`AgentEndpoint.Builder`	`id(String id)` The OCID of the endpoint.
`AgentEndpoint.Builder`	`lifecycleDetails(String lifecycleDetails)` A message that describes the current state of the endpoint in more detail.
`AgentEndpoint.Builder`	`lifecycleState(AgentEndpoint.LifecycleState lifecycleState)` The current state of the endpoint.
`AgentEndpoint.Builder`	`sessionConfig(SessionConfig sessionConfig)`
`AgentEndpoint.Builder`	`shouldEnableCitation(Boolean shouldEnableCitation)` Whether to show citations in the chat result.
`AgentEndpoint.Builder`	`shouldEnableSession(Boolean shouldEnableSession)` Whether or not to enable Session-based chat.
`AgentEndpoint.Builder`	`shouldEnableTrace(Boolean shouldEnableTrace)` Whether to show traces in the chat result.
`AgentEndpoint.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)` System tags for this resource.
`AgentEndpoint.Builder`	`timeCreated(Date timeCreated)` The date and time the AgentEndpoint was created, in the format defined by RFC 3339.
`AgentEndpoint.Builder`	`timeUpdated(Date timeUpdated)` The date and time the endpoint was updated, in the format defined by RFC 3339.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public AgentEndpoint.Builder id(String id)
```
    The OCID of the endpoint.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public AgentEndpoint.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 AgentEndpoint.Builder description(String description)
```
    An optional description of the endpoint.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public AgentEndpoint.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - agentId
```
public AgentEndpoint.Builder agentId(String agentId)
```
    The OCID of the agent that this endpoint is associated with.
    
    Parameters:
    
    agentId - the value to set
    
    Returns:
    
    this builder
  - contentModerationConfig
```
public AgentEndpoint.Builder contentModerationConfig(ContentModerationConfig contentModerationConfig)
```
  - shouldEnableTrace
```
public AgentEndpoint.Builder shouldEnableTrace(Boolean shouldEnableTrace)
```
    Whether to show traces in the chat result.
    
    Parameters:
    
    shouldEnableTrace - the value to set
    
    Returns:
    
    this builder
  - shouldEnableCitation
```
public AgentEndpoint.Builder shouldEnableCitation(Boolean shouldEnableCitation)
```
    Whether to show citations in the chat result.
    
    Parameters:
    
    shouldEnableCitation - the value to set
    
    Returns:
    
    this builder
  - shouldEnableSession
```
public AgentEndpoint.Builder shouldEnableSession(Boolean shouldEnableSession)
```
    Whether or not to enable Session-based chat.
    
    Parameters:
    
    shouldEnableSession - the value to set
    
    Returns:
    
    this builder
  - sessionConfig
```
public AgentEndpoint.Builder sessionConfig(SessionConfig sessionConfig)
```
  - timeCreated
```
public AgentEndpoint.Builder timeCreated(Date timeCreated)
```
    The date and time the AgentEndpoint 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 AgentEndpoint.Builder timeUpdated(Date timeUpdated)
```
    The date and time the endpoint 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 AgentEndpoint.Builder lifecycleState(AgentEndpoint.LifecycleState lifecycleState)
```
    The current state of the endpoint.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public AgentEndpoint.Builder lifecycleDetails(String lifecycleDetails)
```
    A message that describes the current state of the endpoint 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 AgentEndpoint.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 AgentEndpoint.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 AgentEndpoint.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 AgentEndpoint build()
```
  - copy
```
public AgentEndpoint.Builder copy(AgentEndpoint model)
```

Class AgentEndpoint.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

displayName

description

compartmentId

agentId

contentModerationConfig

shouldEnableTrace

shouldEnableCitation

shouldEnableSession

sessionConfig

timeCreated

timeUpdated

lifecycleState

lifecycleDetails

freeformTags

definedTags

systemTags

build

copy