public interface Response
Modifier and Type | Method and Description |
---|---|
Response |
createSchema()
Create a blank Schema object in the Response.
|
java.lang.String |
getDescription()
Get the description for this response.
|
com.ibm.broker.rest.schema.Schema |
getSchema()
Get the Schema for this response.
|
java.lang.String |
getSchemaAsString(com.ibm.broker.rest.schema.SchemaType schemaType)
Get the schema for this response as a string.
|
int |
getStatusCode()
Get the HTTP status code for this response.
|
Response |
setDescription(java.lang.String description)
Set the description for this response.
|
Response |
setSchema(com.ibm.broker.rest.schema.Schema schema)
Set the Schema for this repsonse.
|
Response |
setSchema(com.ibm.broker.rest.schema.SchemaType schemaType,
java.lang.String schema)
Set the schema for this response.
|
Response |
setStatusCode(int statusCode)
Set the HTTP status code for this response.
|
int getStatusCode()
Response setStatusCode(int statusCode) throws ApiException
statusCode
- the new HTTP status code for this response.ApiException
- if the HTTP status code could not be changed.java.lang.String getDescription()
Response setDescription(java.lang.String description) throws ApiException
description
- the new description for this response.ApiException
- if the description could not be changed.Response createSchema() throws ApiException
ApiException
java.lang.String getSchemaAsString(com.ibm.broker.rest.schema.SchemaType schemaType)
schemaType
- the type of the schema to retrieve, for example JSON Schema.com.ibm.broker.rest.schema.Schema getSchema() throws ApiException
ApiException
Response setSchema(com.ibm.broker.rest.schema.SchemaType schemaType, java.lang.String schema) throws ApiException
schemaType
- the type of the schema to set, for example JSON Schema.schema
- the schema as a string.ApiException
- if the schema could not be changed.Response setSchema(com.ibm.broker.rest.schema.Schema schema)
schema
- the desired Schema.