Class ListFoldersRequest


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

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.1/datacatalog/ListFoldersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFoldersRequest.

    • 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.
      • 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.

      • 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.
      • builder

        public static ListFoldersRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>