Package com.veeva.vault.sdk.api.webapi

Interface WebApiResponse.Builder

Enclosing interface:

WebApiResponse

public static interface WebApiResponse.Builder

Creates an instance of WebApiResponse.

Method Summary

Modifier and Type	Method	Description
WebApiResponse	build()	Validates and returns a completed WebApiResponse.
WebApiResponse.Builder	withData(JsonObject data)	Sets the JSON Object containing the response data.
WebApiResponse.Builder	withData(WebApiFileResponseData data)	Sets the WebApiFileResponseData for the response.
<U extends UserDefinedModel> WebApiResponse.Builder	withData(U data)	Sets the UserDefinedModel containing the response data.
WebApiResponse.Builder	withResponseStatus(WebApiResponseStatus responseStatus)	Sets the WebApiResponseStatus for the response.

Method Details

withData

<U extends UserDefinedModel> WebApiResponse.Builder withData(U data)

Sets the UserDefinedModel containing the response data.

Type Parameters:

U - type of UserDefinedModel as response data

Parameters:

data - optional, the WebAPI UserDefinedModel response data

Returns:

this WebApiResponse.Builder

withData

WebApiResponse.Builder withData(JsonObject data)

Sets the JSON Object containing the response data.

Parameters:

data - optional, the WebAPI JsonObject response data

Returns:

this WebApiResponse.Builder

withData

WebApiResponse.Builder withData(WebApiFileResponseData data)

Sets the WebApiFileResponseData for the response.

Parameters:

data - optional, the WebAPI file response data

Returns:

this WebApiResponse.Builder

withResponseStatus

WebApiResponse.Builder withResponseStatus(WebApiResponseStatus responseStatus)

Sets the WebApiResponseStatus for the response.

Parameters:

responseStatus - required, the status of request

Returns:

this WebApiResponse.Builder

build

WebApiResponse build()

Validates and returns a completed WebApiResponse.

Returns:

a completed WebApiResponse