org.springframework.cloud.servicebroker.model.instance

Class GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder

java.lang.Object

org.springframework.cloud.servicebroker.model.instance.GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder

Enclosing class:

GetLastServiceOperationResponse

public static final class GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder
extends Object

Provides a fluent API for constructing a GetLastServiceOperationResponse.

Method Summary

Modifier and Type	Method and Description
GetLastServiceOperationResponse	build() Construct a GetLastServiceOperationResponse from the provided values.
GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder	deleteOperation(boolean deleteOperation) Set a boolean value indicating whether the current asynchronous operation is a delete operation.
GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder	description(String description) Set a user-facing description of the operation that the platform can display to the API client.
GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder	operationState(OperationState state) Set the current state of the asynchronous operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

operationState

public GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder operationState(OperationState state)

Set the current state of the asynchronous operation.

A value of OperationState.IN_PROGRESS will cause the platform to continue polling the service broker for status. A value of OperationState.SUCCEEDED or OperationState.FAILED will cause the platform to stop polling the service broker.

This value will set the state field in the body of the response to the platform.

Parameters:

state - the current state

Returns:

the builder

description

public GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder description(String description)

Set a user-facing description of the operation that the platform can display to the API client. Can be null.

This value will set the description field in the body of the response to the platform.

Parameters:

description - the description

Returns:

the builder

deleteOperation

public GetLastServiceOperationResponse.GetLastServiceOperationResponseBuilder deleteOperation(boolean deleteOperation)

Set a boolean value indicating whether the current asynchronous operation is a delete operation. Should be set to true in response to a request for the status of an asynchronous delete request, and false otherwise.

This value is used to determine the HTTP response code to the platform. If the operationState(OperationState) is OperationState.SUCCEEDED and the value provided here is true will result in a response code 410 GONE. Otherwise the response code will be 200 OK.

Parameters:

deleteOperation - the boolean value

Returns:

the builder

build

public GetLastServiceOperationResponse build()

Construct a GetLastServiceOperationResponse from the provided values.

Returns:

the newly constructed GetLastServiceOperationResponse