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

Interface DeleteResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

DeleteResponseBuilderImpl

public interface DeleteResponseBuilder
extends ResponseBuilder

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

Method Summary

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

Method Detail

addHeaders

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

Adds headers in the DeleteResponseBuilder object. If headers are already present in the DeleteResponseBuilder 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 DeleteResponseBuilder object containing the added headers

setHeader

DeleteResponseBuilder setHeader(String name,
                                String value)

Sets a header with the specified name and value in the DeleteResponseBuilder object. If the header is already present in the DeleteResponseBuilder 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 DeleteResponseBuilder object containing the newly added or updated header

addHeader

DeleteResponseBuilder addHeader(String name,
                                String value)

Adds a header with the specified name and value in the DeleteResponseBuilder object. If the header is already present in the DeleteResponseBuilder 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 DeleteResponseBuilder object containing the additional header

audit

@Deprecated
DeleteResponseBuilder audit(boolean enable)

Deprecated.

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

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A DeleteResponseBuilder object containing the updated auditing attribute

response

DeleteResponse response()

Returns an instance of DeleteResponse object.

Returns:

A DeleteResponse object