Show / Hide Table of Contents

Class ListToolsRequest

Inheritance
object
ListToolsRequest
Implements
IOciRequest
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiagentService.Requests
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class ListToolsRequest : IOciRequest
Examples

Click here to see an example of how to use ListTools request.

Properties

AgentId

Declaration
[HttpConverter(TargetEnum.Query, "agentId")]
public string AgentId { get; set; }
Property Value
Type Description
string

The OCID of the agent.

CompartmentId

Declaration
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment in which to list resources.

DisplayName

Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A filter to return only resources that match the given display name exactly.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Tool.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Tool.LifecycleStateEnum?

A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListToolsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListToolsRequest.SortByEnum?

The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type Description
SortOrder?

The sort order to use, either ascending (ASC) or descending (DESC).

Implements

IOciRequest
In this article
Back to top