Class ToolSummary

Summary information of a Tool.

Inheritance

object

ToolSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiagentService.Models

Assembly: OCI.DotNetSDK.Generativeaiagent.dll

Syntax

public class ToolSummary

Properties

AgentId

Declaration

[Required(ErrorMessage = "AgentId is required.")]
[JsonProperty(PropertyName = "agentId")]
public string AgentId { get; set; }

Property Value

Type	Description
string	The OCID of the agent that this Tool is attached to.

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Description about the Tool.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the Tool.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public Tool.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Tool.LifecycleStateEnum?	The current state of the agent.

Remarks

Required

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public Dictionary<string, string> Metadata { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Key-value pairs to allow additional configurations.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

ToolConfig

Declaration

[Required(ErrorMessage = "ToolConfig is required.")]
[JsonProperty(PropertyName = "toolConfig")]
public ToolConfig ToolConfig { get; set; }

Property Value

Type	Description
ToolConfig

Remarks

Required