Show / Hide Table of Contents

Class ListKnowledgeBasesRequest

Inheritance
object
ListKnowledgeBasesRequest
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.AdmService.Requests
Assembly: OCI.DotNetSDK.Adm.dll
Syntax
public class ListKnowledgeBasesRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.

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 entire display name given.

Id

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

A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.

LifecycleState

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

A filter to return only Knowledge Bases that match the specified lifecycleState.

Limit

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

The maximum number of items to return.

OpcRequestId

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

The client request ID for tracing.

Page

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

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

SortBy

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

The field used to sort Knowledge Bases. Only one sort order is allowed. Default order for displayName is ascending alphabetical order. Default order for lifecyleState is the following sequence: CREATING, ACTIVE, UPDATING, FAILED, DELETING, and DELETED.Default order for timeCreated is descending. Default order for timeUpdated is descending.

SortOrder

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

The sort order to use, either 'ASC' or 'DESC'.

Implements

IOciRequest
In this article
Back to top