org.wso2.am.integration.clients.store.api.v1.dto

Class APIDTO

java.lang.Object

org.wso2.am.integration.clients.store.api.v1.dto.APIDTO

public class APIDTO
extends Object

APIDTO

Constructor Summary

Constructors

Constructor and Description
APIDTO()

Method Summary

Modifier and Type	Method and Description
APIDTO	addCategoriesItem(String categoriesItem)
APIDTO	addEndpointURLsItem(APIEndpointURLsDTO endpointURLsItem)
APIDTO	addEnvironmentListItem(String environmentListItem)
APIDTO	addIngressURLsItem(APIIngressURLsDTO ingressURLsItem)
APIDTO	additionalProperties(Map<String,String> additionalProperties)
APIDTO	addLabelsItem(LabelDTO labelsItem)
APIDTO	addOperationsItem(APIOperationsDTO operationsItem)
APIDTO	addScopesItem(ScopeInfoDTO scopesItem)
APIDTO	addSecuritySchemeItem(String securitySchemeItem)
APIDTO	addTagsItem(String tagsItem)
APIDTO	addTiersItem(APITiersDTO tiersItem)
APIDTO	addTransportItem(String transportItem)
APIDTO	advertiseInfo(AdvertiseInfoDTO advertiseInfo)
APIDTO	apiDefinition(String apiDefinition)
APIDTO	authorizationHeader(String authorizationHeader)
APIDTO	avgRating(String avgRating)
APIDTO	businessInformation(APIBusinessInformationDTO businessInformation)
APIDTO	categories(List<String> categories)
APIDTO	context(String context)
APIDTO	description(String description)
APIDTO	endpointURLs(List<APIEndpointURLsDTO> endpointURLs)
APIDTO	environmentList(List<String> environmentList)
boolean	equals(Object o)
Map<String,String>	getAdditionalProperties() Custom(user defined) properties of API
AdvertiseInfoDTO	getAdvertiseInfo() The advertise info of the API
String	getApiDefinition() Swagger definition of the API which contains details about URI templates and scopes
String	getAuthorizationHeader() Name of the Authorization header used for invoking the API.
String	getAvgRating() The average rating of the API
APIBusinessInformationDTO	getBusinessInformation() Get businessInformation
List<String>	getCategories() API categories
String	getContext() A string that represents thecontext of the user's request
String	getDescription() A brief description about the API
List<APIEndpointURLsDTO>	getEndpointURLs() Get endpointURLs
List<String>	getEnvironmentList() The environment list configured with non empty endpoint URLs for the particular API.
String	getId() UUID of the api
List<APIIngressURLsDTO>	getIngressURLs() Get ingressURLs
Object	getKeyManagers() API Key Managers
List<LabelDTO>	getLabels() Labels of micro-gateway environments attached to the API.
String	getLifeCycleStatus() This describes in which status of the lifecycle the API is.
APIMonetizationInfoDTO	getMonetization() Get monetization
String	getName() Name of the API
List<APIOperationsDTO>	getOperations() Get operations
String	getProvider() If the provider value is not given user invoking the api will be used as the provider.
List<ScopeInfoDTO>	getScopes() Get scopes
List<String>	getSecurityScheme() Types of API security, the current API secured with.
List<String>	getTags() Search keywords related to the API
List<APITiersDTO>	getTiers() The subscription tiers selected for the particular API
List<String>	getTransport() Get transport
String	getType() This describes the transport type of the API
String	getVersion() The version of the API
String	getWsdlUri() WSDL URL if the API is based on a WSDL endpoint
int	hashCode()
APIDTO	hasThumbnail(Boolean hasThumbnail)
APIDTO	id(String id)
APIDTO	ingressURLs(List<APIIngressURLsDTO> ingressURLs)
APIDTO	isDefaultVersion(Boolean isDefaultVersion)
Boolean	isHasThumbnail() Get hasThumbnail
Boolean	isIsDefaultVersion() Get isDefaultVersion
Boolean	isIsSubscriptionAvailable() Get isSubscriptionAvailable
APIDTO	isSubscriptionAvailable(Boolean isSubscriptionAvailable)
APIDTO	keyManagers(Object keyManagers)
APIDTO	labels(List<LabelDTO> labels)
APIDTO	lifeCycleStatus(String lifeCycleStatus)
APIDTO	monetization(APIMonetizationInfoDTO monetization)
APIDTO	name(String name)
APIDTO	operations(List<APIOperationsDTO> operations)
APIDTO	provider(String provider)
APIDTO	putAdditionalPropertiesItem(String key, String additionalPropertiesItem)
APIDTO	scopes(List<ScopeInfoDTO> scopes)
APIDTO	securityScheme(List<String> securityScheme)
void	setAdditionalProperties(Map<String,String> additionalProperties)
void	setAdvertiseInfo(AdvertiseInfoDTO advertiseInfo)
void	setApiDefinition(String apiDefinition)
void	setAuthorizationHeader(String authorizationHeader)
void	setAvgRating(String avgRating)
void	setBusinessInformation(APIBusinessInformationDTO businessInformation)
void	setCategories(List<String> categories)
void	setContext(String context)
void	setDescription(String description)
void	setEndpointURLs(List<APIEndpointURLsDTO> endpointURLs)
void	setEnvironmentList(List<String> environmentList)
void	setHasThumbnail(Boolean hasThumbnail)
void	setId(String id)
void	setIngressURLs(List<APIIngressURLsDTO> ingressURLs)
void	setIsDefaultVersion(Boolean isDefaultVersion)
void	setIsSubscriptionAvailable(Boolean isSubscriptionAvailable)
void	setKeyManagers(Object keyManagers)
void	setLabels(List<LabelDTO> labels)
void	setLifeCycleStatus(String lifeCycleStatus)
void	setMonetization(APIMonetizationInfoDTO monetization)
void	setName(String name)
void	setOperations(List<APIOperationsDTO> operations)
void	setProvider(String provider)
void	setScopes(List<ScopeInfoDTO> scopes)
void	setSecurityScheme(List<String> securityScheme)
void	setTags(List<String> tags)
void	setTiers(List<APITiersDTO> tiers)
void	setTransport(List<String> transport)
void	setType(String type)
void	setVersion(String version)
void	setWsdlUri(String wsdlUri)
APIDTO	tags(List<String> tags)
APIDTO	tiers(List<APITiersDTO> tiers)
String	toString()
APIDTO	transport(List<String> transport)
APIDTO	type(String type)
APIDTO	version(String version)
APIDTO	wsdlUri(String wsdlUri)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIDTO

