ResponseInfo (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.ResponseInfo

```
@Bean(properties="description,schema,headers,examples,*")
public class ResponseInfo
extends SwaggerElement
```
Describes a single response from an API Operation.
Example:

// Construct using SwaggerBuilder. ResponseInfo x = responseInfo("A complex object array response") .schema( schemaInfo .type("array") .items( items() .set("$ref", "#/definitions/VeryComplexType") ) ); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "description": "A complex object array response", "schema": { "type": "array", "items": { "$ref": "#/definitions/VeryComplexType" } } }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

ResponseInfo()

Constructors
Constructor and Description
`ResponseInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseInfo`	`addExamples(Map<String,Object> values)` Adds one or more values to the examples property.
`ResponseInfo`	`addHeaders(Map<String,HeaderInfo> values)` Adds one or more values to the headers property.
`ResponseInfo`	`copyFrom(ResponseInfo r)` Copies any non-null fields from the specified object to this object.
`ResponseInfo`	`description(Object value)` Same as `setDescription(String)`.
`ResponseInfo`	`example(String mimeType, Object example)` Adds a single value to the examples property.
`ResponseInfo`	`examples(Object... values)` Adds one or more values to the examples property.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`String`	`getDescription()` Bean property getter: description.
`Map<String,Object>`	`getExamples()` Bean property getter: examples.
`Map<String,HeaderInfo>`	`getHeaders()` Bean property getter: headers.
`SchemaInfo`	`getSchema()` Bean property getter: schema.
`ResponseInfo`	`header(String name, HeaderInfo header)` Adds a single value to the headers property.
`ResponseInfo`	`headers(Object... values)` Adds one or more values to the headers property.
`ResponseInfo`	`schema(Object value)` Same as `setSchema(SchemaInfo)`.
`ResponseInfo`	`set(String property, Object value)` Generic property setter.
`ResponseInfo`	`setDescription(String value)` Bean property setter: description.
`ResponseInfo`	`setExamples(Map<String,Object> value)` Bean property setter: examples.
`ResponseInfo`	`setHeaders(Map<String,HeaderInfo> value)` Bean property setter: headers.
`ResponseInfo`	`setSchema(SchemaInfo value)` Bean property setter: schema.

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement
getExtraProperties, isStrict, strict, strict, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ResponseInfo
```
public ResponseInfo()
```
- Method Detail
  - copyFrom
```
public ResponseInfo copyFrom(ResponseInfo r)
```
    Copies any non-null fields from the specified object to this object.
    
    Parameters:
    
    r - The object to copy fields from.
    Can be null.
    
    Returns:
    
    This object (for method chaining).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A short description of the response.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public ResponseInfo setDescription(String value)
```
    Bean property setter: description.
    A short description of the response.
    
    Parameters:
    
    value - The new value for this property.
    GFM syntax can be used for rich text representation.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public ResponseInfo description(Object value)
```
    Same as setDescription(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getSchema
```
public SchemaInfo getSchema()
```
    Bean property getter: schema.
    A definition of the response structure.
    Notes:
    - If this field does not exist, it means no content is returned as part of the response.
    - As an extension to the Schema Object, its root type value may also be "file".
    - This SHOULD be accompanied by a relevant produces mime-type.
    Returns:
    
    The property value, or null if it is not set.
  - setSchema
```
public ResponseInfo setSchema(SchemaInfo value)
```
    Bean property setter: schema.
    A definition of the response structure.
    Notes:
    - If this field does not exist, it means no content is returned as part of the response.
    - As an extension to the Schema Object, its root type value may also be "file".
    - This SHOULD be accompanied by a relevant produces mime-type.
    Parameters:
    
    value - The new value for this property.
    It can be a primitive, an array or an object.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - schema
```
public ResponseInfo schema(Object value)
```
    Same as setSchema(SchemaInfo).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    SchemaInfo
    String - JSON object representation of SchemaInfo
    Example:
    
    schema("{type:'type',description:'description',...}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getHeaders
```
public Map<String,HeaderInfo> getHeaders()
```
    Bean property getter: headers.
    A list of headers that are sent with the response.
    
    Returns:
    
    The property value, or null if it is not set.
  - setHeaders
```
public ResponseInfo setHeaders(Map<String,HeaderInfo> value)
```
    Bean property setter: headers.
    A list of headers that are sent with the response.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addHeaders
```
public ResponseInfo addHeaders(Map<String,HeaderInfo> values)
```
    Adds one or more values to the headers property.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - header
```
public ResponseInfo header(String name,
                           HeaderInfo header)
```
    Adds a single value to the headers property.
    
    Parameters:
    
    name - The header name.
    
    header - The header descriptions
    
    Returns:
    
    This object (for method chaining).
  - headers
```
public ResponseInfo headers(Object... values)
```
    Adds one or more values to the headers property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,HeaderInfo|String>
    String - JSON object representation of Map<String,HeaderInfo>
    Example:
    
    headers("{headerName:{description:'description',...}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getExamples
```
public Map<String,Object> getExamples()
```
    Bean property getter: examples.
    An example of the response message.
    
    Returns:
    
    The property value, or null if it is not set.
  - setExamples
```
public ResponseInfo setExamples(Map<String,Object> value)
```
    Bean property setter: examples.
    An example of the response message.
    
    Parameters:
    
    value - The new value for this property.
    Keys must be MIME-type strings.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addExamples
```
public ResponseInfo addExamples(Map<String,Object> values)
```
    Adds one or more values to the examples property.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - example
```
public ResponseInfo example(String mimeType,
                            Object example)
```
    Adds a single value to the examples property.
    
    Parameters:
    
    mimeType - The mime-type string.
    
    example - The example.
    
    Returns:
    
    This object (for method chaining).
  - examples
```
public ResponseInfo examples(Object... values)
```
    Adds one or more values to the examples property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,Object>
    String - JSON object representation of Map<String,Object>
    Example:
    
    examples("{'text/json':{foo:'bar'}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - get
```
public <T> T get(String property,
                 Class<T> type)
```
    Description copied from class: SwaggerElement
    
    Generic property getter.
    Can be used to retrieve non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    get in class SwaggerElement
    
    Parameters:
    
    property - The property name to retrieve.
    
    type - The datatype to cast the value to.
    
    Returns:
    
    The property value, or null if the property does not exist or is not set.
  - set
```
public ResponseInfo set(String property,
                        Object value)
```
    Description copied from class: SwaggerElement
    
    Generic property setter.
    Can be used to set non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    set in class SwaggerElement
    
    Parameters:
    
    property - The property name to set.
    
    value - The new value for the property.
    
    Returns:
    
    This object (for method chaining).

Class ResponseInfo

Example:

See Also:

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

Methods inherited from class java.lang.Object

Constructor Detail

ResponseInfo

Method Detail

copyFrom

getDescription

setDescription

description

getSchema

Notes:

setSchema

Notes:

schema

Example:

getHeaders

setHeaders

addHeaders

header

headers

Example:

getExamples

setExamples

addExamples

example

examples

Example:

get

set