org.wso2.apimgt.gateway.cli.model.template.service

Class BallerinaOperation

java.lang.Object

org.wso2.apimgt.gateway.cli.model.template.service.BallerinaOperation

All Implemented Interfaces:

BallerinaSwaggerObject<BallerinaOperation,io.swagger.models.Operation>

public class BallerinaOperation
extends Object
implements BallerinaSwaggerObject<BallerinaOperation,io.swagger.models.Operation>

Wraps the Operation from swagger models to provide iterable child models.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE_NONE
static String	X_AUTH_TYPE
static String	X_SCOPE
static String	X_THROTTLING_TIER

Constructor Summary

Constructors

Constructor and Description
BallerinaOperation()

Method Summary

Modifier and Type	Method and Description
BallerinaOperation	buildContext(io.swagger.models.Operation operation) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaOperation	buildContext(io.swagger.models.Operation operation, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
List<String>	getAllMethods()
BallerinaOperation	getDefaultValue() Retrieve the default value for this type.
String	getDescription()
io.swagger.models.ExternalDocs	getExternalDocs()
List<String>	getMethods()
String	getOperationId()
List<BallerinaParameter>	getParameters()
String	getResourceTier()
String	getScope()
String	getSummary()
List<String>	getTags()
boolean	isSecured()
void	setExternalDocs(io.swagger.models.ExternalDocs externalDocs)
void	setOperationId(String operationId)
void	setResourceTier(String resourceTier)
void	setScope(String scope)
void	setSecured(boolean secured)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

X_THROTTLING_TIER

public static final String X_THROTTLING_TIER

See Also:

Constant Field Values

X_SCOPE

public static final String X_SCOPE

See Also:

Constant Field Values

X_AUTH_TYPE

public static final String X_AUTH_TYPE

See Also:

Constant Field Values

AUTH_TYPE_NONE

public static final String AUTH_TYPE_NONE

See Also:

Constant Field Values

Constructor Detail

BallerinaOperation

public BallerinaOperation()

Method Detail

buildContext

public BallerinaOperation buildContext(io.swagger.models.Operation operation,
                                       ExtendedAPI api)
                                throws BallerinaServiceGenException

Description copied from interface: BallerinaSwaggerObject

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

OpenAPI definition openApi can be used to access the parent context helpful for building the current context

Specified by:

buildContext in interface BallerinaSwaggerObject<BallerinaOperation,io.swagger.models.Operation>

Parameters:

operation - Swagger Api definition or component

api - openApi object model

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

buildContext

public BallerinaOperation buildContext(io.swagger.models.Operation operation)
                                throws BallerinaServiceGenException

Description copied from interface: BallerinaSwaggerObject

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

Specified by:

buildContext in interface BallerinaSwaggerObject<BallerinaOperation,io.swagger.models.Operation>

Parameters:

operation - Open Api definition or component

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

getDefaultValue

public BallerinaOperation getDefaultValue()

Description copied from interface: BallerinaSwaggerObject

Retrieve the default value for this type.

Specified by:

getDefaultValue in interface BallerinaSwaggerObject<BallerinaOperation,io.swagger.models.Operation>

Returns:

default values

getTags

public List<String> getTags()

getSummary

public String getSummary()

getDescription

public String getDescription()

getOperationId

public String getOperationId()

getParameters

public List<BallerinaParameter> getParameters()

setOperationId

public void setOperationId(String operationId)

getMethods

public List<String> getMethods()

getAllMethods

public List<String> getAllMethods()

getExternalDocs

public io.swagger.models.ExternalDocs getExternalDocs()

setExternalDocs

public void setExternalDocs(io.swagger.models.ExternalDocs externalDocs)

getResourceTier

public String getResourceTier()

setResourceTier

public void setResourceTier(String resourceTier)

getScope

public String getScope()

setScope

public void setScope(String scope)

isSecured

public boolean isSecured()

setSecured

public void setSecured(boolean secured)