public APIDTO()

Method Detail

id

public APIDTO id(String id)

getId

public String getId()

UUID of the api

Returns:

id

setId

public void setId(String id)

name

public APIDTO name(String name)

getName

public String getName()

Name of the API

Returns:

name

setName

public void setName(String name)

description

public APIDTO description(String description)

getDescription

public String getDescription()

A brief description about the API

Returns:

description

setDescription

public void setDescription(String description)

context

public APIDTO context(String context)

getContext

public String getContext()

A string that represents thecontext of the user's request

Returns:

context

setContext

public void setContext(String context)

version

public APIDTO version(String version)

getVersion

public String getVersion()

The version of the API

Returns:

version

setVersion

public void setVersion(String version)

provider

public APIDTO provider(String provider)

getProvider

public String getProvider()

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

Returns:

provider

setProvider

public void setProvider(String provider)

apiDefinition

public APIDTO apiDefinition(String apiDefinition)

getApiDefinition

public String getApiDefinition()

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

Returns:

apiDefinition

setApiDefinition

public void setApiDefinition(String apiDefinition)

wsdlUri

public APIDTO wsdlUri(String wsdlUri)

getWsdlUri

public String getWsdlUri()

WSDL URL if the API is based on a WSDL endpoint

Returns:

wsdlUri

setWsdlUri

public void setWsdlUri(String wsdlUri)

lifeCycleStatus

public APIDTO lifeCycleStatus(String lifeCycleStatus)

getLifeCycleStatus

public String getLifeCycleStatus()

This describes in which status of the lifecycle the API is.

Returns:

lifeCycleStatus

setLifeCycleStatus

public void setLifeCycleStatus(String lifeCycleStatus)

isDefaultVersion

public APIDTO isDefaultVersion(Boolean isDefaultVersion)

isIsDefaultVersion

public Boolean isIsDefaultVersion()

Get isDefaultVersion

Returns:

isDefaultVersion

setIsDefaultVersion

public void setIsDefaultVersion(Boolean isDefaultVersion)

type

public APIDTO type(String type)

getType

public String getType()

This describes the transport type of the API

Returns:

type

setType

public void setType(String type)

transport

public APIDTO transport(List<String> transport)

addTransportItem

public APIDTO addTransportItem(String transportItem)

getTransport

public List<String> getTransport()

Get transport

Returns:

transport

setTransport

public void setTransport(List<String> transport)

operations

public APIDTO operations(List<APIOperationsDTO> operations)

addOperationsItem

public APIDTO addOperationsItem(APIOperationsDTO operationsItem)

getOperations

public List<APIOperationsDTO> getOperations()

Get operations

Returns:

operations

setOperations

public void setOperations(List<APIOperationsDTO> operations)

authorizationHeader

public APIDTO authorizationHeader(String authorizationHeader)

getAuthorizationHeader

public String getAuthorizationHeader()

Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used.

Returns:

authorizationHeader

setAuthorizationHeader

public void setAuthorizationHeader(String authorizationHeader)

securityScheme

public APIDTO securityScheme(List<String> securityScheme)

addSecuritySchemeItem

public APIDTO addSecuritySchemeItem(String securitySchemeItem)

getSecurityScheme

public List<String> getSecurityScheme()

Types 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.

Returns:

securityScheme

setSecurityScheme

public void setSecurityScheme(List<String> securityScheme)

tags

public APIDTO tags(List<String> tags)

addTagsItem

public APIDTO addTagsItem(String tagsItem)

