Package com.oracle.bmc.identitydomains.model

Class CloudGateServerSearchRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class CloudGateServerSearchRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the .search path extension.

    The inclusion of .search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in .search). The body of the POST request MAY include any of the parameters.
    Note: Objects should always be created or deserialized using the CloudGateServerSearchRequest.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CloudGateServerSearchRequest.Builder, which maintain a set of all explicitly set fields called CloudGateServerSearchRequest.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getSchemas

        public List<String> getSchemas()
        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.

        Returns:
        the value

      • getAttributes

        public List<String> getAttributes()
        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.

        Returns:
        the value

      • getAttributeSets

        public List<AttributeSets> getAttributeSets()
        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.

        Returns:
        the value

      • getFilter

        public String getFilter()
        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.

        Returns:
        the value

      • getSortBy

        public String getSortBy()
        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.

        Returns:
        the value

      • getSortOrder

        public SortOrder getSortOrder()
        A string that indicates the order in which the sortBy parameter is applied.

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

        Returns:
        the value

      • getStartIndex

        public Integer getStartIndex()
        An integer that indicates the 1-based index of the first query result.

        See Pagination Section. OPTIONAL.

        Returns:
        the value

      • getCount

        public Integer getCount()
        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.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel