com.oracle.bmc.datacatalog.requests

Class ListTermRelationshipsRequest

java.lang.Object

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

com.oracle.bmc.datacatalog.requests.ListTermRelationshipsRequest

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

Example: Click here to see how to use ListTermRelationshipsRequest.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ListTermRelationshipsRequest.Builder	builder()
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<ListTermRelationshipsRequest.Fields>	getFields() Specifies the fields to return in a term relationship summary response.
String	getGlossaryKey() Unique glossary key.
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.
ListTermRelationshipsRequest.SortBy	getSortBy() The field to sort by.
ListTermRelationshipsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
String	getTermKey() Unique glossary term key.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ListTermRelationshipsRequest.Builder builder()

getCatalogId

public String getCatalogId()

Unique catalog identifier.

getGlossaryKey

public String getGlossaryKey()

Unique glossary key.

getTermKey

public String getTermKey()

Unique glossary term 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".

getLifecycleState

public LifecycleState getLifecycleState()

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

getFields

public List<ListTermRelationshipsRequest.Fields> getFields()

Specifies the fields to return in a term relationship summary response.

getSortBy

public ListTermRelationshipsRequest.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 ListTermRelationshipsRequest.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.