Package com.oracle.bmc.datacatalog.requests

Class ListTermRelationshipsRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.ListTermRelationshipsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListTermRelationshipsRequest,Void>

Enclosing class:

ListTermRelationshipsRequest

public static class ListTermRelationshipsRequest.Builder
extends Object
implements BmcRequest.Builder<ListTermRelationshipsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListTermRelationshipsRequest	build()	Build the instance of ListTermRelationshipsRequest as configured by this builder
ListTermRelationshipsRequest	buildWithoutInvocationCallback()	Build the instance of ListTermRelationshipsRequest as configured by this builder
ListTermRelationshipsRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
ListTermRelationshipsRequest.Builder	copy(ListTermRelationshipsRequest o)	Copy method to populate the builder with values from the given instance.
ListTermRelationshipsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListTermRelationshipsRequest.Builder	displayNameContains(String displayNameContains)	A filter to return only resources that match display name pattern given.
ListTermRelationshipsRequest.Builder	fields(ListTermRelationshipsRequest.Fields singularValue)	Singular setter.
ListTermRelationshipsRequest.Builder	fields(List<ListTermRelationshipsRequest.Fields> fields)	Specifies the fields to return in a term relationship summary response.
ListTermRelationshipsRequest.Builder	glossaryKey(String glossaryKey)	Unique glossary key.
ListTermRelationshipsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListTermRelationshipsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter to return only resources that match the specified lifecycle state.
ListTermRelationshipsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListTermRelationshipsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListTermRelationshipsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListTermRelationshipsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListTermRelationshipsRequest.Builder	sortBy(ListTermRelationshipsRequest.SortBy sortBy)	The field to sort by.
ListTermRelationshipsRequest.Builder	sortOrder(ListTermRelationshipsRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListTermRelationshipsRequest.Builder	termKey(String termKey)	Unique glossary term key.

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

catalogId

public ListTermRelationshipsRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

glossaryKey

public ListTermRelationshipsRequest.Builder glossaryKey(String glossaryKey)

Unique glossary key.

Parameters:

glossaryKey - the value to set

Returns:

this builder instance

termKey

public ListTermRelationshipsRequest.Builder termKey(String termKey)

Unique glossary term key.

Parameters:

termKey - the value to set

Returns:

this builder instance

displayName

public ListTermRelationshipsRequest.Builder displayName(String displayName)

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

The match is not case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

displayNameContains

public ListTermRelationshipsRequest.Builder displayNameContains(String displayNameContains)

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.

Parameters:

displayNameContains - the value to set

Returns:

this builder instance

lifecycleState

public ListTermRelationshipsRequest.Builder lifecycleState(LifecycleState lifecycleState)

A filter to return only resources that match the specified lifecycle state.

The value is case insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

fields

public ListTermRelationshipsRequest.Builder fields(List<ListTermRelationshipsRequest.Fields> fields)

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

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public ListTermRelationshipsRequest.Builder fields(ListTermRelationshipsRequest.Fields singularValue)

Singular setter.

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

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

sortBy

public ListTermRelationshipsRequest.Builder sortBy(ListTermRelationshipsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListTermRelationshipsRequest.Builder sortOrder(ListTermRelationshipsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListTermRelationshipsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListTermRelationshipsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListTermRelationshipsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListTermRelationshipsRequest.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 ListTermRelationshipsRequest.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 ListTermRelationshipsRequest.Builder copy(ListTermRelationshipsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListTermRelationshipsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListTermRelationshipsRequest build()

Build the instance of ListTermRelationshipsRequest 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<ListTermRelationshipsRequest,Void>

Returns:

instance of ListTermRelationshipsRequest

buildWithoutInvocationCallback

public ListTermRelationshipsRequest buildWithoutInvocationCallback()

Build the instance of ListTermRelationshipsRequest 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 ListTermRelationshipsRequest