Operation (Apache Juneau 7.1.1)

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

```
@Bean(properties="operationId,summary,description,tags,externalDocs,consumes,produces,parameters,responses,schemes,deprecated,security,*")
public class Operation
extends SwaggerElement
```
Describes a single API operation on a path.
Example:

// Construct using SwaggerBuilder. Operation x = operation() .tags("pet") .summary("Updates a pet in the store with form data") .description("") .operationId("updatePetWithForm") .consumes("application/x-www-form-urlencoded") .produces("application/json", "application/xml") .parameters( parameter() .name("petId") .in("path") .description("ID of pet that needs to be updated") .required(true) .type("string"), parameter() .name("name") .in("formData") .description("Updated name of the pet") .required(false) .type("string"), parameter() .name("status") .in("formData") .description("Updated status of the pet") .required(false) .type("string") ) .response(200, responseInfo("Pet updated.")) .response(405, responseInfo("Invalid input.")) .security("petstore_auth", "write:pets", "read:pets"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "tags": [ "pet" ], "summary": "Updates a pet in the store with form data", "description": "", "operationId": "updatePetWithForm", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json", "application/xml" ], "parameters": [ { "name": "petId", "in": "path", "description": "ID of pet that needs to be updated", "required": true, "type": "string" }, { "name": "name", "in": "formData", "description": "Updated name of the pet", "required": false, "type": "string" }, { "name": "status", "in": "formData", "description": "Updated status of the pet", "required": false, "type": "string" } ], "responses": { "200": { "description": "Pet updated." }, "405": { "description": "Invalid input" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

Operation()

