public static class ListTermsRequest.Builder extends Object implements BmcRequest.Builder<ListTermsRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListTermsRequest |
build()
Build the instance of ListTermsRequest as configured by this builder
|
ListTermsRequest |
buildWithoutInvocationCallback()
Build the instance of ListTermsRequest as configured by this builder
|
ListTermsRequest.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(List<ListTermsRequest.Fields> fields)
Specifies the fields to return in a term summary response.
|
ListTermsRequest.Builder |
fields(ListTermsRequest.Fields singularValue)
Singular setter.
|
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListTermsRequest.Builder catalogId(String catalogId)
Unique catalog identifier.
catalogId
- the value to setpublic ListTermsRequest.Builder glossaryKey(String glossaryKey)
Unique glossary key.
glossaryKey
- the value to setpublic ListTermsRequest.Builder displayName(String displayName)
A filter to return only resources that match the entire display name given. The match is not case sensitive.
displayName
- the value to setpublic 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.
displayNameContains
- the value to setpublic ListTermsRequest.Builder lifecycleState(LifecycleState lifecycleState)
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
lifecycleState
- the value to setpublic ListTermsRequest.Builder parentTermKey(String parentTermKey)
Unique key of the parent term.
parentTermKey
- the value to setpublic ListTermsRequest.Builder isAllowedToHaveChildTerms(Boolean isAllowedToHaveChildTerms)
Indicates whether a term may contain child terms.
isAllowedToHaveChildTerms
- the value to setpublic ListTermsRequest.Builder workflowStatus(TermWorkflowStatus workflowStatus)
Status of the approval workflow for this business term in the glossary.
workflowStatus
- the value to setpublic ListTermsRequest.Builder path(String path)
Full path of the resource for resources that support paths.
path
- the value to setpublic ListTermsRequest.Builder fields(List<ListTermsRequest.Fields> fields)
Specifies the fields to return in a term summary response.
fields
- the value to setpublic ListTermsRequest.Builder fields(ListTermsRequest.Fields singularValue)
Singular setter. Specifies the fields to return in a term summary response.
singularValue
- the singular value to setpublic 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.
sortBy
- the value to setpublic ListTermsRequest.Builder sortOrder(ListTermsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
sortOrder
- the value to setpublic ListTermsRequest.Builder limit(Integer limit)
The maximum number of items to return.
limit
- the value to setpublic 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.
page
- the value to setpublic ListTermsRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.
opcRequestId
- the value to setpublic ListTermsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListTermsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListTermsRequest.Builder copy(ListTermsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListTermsRequest,Void>
o
- other request from which to copy valuespublic ListTermsRequest build()
Build the instance of ListTermsRequest 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.
build
in interface BmcRequest.Builder<ListTermsRequest,Void>
public ListTermsRequest buildWithoutInvocationCallback()
Build the instance of ListTermsRequest 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
Copyright © 2016–2024. All rights reserved.