Package com.oracle.bmc.adm.requests

Class ListKnowledgeBasesRequest.Builder

java.lang.Object

com.oracle.bmc.adm.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)	A filter to return only resources that belong to the specified compartment identifier.
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 entire display name given.
ListKnowledgeBasesRequest.Builder	id(String id)	A filter to return only resources that match the specified identifier.
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 Knowledge Bases that match the specified lifecycleState.
ListKnowledgeBasesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListKnowledgeBasesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListKnowledgeBasesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListKnowledgeBasesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListKnowledgeBasesRequest.Builder	sortBy(ListKnowledgeBasesRequest.SortBy sortBy)	The field used to sort Knowledge Bases.
ListKnowledgeBasesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘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

id

public ListKnowledgeBasesRequest.Builder id(String id)

A filter to return only resources that match the specified identifier.

Required only if the compartmentId query parameter is not specified.

Parameters:

id - the value to set

Returns:

this builder instance

sortBy

public ListKnowledgeBasesRequest.Builder sortBy(ListKnowledgeBasesRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListKnowledgeBasesRequest.Builder lifecycleState(KnowledgeBase.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortOrder

public ListKnowledgeBasesRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

displayName

public ListKnowledgeBasesRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListKnowledgeBasesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListKnowledgeBasesRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

compartmentId

public ListKnowledgeBasesRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that belong to the specified compartment identifier.

Required only if the id query param is not specified.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListKnowledgeBasesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

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