AgentEndpoint (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiagent.model.AgentEndpoint

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class AgentEndpoint
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
The endpoint to access a deployed agent.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
Note: Objects should always be created or deserialized using the AgentEndpoint.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AgentEndpoint.Builder, which maintain a set of all explicitly set fields called AgentEndpoint.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AgentEndpoint.Builder

static class AgentEndpoint.LifecycleState
The current state of the endpoint.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AgentEndpoint.Builder`
`static class`	`AgentEndpoint.LifecycleState` The current state of the endpoint.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
AgentEndpoint(String id, String displayName, String description, String compartmentId, String agentId, ContentModerationConfig contentModerationConfig, Boolean shouldEnableTrace, Boolean shouldEnableCitation, Boolean shouldEnableSession, SessionConfig sessionConfig, Date timeCreated, Date timeUpdated, AgentEndpoint.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags) Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AgentEndpoint.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getAgentId()` The OCID of the agent that this endpoint is associated with.
`String`	`getCompartmentId()` The OCID of the compartment.
`ContentModerationConfig`	`getContentModerationConfig()`
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDescription()` An optional description of the endpoint.
`String`	`getDisplayName()` A user-friendly name.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the endpoint.
`String`	`getLifecycleDetails()` A message that describes the current state of the endpoint in more detail.
`AgentEndpoint.LifecycleState`	`getLifecycleState()` The current state of the endpoint.
`SessionConfig`	`getSessionConfig()`
`Boolean`	`getShouldEnableCitation()` Whether to show citations in the chat result.
`Boolean`	`getShouldEnableSession()` Whether or not to enable Session-based chat.
`Boolean`	`getShouldEnableTrace()` Whether to show traces in the chat result.
`Map<String,Map<String,Object>>`	`getSystemTags()` System tags for this resource.
`Date`	`getTimeCreated()` The date and time the AgentEndpoint was created, in the format defined by RFC 3339.
`Date`	`getTimeUpdated()` The date and time the endpoint was updated, in the format defined by RFC 3339.
`int`	`hashCode()`
`AgentEndpoint.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

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

Constructor Detail

AgentEndpoint

@Deprecated
 @ConstructorProperties(value={"id","displayName","description","compartmentId","agentId","contentModerationConfig","shouldEnableTrace","shouldEnableCitation","shouldEnableSession","sessionConfig","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public AgentEndpoint(String id,
                                                                                                                                                                                                                                                                                                                                                  String displayName,
                                                                                                                                                                                                                                                                                                                                                  String description,
                                                                                                                                                                                                                                                                                                                                                  String compartmentId,
                                                                                                                                                                                                                                                                                                                                                  String agentId,
                                                                                                                                                                                                                                                                                                                                                  ContentModerationConfig contentModerationConfig,
                                                                                                                                                                                                                                                                                                                                                  Boolean shouldEnableTrace,
                                                                                                                                                                                                                                                                                                                                                  Boolean shouldEnableCitation,
                                                                                                                                                                                                                                                                                                                                                  Boolean shouldEnableSession,
                                                                                                                                                                                                                                                                                                                                                  SessionConfig sessionConfig,
                                                                                                                                                                                                                                                                                                                                                  Date timeCreated,
                                                                                                                                                                                                                                                                                                                                                  Date timeUpdated,
                                                                                                                                                                                                                                                                                                                                                  AgentEndpoint.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                                                  String lifecycleDetails,
                                                                                                                                                                                                                                                                                                                                                  Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                                                  Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                                                  Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static AgentEndpoint.Builder builder()
```
  Create a new builder.
- toBuilder
```
public AgentEndpoint.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the endpoint.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  An optional description of the endpoint.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment.
  
  Returns:
  
  the value
- getAgentId
```
public String getAgentId()
```
  The OCID of the agent that this endpoint is associated with.
  
  Returns:
  
  the value
- getContentModerationConfig
```
public ContentModerationConfig getContentModerationConfig()
```
- getShouldEnableTrace
```
public Boolean getShouldEnableTrace()
```
  Whether to show traces in the chat result.
  
  Returns:
  
  the value
- getShouldEnableCitation
```
public Boolean getShouldEnableCitation()
```
  Whether to show citations in the chat result.
  
  Returns:
  
  the value
- getShouldEnableSession
```
public Boolean getShouldEnableSession()
```
  Whether or not to enable Session-based chat.
  
  Returns:
  
  the value
- getSessionConfig
```
public SessionConfig getSessionConfig()
```
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the AgentEndpoint was created, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The date and time the endpoint was updated, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getLifecycleState
```
public AgentEndpoint.LifecycleState getLifecycleState()
```
  The current state of the endpoint.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  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.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  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"}
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
  
  Example: {"Operations": {"CostCenter": "42"}}
  
  Returns:
  
  the value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  System tags for this resource. Each key is predefined and scoped to a namespace.
  
  Example: {"orcl-cloud": {"free-tier-retained": "true"}}
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class AgentEndpoint

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

AgentEndpoint

Method Detail

builder

toBuilder

getId

getDisplayName

getDescription

getCompartmentId

getAgentId

getContentModerationConfig

getShouldEnableTrace

getShouldEnableCitation

getShouldEnableSession

getSessionConfig

getTimeCreated

getTimeUpdated

getLifecycleState

getLifecycleDetails

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode