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

Class APIProductDTO

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.dto.APIProductDTO

public class APIProductDTO
extends Object

APIProductDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIProductDTO.AccessControlEnum Defines whether the API Product is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.
static class	APIProductDTO.StateEnum State of the API product.
static class	APIProductDTO.SubscriptionAvailabilityEnum The subscription availability.
static class	APIProductDTO.VisibilityEnum The visibility level of the API.

Constructor Summary

Constructors

Constructor and Description
APIProductDTO()

Method Summary

Modifier and Type	Method and Description
APIProductDTO	accessControl(APIProductDTO.AccessControlEnum accessControl)
APIProductDTO	accessControlRoles(List<String> accessControlRoles)
APIProductDTO	addAccessControlRolesItem(String accessControlRolesItem)
APIProductDTO	addApisItem(ProductAPIDTO apisItem)
APIProductDTO	addCategoriesItem(String categoriesItem)
APIProductDTO	addGatewayEnvironmentsItem(String gatewayEnvironmentsItem)
APIProductDTO	additionalProperties(Map<String,String> additionalProperties)
APIProductDTO	addPoliciesItem(String policiesItem)
APIProductDTO	addScopesItem(APIScopeDTO scopesItem)
APIProductDTO	addSecuritySchemeItem(String securitySchemeItem)
APIProductDTO	addSubscriptionAvailableTenantsItem(String subscriptionAvailableTenantsItem)
APIProductDTO	addTagsItem(String tagsItem)
APIProductDTO	addTransportItem(String transportItem)
APIProductDTO	addVisibleRolesItem(String visibleRolesItem)
APIProductDTO	addVisibleTenantsItem(String visibleTenantsItem)
APIProductDTO	apis(List<ProductAPIDTO> apis)
APIProductDTO	apiThrottlingPolicy(String apiThrottlingPolicy)
APIProductDTO	apiType(String apiType)
APIProductDTO	authorizationHeader(String authorizationHeader)
APIProductDTO	businessInformation(APIProductBusinessInformationDTO businessInformation)
APIProductDTO	cacheTimeout(Integer cacheTimeout)
APIProductDTO	categories(List<String> categories)
APIProductDTO	context(String context)
APIProductDTO	corsConfiguration(APICorsConfigurationDTO corsConfiguration)
APIProductDTO	createdTime(String createdTime)
APIProductDTO	description(String description)
APIProductDTO	enableSchemaValidation(Boolean enableSchemaValidation)
APIProductDTO	enableStore(Boolean enableStore)
boolean	equals(Object o)
APIProductDTO	gatewayEnvironments(List<String> gatewayEnvironments)
APIProductDTO.AccessControlEnum	getAccessControl() Defines whether the API Product is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.
List<String>	getAccessControlRoles() The user roles that are able to view/modify as API Product publisher or creator.
Map<String,String>	getAdditionalProperties() Map of custom properties of API
List<ProductAPIDTO>	getApis() APIs and resources in the API Product.
String	getApiThrottlingPolicy() The API level throttling policy selected for the particular API Product
String	getApiType() The api type to be used.
String	getAuthorizationHeader() Name of the Authorization header used for invoking the API.
APIProductBusinessInformationDTO	getBusinessInformation() Get businessInformation
Integer	getCacheTimeout() Get cacheTimeout
List<String>	getCategories() API categories
String	getContext() Get context
APICorsConfigurationDTO	getCorsConfiguration() Get corsConfiguration
String	getCreatedTime() Get createdTime
String	getDescription() A brief description about the API
List<String>	getGatewayEnvironments() List of gateway environments the API Product is available
String	getId() UUID of the api product
String	getLastUpdatedTime() Get lastUpdatedTime
APIMonetizationInfoDTO	getMonetization() Get monetization
String	getName() Name of the API Product
List<String>	getPolicies() Get policies
String	getProvider() If the provider value is not given, the user invoking the API will be used as the provider.
List<APIScopeDTO>	getScopes() Get scopes
List<String>	getSecurityScheme() Types of API security, the current API secured with.
APIProductDTO.StateEnum	getState() State of the API product.
APIProductDTO.SubscriptionAvailabilityEnum	getSubscriptionAvailability() The subscription availability.
List<String>	getSubscriptionAvailableTenants() Get subscriptionAvailableTenants
List<String>	getTags() Get tags
List<String>	getTransport() Supported transports for the API (http and/or https).
APIProductDTO.VisibilityEnum	getVisibility() The visibility level of the API.
List<String>	getVisibleRoles() The user roles that are able to access the API
List<String>	getVisibleTenants() Get visibleTenants
int	hashCode()
APIProductDTO	hasThumbnail(Boolean hasThumbnail)
APIProductDTO	id(String id)
Boolean	isEnableSchemaValidation() Get enableSchemaValidation
Boolean	isEnableStore() Get enableStore
Boolean	isHasThumbnail() Get hasThumbnail
Boolean	isResponseCachingEnabled() Get responseCachingEnabled
APIProductDTO	lastUpdatedTime(String lastUpdatedTime)
APIProductDTO	monetization(APIMonetizationInfoDTO monetization)
APIProductDTO	name(String name)
APIProductDTO	policies(List<String> policies)
APIProductDTO	provider(String provider)
APIProductDTO	putAdditionalPropertiesItem(String key, String additionalPropertiesItem)
APIProductDTO	responseCachingEnabled(Boolean responseCachingEnabled)
APIProductDTO	scopes(List<APIScopeDTO> scopes)
APIProductDTO	securityScheme(List<String> securityScheme)
void	setAccessControl(APIProductDTO.AccessControlEnum accessControl)
void	setAccessControlRoles(List<String> accessControlRoles)
void	setAdditionalProperties(Map<String,String> additionalProperties)
void	setApis(List<ProductAPIDTO> apis)
void	setApiThrottlingPolicy(String apiThrottlingPolicy)
void	setApiType(String apiType)
void	setAuthorizationHeader(String authorizationHeader)
void	setBusinessInformation(APIProductBusinessInformationDTO businessInformation)
void	setCacheTimeout(Integer cacheTimeout)
void	setCategories(List<String> categories)
void	setContext(String context)
void	setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)
void	setCreatedTime(String createdTime)
void	setDescription(String description)
void	setEnableSchemaValidation(Boolean enableSchemaValidation)
void	setEnableStore(Boolean enableStore)
void	setGatewayEnvironments(List<String> gatewayEnvironments)
void	setHasThumbnail(Boolean hasThumbnail)
void	setId(String id)
void	setLastUpdatedTime(String lastUpdatedTime)
void	setMonetization(APIMonetizationInfoDTO monetization)
void	setName(String name)
void	setPolicies(List<String> policies)
void	setProvider(String provider)
void	setResponseCachingEnabled(Boolean responseCachingEnabled)
void	setScopes(List<APIScopeDTO> scopes)
void	setSecurityScheme(List<String> securityScheme)
void	setState(APIProductDTO.StateEnum state)
void	setSubscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
void	setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
void	setTags(List<String> tags)
void	setTransport(List<String> transport)
void	setVisibility(APIProductDTO.VisibilityEnum visibility)
void	setVisibleRoles(List<String> visibleRoles)
void	setVisibleTenants(List<String> visibleTenants)
APIProductDTO	state(APIProductDTO.StateEnum state)
APIProductDTO	subscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
APIProductDTO	subscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
APIProductDTO	tags(List<String> tags)
String	toString()
APIProductDTO	transport(List<String> transport)
APIProductDTO	visibility(APIProductDTO.VisibilityEnum visibility)
APIProductDTO	visibleRoles(List<String> visibleRoles)
APIProductDTO	visibleTenants(List<String> visibleTenants)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIProductDTO

