Package org.forgerock.api.transform

Class LocalizableOperation

java.lang.Object

io.swagger.v3.oas.models.Operation

org.forgerock.api.transform.LocalizableOperation

public class LocalizableOperation
extends io.swagger.v3.oas.models.Operation

Localizable Operation.

Constructor Summary

Constructors

Constructor	Description
LocalizableOperation()

Method Summary

Modifier and Type	Method	Description
void	addTag(LocalizableString tag)	Adds a Tag, a String value that is metadata related to the Operation.
io.swagger.v3.oas.models.Operation	addTagsItem(String tag)
LocalizableOperation	description(String description)
LocalizableOperation	description(LocalizableString desc)
String	getDescription()
LocalizableString	getLocalizableDescription()
List<LocalizableString>	getLocalizableTags()	Returns the localizable tags for this operation.
List<String>	getTags()
void	setDescription(String description)
void	setTags(List<String> tags)
void	setVendorExtension(String name, Object value)	Sets a vendor extension on this operation.

Methods inherited from class io.swagger.v3.oas.models.Operation

addCallback, addExtension, addExtension31, addParametersItem, addSecurityItem, addServersItem, callbacks, deprecated, equals, extensions, externalDocs, getCallbacks, getDeprecated, getExtensions, getExternalDocs, getOperationId, getParameters, getRequestBody, getResponses, getSecurity, getServers, getSummary, hashCode, operationId, parameters, requestBody, responses, security, servers, setCallbacks, setDeprecated, setExtensions, setExternalDocs, setOperationId, setParameters, setRequestBody, setResponses, setSecurity, setServers, setSummary, summary, tags, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LocalizableOperation

public LocalizableOperation()

Method Details

description

public LocalizableOperation description(LocalizableString desc)

description

public LocalizableOperation description(String description)

Overrides:

description in class io.swagger.v3.oas.models.Operation

setDescription

public void setDescription(String description)

Overrides:

setDescription in class io.swagger.v3.oas.models.Operation

getLocalizableDescription

public LocalizableString getLocalizableDescription()

getDescription

public String getDescription()

Overrides:

getDescription in class io.swagger.v3.oas.models.Operation

addTagsItem

public io.swagger.v3.oas.models.Operation addTagsItem(String tag)

Overrides:

addTagsItem in class io.swagger.v3.oas.models.Operation

addTag

public void addTag(LocalizableString tag)

Adds a Tag, a String value that is metadata related to the Operation.

Parameters:

tag - a LocalizableString

setTags

public void setTags(List<String> tags)

Overrides:

setTags in class io.swagger.v3.oas.models.Operation

getLocalizableTags

public List<LocalizableString> getLocalizableTags()

Returns the localizable tags for this operation.

Returns:

the localizable tags for this operation

getTags

public List<String> getTags()

Overrides:

getTags in class io.swagger.v3.oas.models.Operation

setVendorExtension

public void setVendorExtension(String name,
 Object value)

Sets a vendor extension on this operation.

Parameters:

name - Extension name (must start with "x-").

value - Extension value.