Package com.oracle.bmc.generativeaiagent.requests

Class ListKnowledgeBasesRequest.Builder

java.lang.Object

com.oracle.bmc.generativeaiagent.requests.ListKnowledgeBasesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListKnowledgeBasesRequest,Void>

Enclosing class:

ListKnowledgeBasesRequest

public static class ListKnowledgeBasesRequest.Builder
extends Object
implements BmcRequest.Builder<ListKnowledgeBasesRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListKnowledgeBasesRequest	build()	Build the instance of ListKnowledgeBasesRequest as configured by this builder
ListKnowledgeBasesRequest	buildWithoutInvocationCallback()	Build the instance of ListKnowledgeBasesRequest as configured by this builder
ListKnowledgeBasesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListKnowledgeBasesRequest.Builder	copy(ListKnowledgeBasesRequest o)	Copy method to populate the builder with values from the given instance.
ListKnowledgeBasesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListKnowledgeBasesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListKnowledgeBasesRequest.Builder	lifecycleState(KnowledgeBase.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state.
ListKnowledgeBasesRequest.Builder	limit(Integer limit)	For list pagination.
ListKnowledgeBasesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListKnowledgeBasesRequest.Builder	page(String page)	For list pagination.
ListKnowledgeBasesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListKnowledgeBasesRequest.Builder	sortBy(ListKnowledgeBasesRequest.SortBy sortBy)	The field to sort by.
ListKnowledgeBasesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListKnowledgeBasesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListKnowledgeBasesRequest.Builder lifecycleState(KnowledgeBase.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListKnowledgeBasesRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListKnowledgeBasesRequest.Builder limit(Integer limit)

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.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListKnowledgeBasesRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListKnowledgeBasesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListKnowledgeBasesRequest.Builder sortBy(ListKnowledgeBasesRequest.SortBy sortBy)

The field to sort by.

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

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListKnowledgeBasesRequest.Builder opcRequestId(String opcRequestId)

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.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListKnowledgeBasesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListKnowledgeBasesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListKnowledgeBasesRequest.Builder copy(ListKnowledgeBasesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListKnowledgeBasesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListKnowledgeBasesRequest build()

Build the instance of ListKnowledgeBasesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListKnowledgeBasesRequest,Void>

Returns:

instance of ListKnowledgeBasesRequest

buildWithoutInvocationCallback

public ListKnowledgeBasesRequest buildWithoutInvocationCallback()

Build the instance of ListKnowledgeBasesRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListKnowledgeBasesRequest