@Generated(value="OracleSDKGenerator", comments="API Version: 20240531") public final class AgentEndpointSummary extends ExplicitlySetBmcModel
AgentEndpointSummary
Summary information about an endpoint.
Note: Objects should always be created or deserialized using the AgentEndpointSummary.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 AgentEndpointSummary.Builder, which maintain a set of all explicitly set fields called
ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
AgentEndpointSummary.Builder |
| Constructor and Description |
|---|
AgentEndpointSummary(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.
|
| Modifier and Type | Method and Description |
|---|---|
static AgentEndpointSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAgentId()
The OCID of the agent that this AgentEndpoint 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 AgentEndpoint.
|
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 endpoint was created, in the format defined by RFC 3339.
|
Date |
getTimeUpdated()
The date and time the AgentEndpoint was updated, in the format defined by RFC 3339.
|
int |
hashCode() |
AgentEndpointSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","agentId","contentModerationConfig","shouldEnableTrace","shouldEnableCitation","shouldEnableSession","sessionConfig","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"}) public AgentEndpointSummary(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)
public static AgentEndpointSummary.Builder builder()
Create a new builder.
public AgentEndpointSummary.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDescription()
An optional description of the endpoint.
public String getAgentId()
The OCID of the agent that this AgentEndpoint is associated with.
public ContentModerationConfig getContentModerationConfig()
public Boolean getShouldEnableTrace()
Whether to show traces in the chat result.
public Boolean getShouldEnableCitation()
Whether to show citations in the chat result.
public Boolean getShouldEnableSession()
Whether or not to enable Session-based chat.
public SessionConfig getSessionConfig()
public Date getTimeCreated()
The date and time the endpoint was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
public Date getTimeUpdated()
The date and time the AgentEndpoint was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
public AgentEndpoint.LifecycleState getLifecycleState()
The current state of the endpoint.
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.
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"}
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"}}
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"}}
public String toString()
toString in class ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class ExplicitlySetBmcModelpublic int hashCode()
hashCode in class ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.