Package com.oracle.bmc.generativeaiagent.requests

Class ListKnowledgeBasesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.generativeaiagent.requests.ListKnowledgeBasesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public class ListKnowledgeBasesRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/generativeaiagent/ListKnowledgeBasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListKnowledgeBasesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListKnowledgeBasesRequest.Builder
static class	ListKnowledgeBasesRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListKnowledgeBasesRequest()

Method Summary

Modifier and Type	Method	Description
static ListKnowledgeBasesRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The OCID of the compartment in which to list resources.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
KnowledgeBase.LifecycleState	getLifecycleState()	A filter to return only resources that match the given lifecycle state.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	Unique Oracle-assigned identifier for the request.
String	getPage()	For list pagination.
ListKnowledgeBasesRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListKnowledgeBasesRequest.Builder	toBuilder()	Return an instance of ListKnowledgeBasesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListKnowledgeBasesRequest

public ListKnowledgeBasesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment in which to list resources.

getLifecycleState

public KnowledgeBase.LifecycleState getLifecycleState()

A filter to return only resources that match the given lifecycle state.

The state value is case-insensitive.

getDisplayName

public String getDisplayName()

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

getLimit

public Integer getLimit()

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.

getPage

public String getPage()

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.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListKnowledgeBasesRequest.SortBy getSortBy()

The field to sort by.

You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

getOpcRequestId

public String getOpcRequestId()

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.

toBuilder

public ListKnowledgeBasesRequest.Builder toBuilder()

Return an instance of ListKnowledgeBasesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListKnowledgeBasesRequest.Builder that allows you to modify request properties.

builder

public static ListKnowledgeBasesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>