public static class ListFoldersRequest.Builder extends Object implements BmcRequest.Builder<ListFoldersRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
ListFoldersRequest |
build()
Build the instance of ListFoldersRequest as configured by this builder
|
ListFoldersRequest |
buildWithoutInvocationCallback()
Build the instance of ListFoldersRequest as configured by this builder
|
ListFoldersRequest.Builder |
businessName(String businessName)
A filter to return only resources that match the entire business name given.
|
ListFoldersRequest.Builder |
catalogId(String catalogId)
Unique catalog identifier.
|
ListFoldersRequest.Builder |
copy(ListFoldersRequest o)
Copy method to populate the builder with values from the given instance.
|
ListFoldersRequest.Builder |
createdById(String createdById)
OCID of the user who created the resource.
|
ListFoldersRequest.Builder |
dataAssetKey(String dataAssetKey)
Unique data asset key.
|
ListFoldersRequest.Builder |
displayName(String displayName)
A filter to return only resources that match the entire display name given.
|
ListFoldersRequest.Builder |
displayNameContains(String displayNameContains)
A filter to return only resources that match display name pattern given.
|
ListFoldersRequest.Builder |
displayOrBusinessNameContains(String displayOrBusinessNameContains)
A filter to return only resources that match display name or business name pattern given.
|
ListFoldersRequest.Builder |
externalKey(String externalKey)
Unique external identifier of this resource in the external source system.
|
ListFoldersRequest.Builder |
fields(List<ListFoldersRequest.Fields> fields)
Specifies the fields to return in a folder summary response.
|
ListFoldersRequest.Builder |
fields(ListFoldersRequest.Fields singularValue)
Singular setter.
|
ListFoldersRequest.Builder |
harvestStatus(HarvestStatus harvestStatus)
Harvest status of the harvestable resource as updated by the harvest process.
|
ListFoldersRequest.Builder |
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
|
ListFoldersRequest.Builder |
lastJobKey(String lastJobKey)
Key of the last harvest process to update this resource.
|
ListFoldersRequest.Builder |
lifecycleState(LifecycleState lifecycleState)
A filter to return only resources that match the specified lifecycle state.
|
ListFoldersRequest.Builder |
limit(Integer limit)
The maximum number of items to return.
|
ListFoldersRequest.Builder |
opcRequestId(String opcRequestId)
The client request ID for tracing.
|
ListFoldersRequest.Builder |
page(String page)
The page token representing the page at which to start retrieving results.
|
ListFoldersRequest.Builder |
parentFolderKey(String parentFolderKey)
Unique folder key.
|
ListFoldersRequest.Builder |
path(String path)
Full path of the resource for resources that support paths.
|
ListFoldersRequest.Builder |
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
|
ListFoldersRequest.Builder |
sortBy(ListFoldersRequest.SortBy sortBy)
The field to sort by.
|
ListFoldersRequest.Builder |
sortOrder(ListFoldersRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
|
ListFoldersRequest.Builder |
timeCreated(Date timeCreated)
Time that the resource was created.
|
ListFoldersRequest.Builder |
timeUpdated(Date timeUpdated)
Time that the resource was updated.
|
ListFoldersRequest.Builder |
typeKey(String typeKey)
The key of the object type.
|
ListFoldersRequest.Builder |
updatedById(String updatedById)
OCID of the user who updated the resource.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListFoldersRequest.Builder catalogId(String catalogId)
Unique catalog identifier.
catalogId
- the value to setpublic ListFoldersRequest.Builder dataAssetKey(String dataAssetKey)
Unique data asset key.
dataAssetKey
- the value to setpublic ListFoldersRequest.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 ListFoldersRequest.Builder businessName(String businessName)
A filter to return only resources that match the entire business name given. The match is not case sensitive.
businessName
- the value to setpublic ListFoldersRequest.Builder displayOrBusinessNameContains(String displayOrBusinessNameContains)
A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with “Cu” or has the pattern “Cu” anywhere in between.
displayOrBusinessNameContains
- the value to setpublic ListFoldersRequest.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 ListFoldersRequest.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 ListFoldersRequest.Builder parentFolderKey(String parentFolderKey)
Unique folder key.
parentFolderKey
- the value to setpublic ListFoldersRequest.Builder path(String path)
Full path of the resource for resources that support paths.
path
- the value to setpublic ListFoldersRequest.Builder externalKey(String externalKey)
Unique external identifier of this resource in the external source system.
externalKey
- the value to setpublic ListFoldersRequest.Builder timeCreated(Date timeCreated)
Time that the resource was created. An RFC3339 formatted datetime string.
timeCreated
- the value to setpublic ListFoldersRequest.Builder timeUpdated(Date timeUpdated)
Time that the resource was updated. An RFC3339 formatted datetime string.
timeUpdated
- the value to setpublic ListFoldersRequest.Builder createdById(String createdById)
OCID of the user who created the resource.
createdById
- the value to setpublic ListFoldersRequest.Builder updatedById(String updatedById)
OCID of the user who updated the resource.
updatedById
- the value to setpublic ListFoldersRequest.Builder harvestStatus(HarvestStatus harvestStatus)
Harvest status of the harvestable resource as updated by the harvest process.
harvestStatus
- the value to setpublic ListFoldersRequest.Builder lastJobKey(String lastJobKey)
Key of the last harvest process to update this resource.
lastJobKey
- the value to setpublic ListFoldersRequest.Builder fields(List<ListFoldersRequest.Fields> fields)
Specifies the fields to return in a folder summary response.
fields
- the value to setpublic ListFoldersRequest.Builder fields(ListFoldersRequest.Fields singularValue)
Singular setter. Specifies the fields to return in a folder summary response.
singularValue
- the singular value to setpublic ListFoldersRequest.Builder typeKey(String typeKey)
The key of the object type.
typeKey
- the value to setpublic ListFoldersRequest.Builder sortBy(ListFoldersRequest.SortBy sortBy)
The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.
sortBy
- the value to setpublic ListFoldersRequest.Builder sortOrder(ListFoldersRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.
sortOrder
- the value to setpublic ListFoldersRequest.Builder limit(Integer limit)
The maximum number of items to return.
limit
- the value to setpublic ListFoldersRequest.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 ListFoldersRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.
opcRequestId
- the value to setpublic ListFoldersRequest.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 ListFoldersRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListFoldersRequest.Builder copy(ListFoldersRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListFoldersRequest,Void>
o
- other request from which to copy valuespublic ListFoldersRequest build()
Build the instance of ListFoldersRequest 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<ListFoldersRequest,Void>
public ListFoldersRequest buildWithoutInvocationCallback()
Build the instance of ListFoldersRequest 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.