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

Class APIDetailedDTO

java.lang.Object

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

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

Direct Known Subclasses:

ExtendedAPI

public class APIDetailedDTO
extends APIInfoDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIDetailedDTO.AccessControlEnum
static class	APIDetailedDTO.SubscriptionAvailabilityEnum
static class	APIDetailedDTO.TypeEnum
static class	APIDetailedDTO.VisibilityEnum

Constructor Summary

Constructors

Constructor and Description
APIDetailedDTO()

Method Summary

Modifier and Type	Method and Description
APIDetailedDTO.AccessControlEnum	getAccessControl() Is the API is restricted to certain set of publishers or creators or is it visible to all the\npublishers and creators.
List<String>	getAccessControlRoles() The user roles that are able to view/modify as APIDetailedDTO publisher or creator.
Map<String,String>	getAdditionalProperties() Map of custom properties of APIDetailedDTO
String	getApiDefinition() Swagger definition of the APIDetailedDTO which contains details about URI templates and scopes\n
String	getApiLevelPolicy() The policy selected for the particular APIDetailedDTO
String	getApiSecurity() Type of API security, the current API secured with.
com.google.gson.JsonObject	getApiSwagger()
String	getAuthorizationHeader() * The authorization header of the API
APIBusinessInformationDTO	getBusinessInformation()
Integer	getCacheTimeout()
APICorsConfigurationDTO	getCorsConfiguration()
String	getDestinationStatsEnabled()
String	getEndpointConfig()
APIEndpointSecurityDTO	getEndpointSecurity()
String	getGatewayEnvironments() Comma separated list of gateway environments.\n
Boolean	getIsDefaultVersion()
List<LabelDTO>	getLabels() Labels of micro-gateway environments attached to the APIDetailedDTO.\n
APIMaxTpsDTO	getMaxTps()
String	getResponseCaching()
List<SequenceDTO>	getSequences()
APIDetailedDTO.SubscriptionAvailabilityEnum	getSubscriptionAvailability() The subscription availability.
List<String>	getSubscriptionAvailableTenants()
List<String>	getTags() Search keywords related to the APIDetailedDTO
List<String>	getTiers() The subscription tiers selected for the particular APIDetailedDTO
List<String>	getTransport() Supported transports for the APIDetailedDTO (http and/or https).\n
APIDetailedDTO.TypeEnum	getType() The transport to be set.
APIDetailedDTO.VisibilityEnum	getVisibility() The visibility level of the APIDetailedDTO.
List<String>	getVisibleRoles() The user roles that are able to access the APIDetailedDTO
List<String>	getVisibleTenants()
String	getWsdlUri() WSDL URL if the APIDetailedDTO is based on a WSDL endpoint\n
void	setAccessControl(APIDetailedDTO.AccessControlEnum accessControl)
void	setAccessControlRoles(List<String> accessControlRoles)
void	setAdditionalProperties(Map<String,String> additionalProperties)
void	setApiDefinition(String apiDefinition)
void	setApiLevelPolicy(String apiLevelPolicy)
void	setApiSecurity(String apiSecurity)
void	setApiSwagger(io.swagger.util.Json apiSwagger)
void	setAuthorizationHeader(String authorizationHeader)
void	setBusinessInformation(APIBusinessInformationDTO businessInformation)
void	setCacheTimeout(Integer cacheTimeout)
void	setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)
void	setDestinationStatsEnabled(String destinationStatsEnabled)
void	setEndpointConfig(String endpointConfig)
void	setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)
void	setGatewayEnvironments(String gatewayEnvironments)
void	setIsDefaultVersion(Boolean isDefaultVersion)
void	setLabels(List<LabelDTO> labels)
void	setMaxTps(APIMaxTpsDTO maxTps)
void	setResponseCaching(String responseCaching)
void	setSequences(List<SequenceDTO> sequences)
void	setSubscriptionAvailability(APIDetailedDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
void	setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
void	setTags(List<String> tags)
void	setTiers(List<String> tiers)
void	setTransport(List<String> transport)
void	setType(APIDetailedDTO.TypeEnum type)
void	setVisibility(APIDetailedDTO.VisibilityEnum visibility)
void	setVisibleRoles(List<String> visibleRoles)
void	setVisibleTenants(List<String> visibleTenants)
void	setWsdlUri(String wsdlUri)

Methods inherited from class org.wso2.apimgt.gateway.cli.model.rest.APIInfoDTO

getContext, getDescription, getId, getName, getProvider, getStatus, getThumbnailUri, getVersion, setContext, setDescription, setId, setName, setProvider, setStatus, setThumbnailUri, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

APIDetailedDTO

public APIDetailedDTO()

Method Detail

getApiDefinition

public String getApiDefinition()

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

setApiDefinition

public void setApiDefinition(String apiDefinition)

getWsdlUri

public String getWsdlUri()

WSDL URL if the APIDetailedDTO is based on a WSDL endpoint\n

setWsdlUri

public void setWsdlUri(String wsdlUri)

getResponseCaching

public String getResponseCaching()

setResponseCaching

public void setResponseCaching(String responseCaching)

getCacheTimeout

public Integer getCacheTimeout()

setCacheTimeout

public void setCacheTimeout(Integer cacheTimeout)

getDestinationStatsEnabled

public String getDestinationStatsEnabled()

setDestinationStatsEnabled

public void setDestinationStatsEnabled(String destinationStatsEnabled)

getIsDefaultVersion

public Boolean getIsDefaultVersion()

setIsDefaultVersion

public void setIsDefaultVersion(Boolean isDefaultVersion)

getType

public APIDetailedDTO.TypeEnum getType()

The transport to be set. Accepted values are HTTP, WS

setType

public void setType(APIDetailedDTO.TypeEnum type)

getTransport

public List<String> getTransport()

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

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)