public APIProductDTO()

Method Detail

id

public APIProductDTO id(String id)

getId

public String getId()

UUID of the api product

Returns:

id

setId

public void setId(String id)

name

public APIProductDTO name(String name)

getName

public String getName()

Name of the API Product

Returns:

name

setName

public void setName(String name)

context

public APIProductDTO context(String context)

getContext

public String getContext()

Get context

Returns:

context

setContext

public void setContext(String context)

description

public APIProductDTO description(String description)

getDescription

public String getDescription()

A brief description about the API

Returns:

description

setDescription

public void setDescription(String description)

provider

public APIProductDTO provider(String provider)

getProvider

public String getProvider()

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

Returns:

provider

setProvider

public void setProvider(String provider)

hasThumbnail

public APIProductDTO hasThumbnail(Boolean hasThumbnail)

isHasThumbnail

public Boolean isHasThumbnail()

Get hasThumbnail

Returns:

hasThumbnail

setHasThumbnail

public void setHasThumbnail(Boolean hasThumbnail)

state

public APIProductDTO state(APIProductDTO.StateEnum state)

getState

public APIProductDTO.StateEnum getState()

State of the API product. Only published api products are visible on the store

Returns:

state

setState

public void setState(APIProductDTO.StateEnum state)

enableSchemaValidation

