public class CreateServiceInstanceBindingRequest extends AsyncServiceBrokerRequest
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.
Modifier and Type | Class and Description |
---|---|
static class |
CreateServiceInstanceBindingRequest.CreateServiceInstanceBindingRequestBuilder
Provides a fluent API for constructing a
CreateServiceInstanceBindingRequest . |
ASYNC_REQUEST_PARAMETER, asyncAccepted
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
Modifier and Type | Method and Description |
---|---|
static CreateServiceInstanceBindingRequest.CreateServiceInstanceBindingRequestBuilder |
builder()
Create a builder that provides a fluent API for constructing a CreateServiceInstanceBindingRequest.
|
boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
String |
getAppGuid()
Deprecated.
getBindResource() provides platform-neutral access to binding resource details |
String |
getBindingId()
Get the ID of the service binding to create.
|
BindResource |
getBindResource()
Get any details about the resource the binding is being created for (e.g.
|
Context |
getContext()
Get the platform-specific contextual information for the service binding.
|
Map<String,Object> |
getParameters()
Get any parameters passed by the user, with the user-supplied JSON structure converted to a Map.
|
<T> T |
getParameters(Class<T> cls)
Get any parameters passed by the user, with the user-supplied JSON structure mapped to fields of the specified
object type.
|
Plan |
getPlan()
Get the plan of the service instance associated with the binding.
|
String |
getPlanId()
Get the ID of the plan for to the service instance associated with the binding.
|
ServiceDefinition |
getServiceDefinition()
Get the service definition of the service instance associated with the binding.
|
String |
getServiceDefinitionId()
Get the ID of the service definition for the service instance associated with the binding.
|
String |
getServiceInstanceId()
Get the ID of the service instance associated with the binding.
|
int |
hashCode() |
void |
setBindingId(String bindingId)
This method is intended to be used internally only; use
builder() to construct an object of this
type and set all field values. |
void |
setPlan(Plan plan)
This method is intended to be used internally only; use
builder() to construct an object of this
type and set all field values. |
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() |
isAsyncAccepted, setAsyncAccepted
getApiInfoLocation, getOriginatingIdentity, getPlatformInstanceId, setApiInfoLocation, setOriginatingIdentity, setPlatformInstanceId
public String getServiceInstanceId()
This value is set from the :instance_id path element of the request from the platform.
public void setServiceInstanceId(String serviceInstanceId)
builder()
to construct an object of this
type and set all field values.serviceInstanceId
- the ID of the service instance associated with the bindingpublic String getBindingId()
This value is set from the :binding_id path element of the request from the platform.
public void setBindingId(String bindingId)
builder()
to construct an object of this
type and set all field values.bindingId
- the ID of the service binding to createpublic String getServiceDefinitionId()
Catalog
.
This value is set from the service_id field in the body of the request from the platform
public String getPlanId()
Catalog
within
the specified ServiceDefinition
.
This value is set from the plan_id field in the body of the request from the platform.
@Deprecated public String getAppGuid()
getBindResource()
provides platform-neutral access to binding resource detailsThis value is set from the app_guid field in the body of the request from the platform.
public BindResource getBindResource()
This value is set from the bind_resource field in the body of the request from the platform.
public Map<String,Object> getParameters()
This value is set from the parameters field in the body of the request from the platform.
The platform will pass the user-supplied JSON structure to the service broker as-is. The service broker is responsible for validating the contents of the parameters for correctness or applicability.
public <T> T getParameters(Class<T> cls)
This value is set from the parameters field in the body of the request from the platform.
An object of the specified type will be instantiated, and value from the parameters JSON will be mapped to the object using Java Bean mapping rules.
The platform will pass the user-supplied JSON structure to the service broker as-is. The service broker is responsible for validating the contents of the parameters for correctness or applicability.
T
- the type of the object to instantiate and populatecls
- the Class
representing the type of object to map the parameter key/value pairs topublic Context getContext()
This value is set from the context field in the body of the request from the platform.
public ServiceDefinition getServiceDefinition()
The service definition is retrieved from the
Catalog
as a convenience.
public void setServiceDefinition(ServiceDefinition serviceDefinition)
builder()
to construct an object of this
type and set all field values.serviceDefinition
- the service definition of the service instance associated with the bindingpublic Plan getPlan()
The plan is retrieved from the
Catalog
as a convenience.
public void setPlan(Plan plan)
builder()
to construct an object of this
type and set all field values.plan
- the plan of the service instance associated with the bindingpublic static CreateServiceInstanceBindingRequest.CreateServiceInstanceBindingRequestBuilder builder()
This builder is provided to support testing of
ServiceInstanceBindingService
implementations.
public final boolean equals(Object o)
equals
in class AsyncServiceBrokerRequest
public final boolean canEqual(Object other)
canEqual
in class AsyncServiceBrokerRequest
public final int hashCode()
hashCode
in class AsyncServiceBrokerRequest
public String toString()
toString
in class AsyncServiceBrokerRequest