Package com.oracle.bmc.datasafe.requests

Class ListReportsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public ListReportsRequest.Builder compartmentId​(String compartmentId)
        A filter to return only resources that match the specified compartment OCID.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder instance

      • compartmentIdInSubtree

        public ListReportsRequest.Builder compartmentIdInSubtree​(Boolean compartmentIdInSubtree)
        Default is false.

        When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

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

      • accessLevel

        public ListReportsRequest.Builder accessLevel​(ListReportsRequest.AccessLevel accessLevel)
        Valid values are RESTRICTED and ACCESSIBLE.

        Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

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

      • displayName

        public ListReportsRequest.Builder displayName​(String displayName)
        The name of the report definition to query.
        Parameters:
        displayName - the value to set
        Returns:
        this builder instance

      • limit

        public ListReportsRequest.Builder limit​(Integer limit)
        For list pagination.

        The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

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

      • page

        public ListReportsRequest.Builder page​(String page)
        For list pagination.

        The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

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

      • sortBy

        public ListReportsRequest.Builder sortBy​(ListReportsRequest.SortBy sortBy)
        The field to sort by.

        Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default.

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

      • reportDefinitionId

        public ListReportsRequest.Builder reportDefinitionId​(String reportDefinitionId)
        The ID of the report definition to filter the list of reports
        Parameters:
        reportDefinitionId - the value to set
        Returns:
        this builder instance

      • timeGeneratedGreaterThanOrEqualTo

        public ListReportsRequest.Builder timeGeneratedGreaterThanOrEqualTo​(Date timeGeneratedGreaterThanOrEqualTo)
        A filter to return only the resources that were generated after the specified date and time, as defined by RFC3339.

        Using TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date.

        *Example:** 2016-12-19T16:39:57.600Z

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

      • timeGeneratedLessThan

        public ListReportsRequest.Builder timeGeneratedLessThan​(Date timeGeneratedLessThan)
        Search for resources that were generated before a specific date.

        Specifying this parameter corresponding timeGeneratedLessThan parameter will retrieve all resources generated before the specified generated date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

        *Example:** 2016-12-19T16:39:57.600Z

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

      • opcRequestId

        public ListReportsRequest.Builder opcRequestId​(String opcRequestId)
        Unique identifier for the request.
        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • lifecycleState

        public ListReportsRequest.Builder lifecycleState​(ReportLifecycleState lifecycleState)
        An optional filter to return only resources that match the specified lifecycle state.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder instance

      • type

        public ListReportsRequest.Builder type​(ReportType type)
        An optional filter to return only resources that match the specified type.
        Parameters:
        type - the value to set
        Returns:
        this builder instance

      • invocationCallback

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