Package org.springframework.cloud.servicebroker.model.instance

Class GetLastServiceOperationRequest

java.lang.Object

org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

org.springframework.cloud.servicebroker.model.instance.GetLastServiceOperationRequest

public class GetLastServiceOperationRequest
extends ServiceBrokerRequest

Details of a request to get the state of the last operation on a service instance.

Objects of this type are constructed by the framework from the headers, path variables, query parameters and message body passed to the service broker by the platform.

Author:

Scott Frederick, Roy Clarkson

See Also:

• Open Service Broker API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GetLastServiceOperationRequest.GetLastServiceOperationRequestBuilder	Provides a fluent API for constructing a GetLastServiceOperationRequest.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	operation

Fields inherited from class org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

API_INFO_LOCATION_HEADER, apiInfoLocation, BINDING_ID_PATH_VARIABLE, INSTANCE_ID_PATH_VARIABLE, ORIGINATING_IDENTITY_HEADER, originatingIdentity, PLAN_ID_PARAMETER, PLATFORM_INSTANCE_ID_VARIABLE, platformInstanceId, REQUEST_IDENTITY_HEADER, requestIdentity, SERVICE_ID_PARAMETER

Constructor Summary

Constructors

Constructor	Description
GetLastServiceOperationRequest(String serviceInstanceId, String serviceDefinitionId, String planId, String operation, String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity)	Construct a new GetLastServiceOperationRequest.

Method Summary

Modifier and Type	Method	Description
static GetLastServiceOperationRequest.GetLastServiceOperationRequestBuilder	builder()	Create a builder that provides a fluent API for constructing a GetLastServiceOperationRequestBuilder.
final boolean	canEqual(Object other)	Is another object type compatible with this object.
final boolean	equals(Object o)
String	getOperation()	Get the value of the operation field previously provided to the platform.
String	getPlanId()	Get the ID of the plan of the service instance.
String	getServiceDefinitionId()	Get the ID of the service definition of the service instance.
String	getServiceInstanceId()	Get the ID of the service instance.
final int	hashCode()
String	toString()

Methods inherited from class org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

getApiInfoLocation, getOriginatingIdentity, getPlatformInstanceId, getRequestIdentity, setApiInfoLocation, setOriginatingIdentity, setPlatformInstanceId, setRequestIdentity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

operation

protected final transient String operation

Constructor Details

GetLastServiceOperationRequest

public GetLastServiceOperationRequest(String serviceInstanceId,
 String serviceDefinitionId,
 String planId,
 String operation,
 String platformInstanceId,
 String apiInfoLocation,
 Context originatingIdentity,
 String requestIdentity)

Construct a new GetLastServiceOperationRequest.

Parameters:

serviceInstanceId - the service instance ID

serviceDefinitionId - the service definition ID

planId - the plan ID

operation - description of the operation being performed

platformInstanceId - the platform instance ID

apiInfoLocation - location of the API info endpoint of the platform instance

originatingIdentity - identity of the user that initiated the request from the platform

requestIdentity - identity of the request sent from the platform

Method Details

getServiceInstanceId

public String getServiceInstanceId()

Get the ID of the service instance.

This value is set from the :instance_id path element of the request from the platform.

Returns:

the service instance ID

getServiceDefinitionId

public String getServiceDefinitionId()

Get the ID of the service definition of the service instance.

This value is set from the service_id request parameter of the request from the platform

Returns:

the service definition ID

getPlanId

public String getPlanId()

Get the ID of the plan of the service instance.

This value is set from the plan_id request parameter of the request from the platform.

Returns:

the plan ID

getOperation

public String getOperation()

Get the value of the operation field previously provided to the platform.

Service brokers can optionally return an operation value to the platform in the response from an async create, update, or delete request. The platform will pass this value back to the broker if provided.

This value is set from the operation request parameter of the request from the platform.

Returns:

the operation value

builder

public static GetLastServiceOperationRequest.GetLastServiceOperationRequestBuilder builder()

Create a builder that provides a fluent API for constructing a GetLastServiceOperationRequestBuilder.

This builder is provided to support testing of ServiceInstanceService implementations.

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class ServiceBrokerRequest

canEqual

public final boolean canEqual(Object other)

Description copied from class: ServiceBrokerRequest

Is another object type compatible with this object.

Overrides:

canEqual in class ServiceBrokerRequest

Parameters:

other - the other object

Returns:

true of compatible

hashCode

public final int hashCode()

Overrides:

hashCode in class ServiceBrokerRequest

toString

public String toString()

Overrides:

toString in class ServiceBrokerRequest