getTiers

public List<String> getTiers()

The subscription tiers selected for the particular APIDetailedDTO

setTiers

public void setTiers(List<String> tiers)

getApiLevelPolicy

public String getApiLevelPolicy()

The policy selected for the particular APIDetailedDTO

setApiLevelPolicy

public void setApiLevelPolicy(String apiLevelPolicy)

getAuthorizationHeader

public String getAuthorizationHeader()

* The authorization header of the API

setAuthorizationHeader

public void setAuthorizationHeader(String authorizationHeader)

getApiSecurity

public String getApiSecurity()

Type of API security, the current API secured with. It can be either OAuth2 or mutual SSL or both. If it is not set OAuth2 will be set as the security for the current API.\n

setApiSecurity

public void setApiSecurity(String apiSecurity)

getMaxTps

public APIMaxTpsDTO getMaxTps()

setMaxTps

public void setMaxTps(APIMaxTpsDTO maxTps)

getVisibility

public APIDetailedDTO.VisibilityEnum getVisibility()

The visibility level of the APIDetailedDTO. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED OR CONTROLLED.

setVisibility

public void setVisibility(APIDetailedDTO.VisibilityEnum visibility)

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)

getEndpointConfig

public String getEndpointConfig()

setEndpointConfig

public void setEndpointConfig(String endpointConfig)

getEndpointSecurity

public APIEndpointSecurityDTO getEndpointSecurity()

setEndpointSecurity

public void setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)

getGatewayEnvironments

public String getGatewayEnvironments()

Comma separated list of gateway environments.\n

setGatewayEnvironments

public void setGatewayEnvironments(String gatewayEnvironments)

getLabels

public List<LabelDTO> getLabels()

Labels of micro-gateway environments attached to the APIDetailedDTO.\n

setLabels

public void setLabels(List<LabelDTO> labels)

getSequences

public List<SequenceDTO> getSequences()

setSequences

public void setSequences(List<SequenceDTO> sequences)

getSubscriptionAvailability

public APIDetailedDTO.SubscriptionAvailabilityEnum getSubscriptionAvailability()

The subscription availability. Accepts one of the following. current_tenant, all_tenants or specific_tenants.

setSubscriptionAvailability

public void setSubscriptionAvailability(APIDetailedDTO.SubscriptionAvailabilityEnum subscriptionAvailability)

getSubscriptionAvailableTenants

public List<String> getSubscriptionAvailableTenants()

setSubscriptionAvailableTenants

public void setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Map of custom properties of APIDetailedDTO

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

getAccessControl

public APIDetailedDTO.AccessControlEnum getAccessControl()

Is the API is restricted to certain set of publishers or creators or is it visible to all the\npublishers and creators. If the accessControl restriction is none, this API can be modified by all the\npublishers and creators, if not it can only be viewable/modifiable by certain set of publishers and creators,\n based on the restriction. \n

setAccessControl

public void setAccessControl(APIDetailedDTO.AccessControlEnum accessControl)

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()

getApiSwagger

public com.google.gson.JsonObject getApiSwagger()

setApiSwagger

public void setApiSwagger(io.swagger.util.Json apiSwagger)

setCorsConfiguration

public void setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)