ListFoldersRequest (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.datacatalog.requests.ListFoldersRequest

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

Example: Click here to see how to use ListFoldersRequest.

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

ListFoldersRequest()

Constructors
Constructor and Description
`ListFoldersRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListFoldersRequest.Builder`	`builder()` Return a new builder for this request object.
`boolean`	`equals(Object o)` Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
`String`	`getBusinessName()` A filter to return only resources that match the entire business name given.
`String`	`getCatalogId()` Unique catalog identifier.
`String`	`getCreatedById()` OCID of the user who created the resource.
`String`	`getDataAssetKey()` Unique data asset key.
`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.
`String`	`getDisplayOrBusinessNameContains()` A filter to return only resources that match display name or business name pattern given.
`String`	`getExternalKey()` Unique external identifier of this resource in the external source system.
`List<ListFoldersRequest.Fields>`	`getFields()` Specifies the fields to return in a folder summary response.
`HarvestStatus`	`getHarvestStatus()` Harvest status of the harvestable resource as updated by the harvest process.
`String`	`getLastJobKey()` Key of the last harvest process to update this resource.
`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.
`String`	`getParentFolderKey()` Unique folder key.
`String`	`getPath()` Full path of the resource for resources that support paths.
`ListFoldersRequest.SortBy`	`getSortBy()` The field to sort by.
`ListFoldersRequest.SortOrder`	`getSortOrder()` The sort order to use, either ‘asc’ or ‘desc’.
`Date`	`getTimeCreated()` Time that the resource was created.
`Date`	`getTimeUpdated()` Time that the resource was updated.
`String`	`getTypeKey()` The key of the object type.
`String`	`getUpdatedById()` OCID of the user who updated the resource.
`int`	`hashCode()` Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListFoldersRequest.Builder`	`toBuilder()` Return an instance of `ListFoldersRequest.Builder` that allows you to modify request properties.
`String`	`toString()`

Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListFoldersRequest
```
public ListFoldersRequest()
```
- Method Detail
  - getCatalogId
```
public String getCatalogId()
```
    Unique catalog identifier.
  - getDataAssetKey
```
public String getDataAssetKey()
```
    Unique data asset key.
  - getDisplayName
```
public String getDisplayName()
```
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
  - getBusinessName
```
public String getBusinessName()
```
    A filter to return only resources that match the entire business name given. The match is not case sensitive.
  - getDisplayOrBusinessNameContains
```
public String getDisplayOrBusinessNameContains()
```
    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.
  - 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” or has the pattern “Cu” anywhere in between.
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
  - getParentFolderKey
```
public String getParentFolderKey()
```
    Unique folder key.
  - getPath
```
public String getPath()
```
    Full path of the resource for resources that support paths.
  - getExternalKey
```
public String getExternalKey()
```
    Unique external identifier of this resource in the external source system.
  - getTimeCreated
```
public Date getTimeCreated()
```
    Time that the resource was created. An RFC3339 formatted datetime string.
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    Time that the resource was updated. An RFC3339 formatted datetime string.
  - getCreatedById
```
public String getCreatedById()
```
    OCID of the user who created the resource.
  - getUpdatedById
```
public String getUpdatedById()
```
    OCID of the user who updated the resource.
  - getHarvestStatus
```
public HarvestStatus getHarvestStatus()
```
    Harvest status of the harvestable resource as updated by the harvest process.
  - getLastJobKey
```
public String getLastJobKey()
```
    Key of the last harvest process to update this resource.
  - getFields
```
public List<ListFoldersRequest.Fields> getFields()
```
    Specifies the fields to return in a folder summary response.
  - getTypeKey
```
public String getTypeKey()
```
    The key of the object type.
  - getSortBy
```
public ListFoldersRequest.SortBy getSortBy()
```
    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.
  - getSortOrder
```
public ListFoldersRequest.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.
  - toBuilder
```
public ListFoldersRequest.Builder toBuilder()
```
    Return an instance of ListFoldersRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListFoldersRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListFoldersRequest.Builder builder()
```
    Return a new builder for this request object.
    
    Returns:
    
    builder for the request object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
    
    Overrides:
    
    equals in class BmcRequest<Void>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<Void>

Class ListFoldersRequest

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListFoldersRequest

Method Detail

getCatalogId

getDataAssetKey

getDisplayName

getBusinessName

getDisplayOrBusinessNameContains

getDisplayNameContains

getLifecycleState

getParentFolderKey

getPath

getExternalKey

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getHarvestStatus

getLastJobKey

getFields

getTypeKey

getSortBy

getSortOrder

getLimit

getPage

getOpcRequestId

toBuilder

builder

toString

equals

hashCode