com.oracle.bmc.datacatalog.requests

Class ListTermsRequest

java.lang.Object

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

com.oracle.bmc.datacatalog.requests.ListTermsRequest

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

Example: Click here to see how to use ListTermsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTermsRequest.Builder
static class	ListTermsRequest.Fields Specifies the fields to return in a term summary response.
static class	ListTermsRequest.SortBy The field to sort by.
static class	ListTermsRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’.

Constructor Summary

Constructors

Constructor and Description
ListTermsRequest()

Method Summary

Modifier and Type	Method and Description
static ListTermsRequest.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	getCatalogId() Unique catalog identifier.
String	getDisplayName() A filter to return only resources that match the entire display name given.
String	getDisplayNameContains() A filter to return only resources that match display name pattern given.
List<ListTermsRequest.Fields>	getFields() Specifies the fields to return in a term summary response.
String	getGlossaryKey() Unique glossary key.
Boolean	getIsAllowedToHaveChildTerms() Indicates whether a term may contain child terms.
LifecycleState	getLifecycleState() A filter to return only resources that match the specified lifecycle state.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
String	getParentTermKey() Unique key of the parent term.
String	getPath() Full path of the resource for resources that support paths.
ListTermsRequest.SortBy	getSortBy() The field to sort by.
ListTermsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
TermWorkflowStatus	getWorkflowStatus() Status of the approval workflow for this business term in the glossary.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListTermsRequest.Builder	toBuilder() Return an instance of ListTermsRequest.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

ListTermsRequest

public ListTermsRequest()

Method Detail

getCatalogId

public String getCatalogId()

Unique catalog identifier.

getGlossaryKey

public String getGlossaryKey()

Unique glossary key.

getDisplayName

public String getDisplayName()

A filter to return only resources that match the entire display name given. The match is not case sensitive.

getDisplayNameContains

public String getDisplayNameContains()

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between.

getLifecycleState

public LifecycleState getLifecycleState()

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getParentTermKey

public String getParentTermKey()

Unique key of the parent term.

getIsAllowedToHaveChildTerms

public Boolean getIsAllowedToHaveChildTerms()

Indicates whether a term may contain child terms.

getWorkflowStatus

public TermWorkflowStatus getWorkflowStatus()

Status of the approval workflow for this business term in the glossary.

getPath

public String getPath()

Full path of the resource for resources that support paths.

getFields

public List<ListTermsRequest.Fields> getFields()

Specifies the fields to return in a term summary response.

getSortBy

public ListTermsRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

getSortOrder

public ListTermsRequest.SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListTermsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListTermsRequest.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>