Package com.oracle.bmc.datacatalog.requests

Class ListEntitiesRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • catalogId

        public ListEntitiesRequest.Builder catalogId​(String catalogId)
        Unique catalog identifier.
        Parameters:
        catalogId - the value to set
        Returns:
        this builder instance

      • dataAssetKey

        public ListEntitiesRequest.Builder dataAssetKey​(String dataAssetKey)
        Unique data asset key.
        Parameters:
        dataAssetKey - the value to set
        Returns:
        this builder instance

      • displayName

        public ListEntitiesRequest.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

      • businessName

        public ListEntitiesRequest.Builder businessName​(String businessName)
        A filter to return only resources that match the entire business name given.

        The match is not case sensitive.

        Parameters:
        businessName - the value to set
        Returns:
        this builder instance

      • displayOrBusinessNameContains

        public ListEntitiesRequest.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.

        Parameters:
        displayOrBusinessNameContains - the value to set
        Returns:
        this builder instance

      • typeKey

        public ListEntitiesRequest.Builder typeKey​(String typeKey)
        The key of the object type.
        Parameters:
        typeKey - the value to set
        Returns:
        this builder instance

      • displayNameContains

        public ListEntitiesRequest.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 ListEntitiesRequest.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

      • timeCreated

        public ListEntitiesRequest.Builder timeCreated​(Date timeCreated)
        Time that the resource was created.

        An RFC3339 formatted datetime string.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder instance

      • timeUpdated

        public ListEntitiesRequest.Builder timeUpdated​(Date timeUpdated)
        Time that the resource was updated.

        An RFC3339 formatted datetime string.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder instance

      • createdById

        public ListEntitiesRequest.Builder createdById​(String createdById)
        OCID of the user who created the resource.
        Parameters:
        createdById - the value to set
        Returns:
        this builder instance

      • updatedById

        public ListEntitiesRequest.Builder updatedById​(String updatedById)
        OCID of the user who updated the resource.
        Parameters:
        updatedById - the value to set
        Returns:
        this builder instance

      • externalKey

        public ListEntitiesRequest.Builder externalKey​(String externalKey)
        Unique external identifier of this resource in the external source system.
        Parameters:
        externalKey - the value to set
        Returns:
        this builder instance

      • patternKey

        public ListEntitiesRequest.Builder patternKey​(String patternKey)
        Unique pattern key.
        Parameters:
        patternKey - the value to set
        Returns:
        this builder instance

      • timeExternal

        public ListEntitiesRequest.Builder timeExternal​(Date timeExternal)
        Last modified timestamp of this object in the external system.
        Parameters:
        timeExternal - the value to set
        Returns:
        this builder instance

      • timeStatusUpdated

        public ListEntitiesRequest.Builder timeStatusUpdated​(Date timeStatusUpdated)
        Time that the resource’s status was last updated.

        An RFC3339 formatted datetime string.

        Parameters:
        timeStatusUpdated - the value to set
        Returns:
        this builder instance

      • isLogical

        public ListEntitiesRequest.Builder isLogical​(Boolean isLogical)
        Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
        Parameters:
        isLogical - the value to set
        Returns:
        this builder instance

      • isPartition

        public ListEntitiesRequest.Builder isPartition​(Boolean isPartition)
        Identifies if an object is a sub object (partition) of a physical or materialized parent object.
        Parameters:
        isPartition - the value to set
        Returns:
        this builder instance

      • folderKey

        public ListEntitiesRequest.Builder folderKey​(String folderKey)
        Key of the associated folder.
        Parameters:
        folderKey - the value to set
        Returns:
        this builder instance

      • path

        public ListEntitiesRequest.Builder path​(String path)
        Full path of the resource for resources that support paths.
        Parameters:
        path - the value to set
        Returns:
        this builder instance

      • harvestStatus

        public ListEntitiesRequest.Builder harvestStatus​(HarvestStatus harvestStatus)
        Harvest status of the harvestable resource as updated by the harvest process.
        Parameters:
        harvestStatus - the value to set
        Returns:
        this builder instance

      • lastJobKey

        public ListEntitiesRequest.Builder lastJobKey​(String lastJobKey)
        Key of the last harvest process to update this resource.
        Parameters:
        lastJobKey - the value to set
        Returns:
        this builder instance

      • sortBy

        public ListEntitiesRequest.Builder sortBy​(ListEntitiesRequest.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.

        Parameters:
        sortBy - the value to set
        Returns:
        this builder instance

      • limit

        public ListEntitiesRequest.Builder limit​(Integer limit)
        The maximum number of items to return.
        Parameters:
        limit - the value to set
        Returns:
        this builder instance

      • page

        public ListEntitiesRequest.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 ListEntitiesRequest.Builder opcRequestId​(String opcRequestId)
        The client request ID for tracing.
        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • isProcess

        public ListEntitiesRequest.Builder isProcess​(Boolean isProcess)
        A filter to return only process entities.
        Parameters:
        isProcess - the value to set
        Returns:
        this builder instance

      • invocationCallback

        public ListEntitiesRequest.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 ListEntitiesRequest.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