Constructors
Constructor and Description
`Operation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Operation`	`addConsumes(Collection<MediaType> value)` Adds one or more values to the consumes property.
`Operation`	`addParameters(Collection<ParameterInfo> value)` Adds one or more values to the parameters property.
`Operation`	`addProduces(Collection<MediaType> value)` Adds one or more values to the produces property.
`Operation`	`addResponses(Map<String,ResponseInfo> values)` Adds one or more values to the responses property.
`Operation`	`addSchemes(Collection<String> value)` Adds one or more values to the schemes property.
`Operation`	`addSecurity(Collection<Map<String,List<String>>> values)` Adds one or more values to the security property.
`Operation`	`addTags(Collection<String> value)` Adds one or more values to the tags property.
`Operation`	`consumes(Object... values)` Adds one or more values to the consumes property.
`Operation`	`deprecated(Object value)` Same as `setDeprecated(Boolean)`.
`Operation`	`description(Object value)` Same as `setDescription(String)`.
`Operation`	`externalDocs(Object value)` Same as `setExternalDocs(ExternalDocumentation)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`List<MediaType>`	`getConsumes()` Bean property getter: consumes.
`Boolean`	`getDeprecated()` Bean property getter: deprecated.
`String`	`getDescription()` Bean property getter: description.
`ExternalDocumentation`	`getExternalDocs()` Bean property getter: externalDocs.
`String`	`getOperationId()` Bean property getter: operationId.
`List<ParameterInfo>`	`getParameters()` Bean property getter: parameters.
`List<MediaType>`	`getProduces()` Bean property getter: produces.
`Map<String,ResponseInfo>`	`getResponses()` Bean property getter: responses.
`List<String>`	`getSchemes()` Bean property getter: schemes.
`List<Map<String,List<String>>>`	`getSecurity()` Bean property getter: security.
`String`	`getSummary()` Bean property getter: summary.
`List<String>`	`getTags()` Bean property getter: tags.
`Operation`	`operationId(Object value)` Same as `setOperationId(String)`.
`Operation`	`parameters(Object... values)` Same as `addParameters(Collection)`.
`Operation`	`produces(Object... values)` Same as `addProduces(Collection)`.
`Operation`	`response(String statusCode, ResponseInfo response)` Adds a single value to the responses property.
`Operation`	`responses(Object... value)` Same as `addResponses(Map)`.
`Operation`	`schemes(Object... values)` Same as `addSchemes(Collection)`.
`Operation`	`securities(Object... value)` Same as `addSecurity(Collection)`.
`Operation`	`security(String scheme, String... alternatives)` Same as `addSecurity(Collection)`.
`Operation`	`set(String property, Object value)` Generic property setter.
`Operation`	`setConsumes(Collection<MediaType> value)` Bean property setter: consumes.
`Operation`	`setDeprecated(Boolean value)` Bean property setter: deprecated.
`Operation`	`setDescription(String value)` Bean property setter: description.
`Operation`	`setExternalDocs(ExternalDocumentation value)` Bean property setter: externalDocs.
`Operation`	`setOperationId(String value)` Bean property setter: operationId.
`Operation`	`setParameters(Collection<ParameterInfo> value)` Bean property setter: parameters.
`Operation`	`setProduces(Collection<MediaType> value)` Bean property setter: produces.
`Operation`	`setResponses(Map<String,ResponseInfo> value)` Bean property setter: responses.
`Operation`	`setSchemes(Collection<String> value)` Bean property setter: schemes.
`Operation`	`setSecurity(Collection<Map<String,List<String>>> value)` Bean property setter: security.
`Operation`	`setSummary(String value)` Bean property setter: summary.
`Operation`	`setTags(Collection<String> value)` Bean property setter: tags.
`Operation`	`summary(Object value)` Same as `setSummary(String)`.
`Operation`	`tags(Object... values)` Same as `addTags(Collection)`.

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
  - Operation
```
public Operation()
```
- Method Detail
  - getTags
```
public List<String> getTags()
```
    Bean property getter: tags.
    A list of tags for API documentation control.
    Tags can be used for logical grouping of operations by resources or any other qualifier.
    
    Returns:
    
    The property value, or null if it is not set.
  - setTags
```
public Operation setTags(Collection<String> value)
```
    Bean property setter: tags.
    A list of tags for API documentation control.
    Tags can be used for logical grouping of operations by resources or any other qualifier.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addTags
```
public Operation addTags(Collection<String> value)
```
    Adds one or more values to the tags property.
    A list of tags for API documentation control.
    Tags can be used for logical grouping of operations by resources or any other qualifier.
    
    Parameters:
    
    value - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - tags
```
public Operation tags(Object... values)
```
    Same as addTags(Collection).
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Collection<String>
    String - JSON array representation of Collection<String>
    Example:
    
    tags("['foo','bar']");
    
    String - Individual values
    Example:
    
    tags("foo", "bar");
    Returns:
    
    This object (for method chaining).
  - getSummary
```
public String getSummary()
```
    Bean property getter: summary.
    A short summary of what the operation does.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSummary
```
public Operation setSummary(String value)
```
    Bean property setter: summary.
    A short summary of what the operation does.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - summary
```
public Operation summary(Object value)
```
    Same as setSummary(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).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A verbose explanation of the operation behavior.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public Operation setDescription(String value)
```
    Bean property setter: description.
    A verbose explanation of the operation behavior.
    
    Parameters:
    
    value - The new value for this property.
    GFM syntax can be used for rich text representation.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public Operation 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().
    GFM syntax can be used for rich text representation.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getExternalDocs
```
public ExternalDocumentation getExternalDocs()
```
    Bean property getter: externalDocs.
    Additional external documentation for this operation.
    
    Returns:
    
    The property value, or null if it is not set.
  - setExternalDocs
```
public Operation setExternalDocs(ExternalDocumentation value)
```
    Bean property setter: externalDocs.
    Additional external documentation for this operation.
    
    Parameters:
    
    value - The values to add to this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - externalDocs
