com.oracle.bmc.adm.requests

Class ListKnowledgeBasesRequest

java.lang.Object

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

com.oracle.bmc.adm.requests.ListKnowledgeBasesRequest

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

Example: Click here to see how to use ListKnowledgeBasesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListKnowledgeBasesRequest.Builder
static class	ListKnowledgeBasesRequest.SortBy The field used to sort Knowledge Bases.

Constructor Summary

Constructors

Constructor and Description
ListKnowledgeBasesRequest()

Method Summary

Modifier and Type	Method and 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() A filter to return only resources that belong to the specified compartment identifier.
String	getDisplayName() A filter to return only resources that match the entire display name given.
String	getId() A filter to return only resources that match the specified identifier.
KnowledgeBase.LifecycleState	getLifecycleState() A filter to return only Knowledge Bases that match the specified lifecycleState.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() A token representing the position at which to start retrieving results.
ListKnowledgeBasesRequest.SortBy	getSortBy() The field used to sort Knowledge Bases.
SortOrder	getSortOrder() The sort order to use, either ‘ASC’ or ‘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

getId

public String getId()

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

getSortBy

public ListKnowledgeBasesRequest.SortBy getSortBy()

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.

getLifecycleState

public KnowledgeBase.LifecycleState getLifecycleState()

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

getSortOrder

public SortOrder getSortOrder()

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

getDisplayName

public String getDisplayName()

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

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

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.

getCompartmentId

public String getCompartmentId()

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

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>