Package com.oracle.bmc.identitydomains.requests

Class PatchSchemaRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public class PatchSchemaRequest
extends BmcRequest<PatchOp>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identitydomains/PatchSchemaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchSchemaRequest.

    • Constructor Detail

      • PatchSchemaRequest

        public PatchSchemaRequest()

    • Method Detail

      • getSchemaId

        public String getSchemaId()
        ID of the resource

      • getAuthorization

        public String getAuthorization()
        The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

      • getResourceTypeSchemaVersion

        public String getResourceTypeSchemaVersion()
        An endpoint-specific schema version number to use in the Request.

        Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

      • getPatchOp

        public PatchOp getPatchOp()
        Update the Schema with SCIM Patch schema.

        Before you specify an attribute-value in a request to update a resource, please check the **'mutability'** property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the **SCIM++ Properties** of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as *mutability:readWrite* or *mutability:writeOnly* or *mutability:immutable*: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as *mutability:readOnly*. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as *mutability:readOnly*. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as *mutability:immutable* and that already has a value in the specified resource.

        Also, before you use the query-parameter attributes to request specific attributes, please check the **'returned'** property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as *returned:default* or *returned:request* or *returned:always*: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as *returned:always*. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as *returned:default*, as well as any attribute that is defined as *returned:always*. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as *returned:never*.

      • getIfMatch

        public String getIfMatch()
        Used to make the request conditional on an ETag

      • getOpcRetryToken

        public String getOpcRetryToken()
        A token you supply to uniquely identify the request and provide idempotency if the request is retried.

        Idempotency tokens expire after 24 hours.

      • builder

        public static PatchSchemaRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<PatchOp>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<PatchOp>