```
public Operation externalDocs(Object value)
```
    Same as setExternalDocs(ExternalDocumentation).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    ExternalDocumentation
    String - JSON object representation of ExternalDocumentation
    Example:
    
    externalDocs("{description:'description',url:'url'}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getOperationId
```
public String getOperationId()
```
    Bean property getter: operationId.
    Unique string used to identify the operation.
    
    Returns:
    
    The property value, or null if it is not set.
  - setOperationId
```
public Operation setOperationId(String value)
```
    Bean property setter: operationId.
    Unique string used to identify the operation.
    
    Parameters:
    
    value - The new value for this property.
    The id MUST be unique among all operations described in the API.
    Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - operationId
```
public Operation operationId(Object value)
```
    Same as setOperationId(String).
    
    Parameters:
    
    value - The new value for this property.
    The id MUST be unique among all operations described in the API.
    Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getConsumes
```
public List<MediaType> getConsumes()
```
    Bean property getter: consumes.
    A list of MIME types the operation can consume.
    This overrides the consumes definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Returns:
    
    The property value, or null if it is not set.
  - setConsumes
```
public Operation setConsumes(Collection<MediaType> value)
```
    Bean property setter: consumes.
    A list of MIME types the operation can consume.
    This overrides the consumes definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Parameters:
    
    value - The new value for this property.
    Values MUST be as described under Mime Types.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addConsumes
```
public Operation addConsumes(Collection<MediaType> value)
```
    Adds one or more values to the consumes property.
    A list of MIME types the operation can consume.
    This overrides the consumes definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Parameters:
    
    value - The values to add to this property.
    Values MUST be as described under Mime Types.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - consumes
```
public Operation consumes(Object... values)
```
    Adds one or more values to the consumes property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    MediaType
    Collection<MediaType|String>
    MediaType[]
    String - JSON array representation of Collection<MediaType>
    Example:
    
    consumes("['text/json']");
    
    String - Individual values
    Example:
    
    consumes("text/json");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getProduces
```
public List<MediaType> getProduces()
```
    Bean property getter: produces.
    A list of MIME types the operation can produce.
    This overrides the produces definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Returns:
    
    The property value, or null if it is not set.
  - setProduces
```
public Operation setProduces(Collection<MediaType> value)
```
    Bean property setter: produces.
    A list of MIME types the operation can produce.
    This overrides the produces definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Parameters:
    
    value - The values to add to this property.
    Value MUST be as described under Mime Types.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addProduces
```
public Operation addProduces(Collection<MediaType> value)
```
    Adds one or more values to the produces property.
    A list of MIME types the operation can produces.
    This overrides the produces definition at the Swagger Object.
    An empty value MAY be used to clear the global definition.
    
    Parameters:
    
    value - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - produces
```
public Operation produces(Object... values)
```
    Same as addProduces(Collection).
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    MediaType
    Collection<MediaType|String>
    MediaType[]
    String - JSON array representation of Collection<MediaType>
    Example:
    
    produces("['text/json']");
    
    String - Individual values
    Example:
    
    produces("text/json");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getParameters
```
public List<ParameterInfo> getParameters()
```
    Bean property getter: parameters.
    A list of parameters that are applicable for this operation.
    Notes:
    - If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it.
    - The list MUST NOT include duplicated parameters.
    - A unique parameter is defined by a combination of a name and location.
    - The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters.
    - There can be one "body" parameter at most.
    Returns:
    
    The property value, or null if it is not set.
  - setParameters
```
public Operation setParameters(Collection<ParameterInfo> value)
```
    Bean property setter: parameters.
    A list of parameters that are applicable for this operation.
    Notes:
    - If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it.
    - The list MUST NOT include duplicated parameters.
    - A unique parameter is defined by a combination of a name and location.
    - The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters.
    - There can be one "body" parameter at most.
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addParameters
```
public Operation addParameters(Collection<ParameterInfo> value)
```
    Adds one or more values to the parameters property.
    A list of parameters that are applicable for this operation.
    Notes:
    - If a parameter is already defined at the Path Item, the new definition will override it, but can never remove it.
    - The list MUST NOT include duplicated parameters.
    - A unique parameter is defined by a combination of a name and location.
    - The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters.
    - There can be one "body" parameter at most.
    Parameters:
    
    value - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - parameters
```
public Operation parameters(Object... values)
```
    Same as addParameters(Collection).
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    ParameterInfo
    Collection<ParameterInfo|String>
    String - JSON array representation of Collection<ParameterInfo>
    Example:
    
    parameters("[{path:'path',id:'id'}]");
    
    String - JSON object representation of ParameterInfo
    Example:
    
    parameters("{path:'path',id:'id'}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getResponses
```
public Map<String,ResponseInfo> getResponses()
```
    Bean property getter: responses.
    The list of possible responses as they are returned from executing this operation.
    
    Returns:
    
    The property value, or null if it is not set.
  - setResponses
```
public Operation setResponses(Map<String,ResponseInfo> value)
```
    Bean property setter: responses.
    The list of possible responses as they are returned from executing this operation.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - addResponses
```
public Operation addResponses(Map<String,ResponseInfo> values)
```
    Adds one or more values to the responses property.
    The list of possible responses as they are returned from executing this operation.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - response
```
public Operation response(String statusCode,
                          ResponseInfo response)
```
    Adds a single value to the responses property.
    
    Parameters:
    
    statusCode - The HTTP status code.
    
    response - The response description.
    
    Returns:
    
    This object (for method chaining).
  - responses
```
public Operation responses(Object... value)
```
    Same as addResponses(Map).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    Map<Integer,ResponseInfo|String>
    String - JSON object representation of Map<Integer,ResponseInfo>
    Example:
    
    responses("{'404':{description:'description',...}}");
    Returns:
    
    This object (for method chaining).
  - getSchemes
```
public List<String> getSchemes()
```
    Bean property getter: schemes.
    The transfer protocol for the operation.
    The value overrides the Swagger Object schemes definition.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSchemes
```
public Operation setSchemes(Collection<String> value)
```
    Bean property setter: schemes.
    The transfer protocol for the operation.
    The value overrides the Swagger Object schemes definition.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "http"
    "https"
    "ws"
    "wss"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - addSchemes
```
public Operation addSchemes(Collection<String> value)
```
    Adds one or more values to the schemes property.
    The transfer protocol for the operation.
    The value overrides the Swagger Object schemes definition.
    
    Parameters:
    
    value - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - schemes
```
public Operation schemes(Object... values)
```
    Same as addSchemes(Collection).
    Parameters:
    values - The new value for this property.
    Valid types:
    
    Collection<String>
    String - JSON array representation of Collection<String>
    Example:
    
    schemes("['scheme1','scheme2']");
    
    String - Individual values
    Example:
    
    schemes("scheme1, "scheme2");
    Returns:
    
    This object (for method chaining).
  - getDeprecated
```
public Boolean getDeprecated()
```
    Bean property getter: deprecated.
    Declares this operation to be deprecated.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDeprecated
```
public Operation setDeprecated(Boolean value)
```
    Bean property setter: deprecated.
    Declares this operation to be deprecated.
    
    Parameters:
    
    value - T The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - deprecated
```
public Operation deprecated(Object value)
```
    Same as setDeprecated(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getSecurity
```
public List<Map<String,List<String>>> getSecurity()
```
    Bean property getter: security.
    A declaration of which security schemes are applied for this operation.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    This definition overrides any declared top-level security.
    To remove a top-level security declaration, an empty array can be used.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSecurity
```
public Operation setSecurity(Collection<Map<String,List<String>>> value)
```
    Bean property setter: security.
    A declaration of which security schemes are applied for this operation.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    This definition overrides any declared top-level security.
    To remove a top-level security declaration, an empty array can be used.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addSecurity
```
public Operation addSecurity(Collection<Map<String,List<String>>> values)
```
    Adds one or more values to the security property.
    A declaration of which security schemes are applied for this operation.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    This definition overrides any declared top-level security.
    To remove a top-level security declaration, an empty array can be used.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null. The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - security
```
public Operation security(String scheme,
                          String... alternatives)
```
    Same as addSecurity(Collection).
    
    Parameters:
    
    scheme - The scheme name.
    
    alternatives - The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    
    Returns:
    
    This object (for method chaining).
  - securities
```
public Operation securities(Object... value)
```
    Same as addSecurity(Collection).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    Map<String,List<String>>
    String - JSON object representation of a Map<String,List<String>>
    Example:
    
    securities("{key:['val1','val2']}");
    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 Operation 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 Operation

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

Operation

Method Detail

getTags

setTags

addTags

tags

Example:

Example:

getSummary

setSummary

summary

getDescription

setDescription

description

getExternalDocs

setExternalDocs

externalDocs

Example:

getOperationId

setOperationId

operationId

getConsumes

setConsumes

addConsumes

consumes

Example:

Example:

getProduces

setProduces

addProduces

produces

Example:

Example:

getParameters

Notes:

setParameters

Notes:

addParameters

Notes:

parameters

Example:

Example:

getResponses

setResponses

addResponses

response

responses

Example:

getSchemes

setSchemes

addSchemes

schemes

Example:

Example:

getDeprecated

setDeprecated

deprecated

getSecurity

setSecurity

addSecurity

security

securities

Example:

get

set