Class MyAppSearchRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • schemas

        public MyAppSearchRequest.Builder schemas​(List<String> schemas)
        The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation.

        Each String value must be a unique URI. Query requests MUST be identified using the following URI: “urn:ietf:params:scim:api:messages:2.0:SearchRequest” REQUIRED.

        Parameters:
        schemas - the value to set
        Returns:
        this builder
      • attributes

        public MyAppSearchRequest.Builder attributes​(List<String> attributes)
        A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default.

        Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.

        Parameters:
        attributes - the value to set
        Returns:
        this builder
      • attributeSets

        public MyAppSearchRequest.Builder attributeSets​(List<AttributeSets> attributeSets)
        A multi-valued list of strings indicating the return type of attribute definition.
        The
        specified set of attributes can be fetched by the return type of the attribute. One or
        more values can be given together to fetch more than one group of attributes. If
        “attributes” query parameter is also available, union of the two is fetched. Valid values
        all, always, never, request, default. Values are case-insensitive. OPTIONAL.
        Parameters:
        attributeSets - the value to set
        Returns:
        this builder
      • filter

        public MyAppSearchRequest.Builder filter​(String filter)
        The filter string that is used to request a subset of resources.

        The filter string MUST be a valid filter expression. See Section 3.4.2.2. OPTIONAL.

        Parameters:
        filter - the value to set
        Returns:
        this builder
      • sortBy

        public MyAppSearchRequest.Builder sortBy​(String sortBy)
        A string that indicates the attribute whose value SHALL be used to order the returned responses.

        The sortBy attribute MUST be in standard attribute notation (Section 3.10) form. See Sorting section. OPTIONAL.

        Parameters:
        sortBy - the value to set
        Returns:
        this builder
      • sortOrder

        public MyAppSearchRequest.Builder sortOrder​(SortOrder sortOrder)
        A string that indicates the order in which the sortBy parameter is applied.

        Allowed values are “ascending” and “descending”. See (Sorting Section). OPTIONAL.

        Parameters:
        sortOrder - the value to set
        Returns:
        this builder
      • count

        public MyAppSearchRequest.Builder count​(Integer count)
        An integer that indicates the desired maximum number of query results per page.

        1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). OPTIONAL.

        Parameters:
        count - the value to set
        Returns:
        this builder