com.sap.cloud.sdk.service.prov.api.response

Interface UpdateResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

UpdateResponseBuilderImpl

public interface UpdateResponseBuilder
extends ResponseBuilder

Provides the methods for creating a response, populating its header, and enabling audit logging in the case of a successful update operation.

Method Summary

Modifier and Type	Method and Description
UpdateResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the UpdateResponseBuilder object.
UpdateResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the UpdateResponseBuilder object.
UpdateResponseBuilder	audit(boolean enable) Deprecated.
UpdateResponse	response() Returns an instance of UpdateResponse object.
UpdateResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the UpdateResponseBuilder object.

Method Detail

addHeaders

UpdateResponseBuilder addHeaders(Map<String,List<String>> headers)

Adds headers in the UpdateResponseBuilder object. If headers are already present in the UpdateResponseBuilder object, the specified headers are added to the existing ones. The header name is case-insensitive. Note: The SDK framework might overwrite the values you add to the header in the final response that gets created.

Parameters:

headers - A java.util.Map> containing the headers to be added

Returns:

A UpdateResponseBuilder object containing the added headers

setHeader

UpdateResponseBuilder setHeader(String name,
                                String value)

Sets a header with the specified name and value in the UpdateResponseBuilder object. If the header is already present in the UpdateResponseBuilder object, the new value overwrites the previous one. The header name is case-insensitive. Note: The SDK framework might overwrite the value you set in the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the header value

Returns:

A UpdateResponseBuilder object containing the newly added or updated header

addHeader

UpdateResponseBuilder addHeader(String name,
                                String value)

Adds a header with the specified name and value in the UpdateResponseBuilder object. If the header is already present in the UpdateResponseBuilder object, the specified value is added to the existing values. The header name is case-insensitive. Note: The SDK framework might overwrite the value you add to the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the additional header value

Returns:

A UpdateResponseBuilder object containing the additional header

audit

@Deprecated
UpdateResponseBuilder audit(boolean enable)

Deprecated.

Enables auditing for update operation. Please note that auditing is disabled by default.

Parameters:

enable - A boolean to enable or disable auditing

Returns:

An UpdateResponseBuilder object containing the updated auditing attribute

response

UpdateResponse response()

Returns an instance of UpdateResponse object.

Returns:

An UpdateResponse object