public APIProductDTO enableSchemaValidation(Boolean enableSchemaValidation)

isEnableSchemaValidation

public Boolean isEnableSchemaValidation()

Get enableSchemaValidation

Returns:

enableSchemaValidation

setEnableSchemaValidation

public void setEnableSchemaValidation(Boolean enableSchemaValidation)

enableStore

public APIProductDTO enableStore(Boolean enableStore)

isEnableStore

public Boolean isEnableStore()

Get enableStore

Returns:

enableStore

setEnableStore

public void setEnableStore(Boolean enableStore)

responseCachingEnabled

public APIProductDTO responseCachingEnabled(Boolean responseCachingEnabled)

isResponseCachingEnabled

public Boolean isResponseCachingEnabled()

Get responseCachingEnabled

Returns:

responseCachingEnabled

setResponseCachingEnabled

public void setResponseCachingEnabled(Boolean responseCachingEnabled)

cacheTimeout

public APIProductDTO cacheTimeout(Integer cacheTimeout)

getCacheTimeout

public Integer getCacheTimeout()

Get cacheTimeout

Returns:

cacheTimeout

setCacheTimeout

public void setCacheTimeout(Integer cacheTimeout)

visibility

public APIProductDTO visibility(APIProductDTO.VisibilityEnum visibility)

getVisibility

public APIProductDTO.VisibilityEnum getVisibility()

The visibility level of the API. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED.

Returns:

visibility

setVisibility

public void setVisibility(APIProductDTO.VisibilityEnum visibility)

visibleRoles

public APIProductDTO visibleRoles(List<String> visibleRoles)

addVisibleRolesItem

public APIProductDTO addVisibleRolesItem(String visibleRolesItem)

getVisibleRoles

public List<String> getVisibleRoles()

The user roles that are able to access the API

Returns:

visibleRoles

setVisibleRoles

public void setVisibleRoles(List<String> visibleRoles)

visibleTenants

public APIProductDTO visibleTenants(List<String> visibleTenants)

addVisibleTenantsItem

public APIProductDTO addVisibleTenantsItem(String visibleTenantsItem)

getVisibleTenants

public List<String> getVisibleTenants()

Get visibleTenants

Returns:

visibleTenants

setVisibleTenants

public void setVisibleTenants(List<String> visibleTenants)

accessControl

public APIProductDTO accessControl(APIProductDTO.AccessControlEnum accessControl)

getAccessControl

public APIProductDTO.AccessControlEnum getAccessControl()

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

Returns:

accessControl

setAccessControl

public void setAccessControl(APIProductDTO.AccessControlEnum accessControl)

accessControlRoles

public APIProductDTO accessControlRoles(List<String> accessControlRoles)

addAccessControlRolesItem

public APIProductDTO addAccessControlRolesItem(String accessControlRolesItem)

getAccessControlRoles

public List<String> getAccessControlRoles()

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

Returns:

accessControlRoles

setAccessControlRoles

public void setAccessControlRoles(List<String> accessControlRoles)

gatewayEnvironments

public APIProductDTO gatewayEnvironments(List<String> gatewayEnvironments)

addGatewayEnvironmentsItem

public APIProductDTO addGatewayEnvironmentsItem(String gatewayEnvironmentsItem)

getGatewayEnvironments

public List<String> getGatewayEnvironments()

List of gateway environments the API Product is available

Returns:

gatewayEnvironments

setGatewayEnvironments

public void setGatewayEnvironments(List<String> gatewayEnvironments)

apiType

public APIProductDTO apiType(String apiType)

getApiType

public String getApiType()

The api type to be used. Accepted values are API, API PRODUCT

Returns:

apiType

setApiType

public void setApiType(String apiType)

transport

public APIProductDTO transport(List<String> transport)

addTransportItem

public APIProductDTO addTransportItem(String transportItem)

getTransport

public List<String> getTransport()

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

Returns:

transport

setTransport

public void setTransport(List<String> transport)

tags

public APIProductDTO tags(List<String> tags)

addTagsItem