getTags

public List<String> getTags()

Search keywords related to the API

Returns:

tags

setTags

public void setTags(List<String> tags)

tiers

public APIDTO tiers(List<APITiersDTO> tiers)

addTiersItem

public APIDTO addTiersItem(APITiersDTO tiersItem)

getTiers

public List<APITiersDTO> getTiers()

The subscription tiers selected for the particular API

Returns:

tiers

setTiers

public void setTiers(List<APITiersDTO> tiers)

hasThumbnail

public APIDTO hasThumbnail(Boolean hasThumbnail)

isHasThumbnail

public Boolean isHasThumbnail()

Get hasThumbnail

Returns:

hasThumbnail

setHasThumbnail

public void setHasThumbnail(Boolean hasThumbnail)

additionalProperties

public APIDTO additionalProperties(Map<String,String> additionalProperties)

putAdditionalPropertiesItem

public APIDTO putAdditionalPropertiesItem(String key,
                                          String additionalPropertiesItem)

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Custom(user defined) properties of API

Returns:

additionalProperties

setAdditionalProperties

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

monetization

public APIDTO monetization(APIMonetizationInfoDTO monetization)

getMonetization

public APIMonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(APIMonetizationInfoDTO monetization)

ingressURLs

public APIDTO ingressURLs(List<APIIngressURLsDTO> ingressURLs)

addIngressURLsItem

public APIDTO addIngressURLsItem(APIIngressURLsDTO ingressURLsItem)

getIngressURLs

public List<APIIngressURLsDTO> getIngressURLs()

Get ingressURLs

Returns:

ingressURLs

setIngressURLs

public void setIngressURLs(List<APIIngressURLsDTO> ingressURLs)

endpointURLs

public APIDTO endpointURLs(List<APIEndpointURLsDTO> endpointURLs)

addEndpointURLsItem

public APIDTO addEndpointURLsItem(APIEndpointURLsDTO endpointURLsItem)

getEndpointURLs

public List<APIEndpointURLsDTO> getEndpointURLs()

Get endpointURLs

Returns:

endpointURLs

setEndpointURLs

public void setEndpointURLs(List<APIEndpointURLsDTO> endpointURLs)

businessInformation

public APIDTO businessInformation(APIBusinessInformationDTO businessInformation)

getBusinessInformation

public APIBusinessInformationDTO getBusinessInformation()

Get businessInformation

Returns:

businessInformation

setBusinessInformation

public void setBusinessInformation(APIBusinessInformationDTO businessInformation)

labels

public APIDTO labels(List<LabelDTO> labels)

addLabelsItem

public APIDTO addLabelsItem(LabelDTO labelsItem)

getLabels

public List<LabelDTO> getLabels()

Labels of micro-gateway environments attached to the API.

Returns:

labels

setLabels

public void setLabels(List<LabelDTO> labels)

environmentList

public APIDTO environmentList(List<String> environmentList)

addEnvironmentListItem

public APIDTO addEnvironmentListItem(String environmentListItem)

getEnvironmentList

public List<String> getEnvironmentList()

The environment list configured with non empty endpoint URLs for the particular API.

Returns:

environmentList

setEnvironmentList

public void setEnvironmentList(List<String> environmentList)

scopes

public APIDTO scopes(List<ScopeInfoDTO> scopes)

addScopesItem

public APIDTO addScopesItem(ScopeInfoDTO scopesItem)

getScopes

public List<ScopeInfoDTO> getScopes()

Get scopes

Returns:

scopes

setScopes

public void setScopes(List<ScopeInfoDTO> scopes)

avgRating

public APIDTO avgRating(String avgRating)

getAvgRating

public String getAvgRating()

The average rating of the API

Returns:

avgRating

setAvgRating

public void setAvgRating(String avgRating)

advertiseInfo

public APIDTO advertiseInfo(AdvertiseInfoDTO advertiseInfo)

getAdvertiseInfo

public AdvertiseInfoDTO getAdvertiseInfo()

The advertise info of the API

Returns:

advertiseInfo

setAdvertiseInfo

public void setAdvertiseInfo(AdvertiseInfoDTO advertiseInfo)

isSubscriptionAvailable

public APIDTO isSubscriptionAvailable(Boolean isSubscriptionAvailable)

isIsSubscriptionAvailable

public Boolean isIsSubscriptionAvailable()

Get isSubscriptionAvailable

Returns:

isSubscriptionAvailable

setIsSubscriptionAvailable

public void setIsSubscriptionAvailable(Boolean isSubscriptionAvailable)

categories

public APIDTO categories(List<String> categories)

addCategoriesItem

public APIDTO addCategoriesItem(String categoriesItem)

getCategories

public List<String> getCategories()

API categories

Returns:

categories

setCategories

public void setCategories(List<String> categories)

keyManagers

public APIDTO keyManagers(Object keyManagers)

getKeyManagers

public Object getKeyManagers()

API Key Managers

Returns:

keyManagers

setKeyManagers

public void setKeyManagers(Object keyManagers)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object