org.wso2.apimgt.gateway.cli.model.rest

Class APIInfoBaseDTO

java.lang.Object

org.wso2.apimgt.gateway.cli.model.rest.APIInfoBaseDTO

Direct Known Subclasses:

Apim3xApiDto, Apim4xApiDto

public class APIInfoBaseDTO
extends Object

Base DTO object for APIM 3.x and APIM 4.x API objects

Constructor Summary

Constructors

Constructor and Description
APIInfoBaseDTO()

Method Summary

Modifier and Type	Method and Description
List<String>	getAccessControlRoles() The user roles that are able to view/modify as APIDetailedDTO publisher or creator.
String	getApiDefinition() Swagger definition of the APIDetailedDTO which contains details about URI templates and scopes.
String	getApiLevelPolicy()
String	getAuthorizationHeader() * The authorization header of the API.
APIBusinessInformationDTO	getBusinessInformation()
Integer	getCacheTimeout()
String	getContext() A string that represents the context of the user's request.
APICorsConfigurationDTO	getCorsConfiguration()
String	getDescription() A brief description about the APIDetailedDTO.
String	getEndpointConfigStr()
APIEndpointSecurityDTO	getEndpointSecurity()
String	getId() UUID of the api registry artifact.
Boolean	getIsDefaultVersion()
APIMaxTpsDTO	getMaxTps()
String	getName() Name of the APIDetailedDTO.
String	getProvider() If the provider value is not given, the user invoking the APIDetailedDTO will be used as the provider.
String	getResponseCaching()
List<String>	getSubscriptionAvailableTenants()
List<String>	getTags() Search keywords related to the APIDetailedDTO.
List<String>	getTransport() Supported transports for the APIDetailedDTO (http and/or https).
String	getVersion() The version of the APIDetailedDTO.
List<String>	getVisibleRoles() The user roles that are able to access the APIDetailedDTO.
List<String>	getVisibleTenants()
void	setAccessControlRoles(List<String> accessControlRoles)
void	setApiDefinition(String apiDefinition)
void	setApiLevelPolicy(String apiLevelPolicy)
void	setAuthorizationHeader(String authorizationHeader)
void	setBusinessInformation(APIBusinessInformationDTO businessInformation)
void	setCacheTimeout(Integer cacheTimeout)
void	setContext(String context)
void	setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)
void	setDefaultVersion(Boolean defaultVersion)
void	setDescription(String description)
void	setEndpointConfigStr(String endpointConfig)
void	setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)
void	setId(String id)
void	setMaxTps(APIMaxTpsDTO maxTps)
void	setName(String name)
void	setProvider(String provider)
void	setResponseCaching(String responseCaching)
void	setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
void	setTags(List<String> tags)
void	setTransport(List<String> transport)
void	setVersion(String version)
void	setVisibleRoles(List<String> visibleRoles)
void	setVisibleTenants(List<String> visibleTenants)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIInfoBaseDTO

public APIInfoBaseDTO()

Method Detail

getId

public String getId()

UUID of the api registry artifact.

setId

public void setId(String id)

getName

public String getName()

Name of the APIDetailedDTO.

setName

public void setName(String name)

getDescription

public String getDescription()

A brief description about the APIDetailedDTO.

setDescription

public void setDescription(String description)

getContext

public String getContext()

A string that represents the context of the user's request.

setContext

public void setContext(String context)

getVersion

public String getVersion()

The version of the APIDetailedDTO.

setVersion

public void setVersion(String version)

getProvider

public String getProvider()

If the provider value is not given, the user invoking the APIDetailedDTO will be used as the provider.

setProvider

public void setProvider(String provider)

getCacheTimeout

public Integer getCacheTimeout()

setCacheTimeout

public void setCacheTimeout(Integer cacheTimeout)

getIsDefaultVersion

public Boolean getIsDefaultVersion()

setDefaultVersion

public void setDefaultVersion(Boolean defaultVersion)

getTransport

public List<String> getTransport()

Supported transports for the APIDetailedDTO (http and/or https).

setTransport

public void setTransport(List<String> transport)

getTags

public List<String> getTags()

Search keywords related to the APIDetailedDTO.

setTags

public void setTags(List<String> tags)

getAuthorizationHeader

public String getAuthorizationHeader()

* The authorization header of the API.

setAuthorizationHeader

public void setAuthorizationHeader(String authorizationHeader)

getMaxTps

public APIMaxTpsDTO getMaxTps()

setMaxTps

public void setMaxTps(APIMaxTpsDTO maxTps)

getVisibleRoles

public List<String> getVisibleRoles()

The user roles that are able to access the APIDetailedDTO.

setVisibleRoles

public void setVisibleRoles(List<String> visibleRoles)

getVisibleTenants

public List<String> getVisibleTenants()

setVisibleTenants

public void setVisibleTenants(List<String> visibleTenants)

getSubscriptionAvailableTenants

public List<String> getSubscriptionAvailableTenants()

setSubscriptionAvailableTenants

public void setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

getAccessControlRoles

public List<String> getAccessControlRoles()

The user roles that are able to view/modify as APIDetailedDTO publisher or creator.

setAccessControlRoles

public void setAccessControlRoles(List<String> accessControlRoles)

getBusinessInformation

public APIBusinessInformationDTO getBusinessInformation()

setBusinessInformation

public void setBusinessInformation(APIBusinessInformationDTO businessInformation)

getCorsConfiguration

public APICorsConfigurationDTO getCorsConfiguration()

setCorsConfiguration

public void setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)

getApiDefinition

public String getApiDefinition()

Swagger definition of the APIDetailedDTO which contains details about URI templates and scopes.

setApiDefinition

public void setApiDefinition(String apiDefinition)

getApiLevelPolicy

public String getApiLevelPolicy()

setApiLevelPolicy

public void setApiLevelPolicy(String apiLevelPolicy)

getResponseCaching

public String getResponseCaching()

setResponseCaching

public void setResponseCaching(String responseCaching)

getEndpointConfigStr

public String getEndpointConfigStr()

setEndpointConfigStr

public void setEndpointConfigStr(String endpointConfig)

getEndpointSecurity

public APIEndpointSecurityDTO getEndpointSecurity()

setEndpointSecurity

public void setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)