public APIProductDTO addTagsItem(String tagsItem)

getTags

public List<String> getTags()

Get tags

Returns:

tags

setTags

public void setTags(List<String> tags)

policies

public APIProductDTO policies(List<String> policies)

addPoliciesItem

public APIProductDTO addPoliciesItem(String policiesItem)

getPolicies

public List<String> getPolicies()

Get policies

Returns:

policies

setPolicies

public void setPolicies(List<String> policies)

apiThrottlingPolicy

public APIProductDTO apiThrottlingPolicy(String apiThrottlingPolicy)

getApiThrottlingPolicy

public String getApiThrottlingPolicy()

The API level throttling policy selected for the particular API Product

Returns:

apiThrottlingPolicy

setApiThrottlingPolicy

public void setApiThrottlingPolicy(String apiThrottlingPolicy)

authorizationHeader

public APIProductDTO 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 APIProductDTO securityScheme(List<String> securityScheme)

addSecuritySchemeItem

public APIProductDTO 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)

subscriptionAvailability

public APIProductDTO subscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)

getSubscriptionAvailability

public APIProductDTO.SubscriptionAvailabilityEnum getSubscriptionAvailability()

The subscription availability. Accepts one of the following. CURRENT_TENANT, ALL_TENANTS or SPECIFIC_TENANTS.

Returns:

subscriptionAvailability

setSubscriptionAvailability

public void setSubscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)

subscriptionAvailableTenants

public APIProductDTO subscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

addSubscriptionAvailableTenantsItem

public APIProductDTO addSubscriptionAvailableTenantsItem(String subscriptionAvailableTenantsItem)

getSubscriptionAvailableTenants

public List<String> getSubscriptionAvailableTenants()

Get subscriptionAvailableTenants

Returns:

subscriptionAvailableTenants

setSubscriptionAvailableTenants

public void setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

additionalProperties

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

putAdditionalPropertiesItem

public APIProductDTO putAdditionalPropertiesItem(String key,
                                                 String additionalPropertiesItem)

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Map of custom properties of API

Returns:

additionalProperties

setAdditionalProperties

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

monetization

public APIProductDTO monetization(APIMonetizationInfoDTO monetization)

getMonetization

public APIMonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(APIMonetizationInfoDTO monetization)

businessInformation

public APIProductDTO businessInformation(APIProductBusinessInformationDTO businessInformation)

getBusinessInformation

public APIProductBusinessInformationDTO getBusinessInformation()

Get businessInformation

Returns:

businessInformation

setBusinessInformation

public void setBusinessInformation(APIProductBusinessInformationDTO businessInformation)

corsConfiguration

public APIProductDTO corsConfiguration(APICorsConfigurationDTO corsConfiguration)

getCorsConfiguration

public APICorsConfigurationDTO getCorsConfiguration()

Get corsConfiguration

Returns:

corsConfiguration

setCorsConfiguration

public void setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)

createdTime

public APIProductDTO createdTime(String createdTime)

getCreatedTime

public String getCreatedTime()

Get createdTime

Returns:

createdTime

setCreatedTime

public void setCreatedTime(String createdTime)

lastUpdatedTime

public APIProductDTO lastUpdatedTime(String lastUpdatedTime)

getLastUpdatedTime

public String getLastUpdatedTime()

Get lastUpdatedTime

Returns:

lastUpdatedTime

setLastUpdatedTime

public void setLastUpdatedTime(String lastUpdatedTime)

apis

public APIProductDTO apis(List<ProductAPIDTO> apis)

addApisItem

public APIProductDTO addApisItem(ProductAPIDTO apisItem)

getApis

public List<ProductAPIDTO> getApis()

APIs and resources in the API Product.

Returns:

apis

setApis

public void setApis(List<ProductAPIDTO> apis)

scopes

public APIProductDTO scopes(List<APIScopeDTO> scopes)

addScopesItem

public APIProductDTO addScopesItem(APIScopeDTO scopesItem)

getScopes

public List<APIScopeDTO> getScopes()

Get scopes

Returns:

scopes

setScopes

public void setScopes(List<APIScopeDTO> scopes)

categories

public APIProductDTO categories(List<String> categories)

addCategoriesItem

public APIProductDTO addCategoriesItem(String categoriesItem)

getCategories

public List<String> getCategories()

API categories

Returns:

categories

setCategories

public void setCategories(List<String> categories)

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