com.unboundid.directory.sdk.broker.types
Interface StoreUpdateRequest

@NotExtensible
public interface StoreUpdateRequest

Represents an update request received by a DataView in the Identity Broker. An update request can perform different operations on different attributes, so this interface splits them out by operation (update/merge and delete).

Method Summary

java.lang.String	getId() Get the SCIM ID of the resource to update.
com.unboundid.scim.data.BaseResource	getPartialResource() Get the partial resource with the modifications that may be sent in a PATCH request.
com.unboundid.scim.sdk.SCIMQueryAttributes	getSCIMQueryAttributes() Get the SCIMQueryAttributes, which indicates whether all attributes or only a certain subset should be returned.

Method Detail

getId

java.lang.String getId()

Get the SCIM ID of the resource to update.

Returns:

the SCIM ID

getPartialResource

com.unboundid.scim.data.BaseResource getPartialResource()

Get the partial resource with the modifications that may be sent in a PATCH request.

This resource conforms to Section 3.3.2 of the SCIM 1.1 specification (draft-scim-api-01), "Modifying Resources with PATCH".

Returns:

the partial resource which contains the PATCH modifications. This will never be null.

getSCIMQueryAttributes

com.unboundid.scim.sdk.SCIMQueryAttributes getSCIMQueryAttributes()

Get the SCIMQueryAttributes, which indicates whether all attributes or only a certain subset should be returned.

Returns:

the SCIMQueryAttributes. This will never be null.