Package com.oracle.bmc.datasafe.requests

Class ListSensitiveTypesRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public ListSensitiveTypesRequest.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 ListSensitiveTypesRequest.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 ListSensitiveTypesRequest.Builder accessLevel​(ListSensitiveTypesRequest.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 ListSensitiveTypesRequest.Builder displayName​(String displayName)
        A filter to return only resources that match the specified display name.
        Parameters:
        displayName - the value to set
        Returns:
        this builder instance

      • sensitiveTypeId

        public ListSensitiveTypesRequest.Builder sensitiveTypeId​(String sensitiveTypeId)
        A filter to return only items related to a specific sensitive type OCID.
        Parameters:
        sensitiveTypeId - the value to set
        Returns:
        this builder instance

      • sensitiveTypeSource

        public ListSensitiveTypesRequest.Builder sensitiveTypeSource​(SensitiveTypeSource sensitiveTypeSource)
        A filter to return the sensitive type resources based on the value of their source attribute.
        Parameters:
        sensitiveTypeSource - the value to set
        Returns:
        this builder instance

      • entityType

        public ListSensitiveTypesRequest.Builder entityType​(SensitiveTypeEntity entityType)
        A filter to return the sensitive type resources based on the value of their entityType attribute.
        Parameters:
        entityType - the value to set
        Returns:
        this builder instance

      • parentCategoryId

        public ListSensitiveTypesRequest.Builder parentCategoryId​(String parentCategoryId)
        A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID.
        Parameters:
        parentCategoryId - the value to set
        Returns:
        this builder instance

      • defaultMaskingFormatId

        public ListSensitiveTypesRequest.Builder defaultMaskingFormatId​(String defaultMaskingFormatId)
        A filter to return only the sensitive types that have the default masking format identified by the specified OCID.
        Parameters:
        defaultMaskingFormatId - the value to set
        Returns:
        this builder instance

      • timeCreatedGreaterThanOrEqualTo

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

        Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

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

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

      • timeCreatedLessThan

        public ListSensitiveTypesRequest.Builder timeCreatedLessThan​(Date timeCreatedLessThan)
        Search for resources that were created before a specific date.

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

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

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

      • sortBy

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

        You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for displayName is ascending.

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

      • opcRequestId

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

      • limit

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

      • isCommon

        public ListSensitiveTypesRequest.Builder isCommon​(Boolean isCommon)
        A filter to return only the common sensitive type resources.

        Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.

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

      • invocationCallback

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