Class ListTermsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datacatalog.requests.ListTermsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListTermsRequest,Void>
- Enclosing class:
- ListTermsRequest
public static class ListTermsRequest.Builder extends Object implements BmcRequest.Builder<ListTermsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListTermsRequest
build()
Build the instance of ListTermsRequest as configured by this builderListTermsRequest
buildWithoutInvocationCallback()
Build the instance of ListTermsRequest as configured by this builderListTermsRequest.Builder
catalogId(String catalogId)
Unique catalog identifier.ListTermsRequest.Builder
copy(ListTermsRequest o)
Copy method to populate the builder with values from the given instance.ListTermsRequest.Builder
displayName(String displayName)
A filter to return only resources that match the entire display name given.ListTermsRequest.Builder
displayNameContains(String displayNameContains)
A filter to return only resources that match display name pattern given.ListTermsRequest.Builder
fields(ListTermsRequest.Fields singularValue)
Singular setter.ListTermsRequest.Builder
fields(List<ListTermsRequest.Fields> fields)
Specifies the fields to return in a term summary response.ListTermsRequest.Builder
glossaryKey(String glossaryKey)
Unique glossary key.ListTermsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListTermsRequest.Builder
isAllowedToHaveChildTerms(Boolean isAllowedToHaveChildTerms)
Indicates whether a term may contain child terms.ListTermsRequest.Builder
lifecycleState(LifecycleState lifecycleState)
A filter to return only resources that match the specified lifecycle state.ListTermsRequest.Builder
limit(Integer limit)
The maximum number of items to return.ListTermsRequest.Builder
opcRequestId(String opcRequestId)
The client request ID for tracing.ListTermsRequest.Builder
page(String page)
The page token representing the page at which to start retrieving results.ListTermsRequest.Builder
parentTermKey(String parentTermKey)
Unique key of the parent term.ListTermsRequest.Builder
path(String path)
Full path of the resource for resources that support paths.ListTermsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListTermsRequest.Builder
sortBy(ListTermsRequest.SortBy sortBy)
The field to sort by.ListTermsRequest.Builder
sortOrder(ListTermsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.ListTermsRequest.Builder
workflowStatus(TermWorkflowStatus workflowStatus)
Status of the approval workflow for this business term in the glossary.-
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$
-
-
-
-
Method Detail
-
catalogId
public ListTermsRequest.Builder catalogId(String catalogId)
Unique catalog identifier.- Parameters:
catalogId
- the value to set- Returns:
- this builder instance
-
glossaryKey
public ListTermsRequest.Builder glossaryKey(String glossaryKey)
Unique glossary key.- Parameters:
glossaryKey
- the value to set- Returns:
- this builder instance
-
displayName
public ListTermsRequest.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 ListTermsRequest.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 ListTermsRequest.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
-
parentTermKey
public ListTermsRequest.Builder parentTermKey(String parentTermKey)
Unique key of the parent term.- Parameters:
parentTermKey
- the value to set- Returns:
- this builder instance
-
isAllowedToHaveChildTerms
public ListTermsRequest.Builder isAllowedToHaveChildTerms(Boolean isAllowedToHaveChildTerms)
Indicates whether a term may contain child terms.- Parameters:
isAllowedToHaveChildTerms
- the value to set- Returns:
- this builder instance
-
workflowStatus
public ListTermsRequest.Builder workflowStatus(TermWorkflowStatus workflowStatus)
Status of the approval workflow for this business term in the glossary.- Parameters:
workflowStatus
- the value to set- Returns:
- this builder instance
-
path
public ListTermsRequest.Builder path(String path)
Full path of the resource for resources that support paths.- Parameters:
path
- the value to set- Returns:
- this builder instance
-
fields
public ListTermsRequest.Builder fields(List<ListTermsRequest.Fields> fields)
Specifies the fields to return in a term summary response.- Parameters:
fields
- the value to set- Returns:
- this builder instance
-
fields
public ListTermsRequest.Builder fields(ListTermsRequest.Fields singularValue)
Singular setter.Specifies the fields to return in a term summary response.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
sortBy
public ListTermsRequest.Builder sortBy(ListTermsRequest.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 ListTermsRequest.Builder sortOrder(ListTermsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
limit
public ListTermsRequest.Builder limit(Integer limit)
The maximum number of items to return.- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListTermsRequest.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 ListTermsRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListTermsRequest.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 ListTermsRequest.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 ListTermsRequest.Builder copy(ListTermsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListTermsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListTermsRequest build()
Build the instance of ListTermsRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListTermsRequest,Void>
- Returns:
- instance of ListTermsRequest
-
buildWithoutInvocationCallback
public ListTermsRequest buildWithoutInvocationCallback()
Build the instance of ListTermsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListTermsRequest
-
-