Package 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/adm/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 classListKnowledgeBasesRequest.Builderstatic classListKnowledgeBasesRequest.SortByThe field used to sort Knowledge Bases.
-
Constructor Summary
Constructors Constructor Description ListKnowledgeBasesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListKnowledgeBasesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetCompartmentId()A filter to return only resources that belong to the specified compartment identifier.StringgetDisplayName()A filter to return only resources that match the entire display name given.StringgetId()A filter to return only resources that match the specified identifier.KnowledgeBase.LifecycleStategetLifecycleState()A filter to return only Knowledge Bases that match the specified lifecycleState.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.StringgetPage()A token representing the position at which to start retrieving results.ListKnowledgeBasesRequest.SortBygetSortBy()The field used to sort Knowledge Bases.SortOrdergetSortOrder()The sort order to use, either ‘ASC’ or ‘DESC’.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListKnowledgeBasesRequest.BuildertoBuilder()Return an instance ofListKnowledgeBasesRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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 ofListKnowledgeBasesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListKnowledgeBasesRequest.Builderthat 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
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-