org.springframework.cloud.servicebroker.model.instance

Class UpdateServiceInstanceRequest

java.lang.Object

org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

org.springframework.cloud.servicebroker.model.AsyncServiceBrokerRequest

org.springframework.cloud.servicebroker.model.instance.AsyncParameterizedServiceInstanceRequest

org.springframework.cloud.servicebroker.model.instance.UpdateServiceInstanceRequest

public class UpdateServiceInstanceRequest
extends AsyncParameterizedServiceInstanceRequest

Details of a request to update 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

See Also:

Open Service Broker API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateServiceInstanceRequest.PreviousValues Information about the service instance prior to the update request.
static class	UpdateServiceInstanceRequest.UpdateServiceInstanceRequestBuilder Provides a fluent API for constructing a UpdateServiceInstanceRequest.

Field Summary

Fields inherited from class org.springframework.cloud.servicebroker.model.instance.AsyncParameterizedServiceInstanceRequest

parameters

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

ASYNC_REQUEST_PARAMETER, asyncAccepted

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, SERVICE_ID_PARAMETER

Constructor Summary

Constructors

Constructor and Description
UpdateServiceInstanceRequest() Construct a new UpdateServiceInstanceRequest
UpdateServiceInstanceRequest(String serviceDefinitionId, String serviceInstanceId, String planId, ServiceDefinition serviceDefinition, Plan plan, UpdateServiceInstanceRequest.PreviousValues previousValues, Map<String,Object> parameters, Context context, boolean asyncAccepted, String platformInstanceId, String apiInfoLocation, Context originatingIdentity) Construct a new UpdateServiceInstanceRequest

Method Summary

Modifier and Type	Method and Description
static UpdateServiceInstanceRequest.UpdateServiceInstanceRequestBuilder	builder() Create a builder that provides a fluent API for constructing an UpdateServiceInstanceRequest.
boolean	canEqual(Object other) Is another object type compatible with this object
boolean	equals(Object o)
Plan	getPlan() Get the plan of the service instance to update
String	getPlanId() Get the ID of the plan for to the service instance to update.
UpdateServiceInstanceRequest.PreviousValues	getPreviousValues() Get information about the service instance prior to the update request.
ServiceDefinition	getServiceDefinition() Get the service definition of the service instance to update.
String	getServiceDefinitionId() Get the ID of the service definition for to the service instance to update.
String	getServiceInstanceId() Get the ID of the service instance to update.
int	hashCode()
void	setPlan(Plan plan) For internal use only.
void	setServiceDefinition(ServiceDefinition serviceDefinition) This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
void	setServiceInstanceId(String serviceInstanceId) This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.
String	toString()

Methods inherited from class org.springframework.cloud.servicebroker.model.instance.AsyncParameterizedServiceInstanceRequest

getContext, getParameters, getParameters

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

isAsyncAccepted, setAsyncAccepted

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

getApiInfoLocation, getOriginatingIdentity, getPlatformInstanceId, setApiInfoLocation, setOriginatingIdentity, setPlatformInstanceId

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateServiceInstanceRequest

public UpdateServiceInstanceRequest()

Construct a new UpdateServiceInstanceRequest

UpdateServiceInstanceRequest

public UpdateServiceInstanceRequest(String serviceDefinitionId,
                                    String serviceInstanceId,
                                    String planId,
                                    ServiceDefinition serviceDefinition,
                                    Plan plan,
                                    UpdateServiceInstanceRequest.PreviousValues previousValues,
                                    Map<String,Object> parameters,
                                    Context context,
                                    boolean asyncAccepted,
                                    String platformInstanceId,
                                    String apiInfoLocation,
                                    Context originatingIdentity)

Construct a new UpdateServiceInstanceRequest

Parameters:

serviceDefinitionId - the service definition ID

serviceInstanceId - the service instance ID

planId - the plan ID

serviceDefinition - the service definition

plan - the plan

previousValues - the previous values

parameters - the parameters

context - the context

asyncAccepted - does the platform accept asynchronous requests

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

Method Detail

getServiceInstanceId

public String getServiceInstanceId()

Get the ID of the service instance to update. This value is assigned by the platform. It must be unique within the platform and can be used to correlate any resources associated with the service instance.

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

Returns:

the service instance ID

setServiceInstanceId

public void setServiceInstanceId(String serviceInstanceId)

This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.

Parameters:

serviceInstanceId - the service instance ID to update

getServiceDefinitionId

public String getServiceDefinitionId()

Get the ID of the service definition for to the service instance to update. This will match one of the service definition IDs provided in the Catalog.

This value is set from the service_id field in the body of the request from the platform

Returns:

the service definition ID

getPlanId

public String getPlanId()

Get the ID of the plan for to the service instance to update. This will match one of the plan IDs provided in the Catalog within the specified ServiceDefinition.

This value is set from the plan_id field in the body of the request from the platform.

Returns:

the plan ID

getPreviousValues

public UpdateServiceInstanceRequest.PreviousValues getPreviousValues()

Get information about the service instance prior to the update request.

This value is set from the previous_values field in the body of the request from the platform.

Returns:

the prior service instance details

getServiceDefinition

public ServiceDefinition getServiceDefinition()

Get the service definition of the service instance to update.

The service definition is retrieved from the Catalog as a convenience.

Returns:

the service definition

setServiceDefinition

public void setServiceDefinition(ServiceDefinition serviceDefinition)

This method is intended to be used internally only; use builder() to construct an object of this type and set all field values.

Parameters:

serviceDefinition - the service definition of the service instance to update

getPlan

public Plan getPlan()

Get the plan of the service instance to update

The plan is retrieved from the Catalog as a convenience.

Returns:

the plan

setPlan

public void setPlan(Plan plan)

For internal use only. Use builder() to construct an object of this type and set all field values.

Parameters:

plan - the plan of the service instance to update

builder

public static UpdateServiceInstanceRequest.UpdateServiceInstanceRequestBuilder builder()

Create a builder that provides a fluent API for constructing an UpdateServiceInstanceRequest.

This builder is provided to support testing of ServiceInstanceService implementations.

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class AsyncParameterizedServiceInstanceRequest

canEqual

public final boolean canEqual(Object other)

Description copied from class: ServiceBrokerRequest

Is another object type compatible with this object

Overrides:

canEqual in class AsyncParameterizedServiceInstanceRequest

Parameters:

other - the other object

Returns:

true of compatible

hashCode

public final int hashCode()

Overrides:

hashCode in class AsyncParameterizedServiceInstanceRequest

toString

public String toString()

Overrides:

toString in class AsyncParameterizedServiceInstanceRequest