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 Description static classAPIProductDTO.AccessControlEnumDefines whether the API Product is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.static classAPIProductDTO.ApiTypeEnumThe API type to be used.static classAPIProductDTO.SubscriptionAvailabilityEnumThe subscription availability.static classAPIProductDTO.VisibilityEnumThe visibility level of the API.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description APIProductDTO()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NAME
public static final String SERIALIZED_NAME_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CONTEXT
public static final String SERIALIZED_NAME_CONTEXT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DESCRIPTION
public static final String SERIALIZED_NAME_DESCRIPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROVIDER
public static final String SERIALIZED_NAME_PROVIDER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_HAS_THUMBNAIL
public static final String SERIALIZED_NAME_HAS_THUMBNAIL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATE
public static final String SERIALIZED_NAME_STATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_SCHEMA_VALIDATION
public static final String SERIALIZED_NAME_ENABLE_SCHEMA_VALIDATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_REVISION
public static final String SERIALIZED_NAME_IS_REVISION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REVISIONED_API_PRODUCT_ID
public static final String SERIALIZED_NAME_REVISIONED_API_PRODUCT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REVISION_ID
public static final String SERIALIZED_NAME_REVISION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_RESPONSE_CACHING_ENABLED
public static final String SERIALIZED_NAME_RESPONSE_CACHING_ENABLED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CACHE_TIMEOUT
public static final String SERIALIZED_NAME_CACHE_TIMEOUT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VISIBILITY
public static final String SERIALIZED_NAME_VISIBILITY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VISIBLE_ROLES
public static final String SERIALIZED_NAME_VISIBLE_ROLES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VISIBLE_TENANTS
public static final String SERIALIZED_NAME_VISIBLE_TENANTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCESS_CONTROL
public static final String SERIALIZED_NAME_ACCESS_CONTROL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCESS_CONTROL_ROLES
public static final String SERIALIZED_NAME_ACCESS_CONTROL_ROLES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_API_TYPE
public static final String SERIALIZED_NAME_API_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRANSPORT
public static final String SERIALIZED_NAME_TRANSPORT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TAGS
public static final String SERIALIZED_NAME_TAGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_POLICIES
public static final String SERIALIZED_NAME_POLICIES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_API_THROTTLING_POLICY
public static final String SERIALIZED_NAME_API_THROTTLING_POLICY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_AUTHORIZATION_HEADER
public static final String SERIALIZED_NAME_AUTHORIZATION_HEADER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SECURITY_SCHEME
public static final String SERIALIZED_NAME_SECURITY_SCHEME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SUBSCRIPTION_AVAILABILITY
public static final String SERIALIZED_NAME_SUBSCRIPTION_AVAILABILITY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SUBSCRIPTION_AVAILABLE_TENANTS
public static final String SERIALIZED_NAME_SUBSCRIPTION_AVAILABLE_TENANTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ADDITIONAL_PROPERTIES
public static final String SERIALIZED_NAME_ADDITIONAL_PROPERTIES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ADDITIONAL_PROPERTIES_MAP
public static final String SERIALIZED_NAME_ADDITIONAL_PROPERTIES_MAP
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MONETIZATION
public static final String SERIALIZED_NAME_MONETIZATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BUSINESS_INFORMATION
public static final String SERIALIZED_NAME_BUSINESS_INFORMATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CORS_CONFIGURATION
public static final String SERIALIZED_NAME_CORS_CONFIGURATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CREATED_TIME
public static final String SERIALIZED_NAME_CREATED_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_UPDATED_TIME
public static final String SERIALIZED_NAME_LAST_UPDATED_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_GATEWAY_VENDOR
public static final String SERIALIZED_NAME_GATEWAY_VENDOR
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_APIS
public static final String SERIALIZED_NAME_APIS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SCOPES
public static final String SERIALIZED_NAME_SCOPES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CATEGORIES
public static final String SERIALIZED_NAME_CATEGORIES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_WORKFLOW_STATUS
public static final String SERIALIZED_NAME_WORKFLOW_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
id
public APIProductDTO id(String 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)
-
setContext
public void setContext(String context)
-
description
public APIProductDTO description(String description)
-
getDescription
@Nullable public String getDescription()
A brief description about the API- Returns:
- description
-
setDescription
public void setDescription(String description)
-
provider
public APIProductDTO provider(String provider)
-
getProvider
@Nullable 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)
-
setHasThumbnail
public void setHasThumbnail(Boolean hasThumbnail)
-
state
public APIProductDTO state(String state)
-
getState
@Nullable public String getState()
State of the API product. Only published api products are visible on the Developer Portal- Returns:
- state
-
setState
public void setState(String state)
-
enableSchemaValidation
public APIProductDTO enableSchemaValidation(Boolean enableSchemaValidation)
-
isEnableSchemaValidation
@Nullable public Boolean isEnableSchemaValidation()
Get enableSchemaValidation- Returns:
- enableSchemaValidation
-
setEnableSchemaValidation
public void setEnableSchemaValidation(Boolean enableSchemaValidation)
-
isRevision
public APIProductDTO isRevision(Boolean isRevision)
-
setIsRevision
public void setIsRevision(Boolean isRevision)
-
revisionedApiProductId
public APIProductDTO revisionedApiProductId(String revisionedApiProductId)
-
getRevisionedApiProductId
@Nullable public String getRevisionedApiProductId()
UUID of the api product registry artifact- Returns:
- revisionedApiProductId
-
setRevisionedApiProductId
public void setRevisionedApiProductId(String revisionedApiProductId)
-
revisionId
public APIProductDTO revisionId(Integer revisionId)
-
setRevisionId
public void setRevisionId(Integer revisionId)
-
responseCachingEnabled
public APIProductDTO responseCachingEnabled(Boolean responseCachingEnabled)
-
isResponseCachingEnabled
@Nullable public Boolean isResponseCachingEnabled()
Get responseCachingEnabled- Returns:
- responseCachingEnabled
-
setResponseCachingEnabled
public void setResponseCachingEnabled(Boolean responseCachingEnabled)
-
cacheTimeout
public APIProductDTO cacheTimeout(Integer cacheTimeout)
-
setCacheTimeout
public void setCacheTimeout(Integer cacheTimeout)
-
visibility
public APIProductDTO visibility(APIProductDTO.VisibilityEnum visibility)
-
getVisibility
@Nullable 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)
-
getVisibleRoles
@Nullable public List<String> getVisibleRoles()
The user roles that are able to access the API- Returns:
- visibleRoles
-
visibleTenants
public APIProductDTO visibleTenants(List<String> visibleTenants)
-
getVisibleTenants
@Nullable public List<String> getVisibleTenants()
Get visibleTenants- Returns:
- visibleTenants
-
accessControl
public APIProductDTO accessControl(APIProductDTO.AccessControlEnum accessControl)
-
getAccessControl
@Nullable 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)
-
getAccessControlRoles
@Nullable public List<String> getAccessControlRoles()
The user roles that are able to view/modify as API Product publisher or creator.- Returns:
- accessControlRoles
-
apiType
public APIProductDTO apiType(APIProductDTO.ApiTypeEnum apiType)
-
getApiType
@Nullable public APIProductDTO.ApiTypeEnum getApiType()
The API type to be used. Accepted values are API, APIPRODUCT- Returns:
- apiType
-
setApiType
public void setApiType(APIProductDTO.ApiTypeEnum apiType)
-
transport
public APIProductDTO transport(List<String> transport)
-
getTransport
@Nullable public List<String> getTransport()
Supported transports for the API (http and/or https).- Returns:
- transport
-
tags
public APIProductDTO tags(List<String> tags)
-
policies
public APIProductDTO policies(List<String> policies)
-
apiThrottlingPolicy
public APIProductDTO apiThrottlingPolicy(String apiThrottlingPolicy)
-
getApiThrottlingPolicy
@Nullable 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
@Nullable 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)
-
getSecurityScheme
@Nullable 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
-
subscriptionAvailability
public APIProductDTO subscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
-
getSubscriptionAvailability
@Nullable 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)
-
getSubscriptionAvailableTenants
@Nullable public List<String> getSubscriptionAvailableTenants()
Get subscriptionAvailableTenants- Returns:
- subscriptionAvailableTenants
-
setSubscriptionAvailableTenants
public void setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
-
additionalProperties
public APIProductDTO additionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties)
-
getAdditionalProperties
@Nullable public List<APIInfoAdditionalPropertiesDTO> getAdditionalProperties()
Map of custom properties of API- Returns:
- additionalProperties
-
setAdditionalProperties
public void setAdditionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties)
-
additionalPropertiesMap
public APIProductDTO additionalPropertiesMap(Map<String,APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap)
-
getAdditionalPropertiesMap
@Nullable public Map<String,APIInfoAdditionalPropertiesMapDTO> getAdditionalPropertiesMap()
Get additionalPropertiesMap- Returns:
- additionalPropertiesMap
-
setAdditionalPropertiesMap
public void setAdditionalPropertiesMap(Map<String,APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap)
-
monetization
public APIProductDTO monetization(APIMonetizationInfoDTO monetization)
-
getMonetization
@Nullable public APIMonetizationInfoDTO getMonetization()
Get monetization- Returns:
- monetization
-
setMonetization
public void setMonetization(APIMonetizationInfoDTO monetization)
-
businessInformation
public APIProductDTO businessInformation(APIProductBusinessInformationDTO businessInformation)
-
getBusinessInformation
@Nullable public APIProductBusinessInformationDTO getBusinessInformation()
Get businessInformation- Returns:
- businessInformation
-
setBusinessInformation
public void setBusinessInformation(APIProductBusinessInformationDTO businessInformation)
-
corsConfiguration
public APIProductDTO corsConfiguration(APICorsConfigurationDTO corsConfiguration)
-
getCorsConfiguration
@Nullable public APICorsConfigurationDTO getCorsConfiguration()
Get corsConfiguration- Returns:
- corsConfiguration
-
setCorsConfiguration
public void setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)
-
createdTime
public APIProductDTO createdTime(String createdTime)
-
setCreatedTime
public void setCreatedTime(String createdTime)
-
lastUpdatedTime
public APIProductDTO lastUpdatedTime(String lastUpdatedTime)
-
getLastUpdatedTime
@Nullable public String getLastUpdatedTime()
Get lastUpdatedTime- Returns:
- lastUpdatedTime
-
setLastUpdatedTime
public void setLastUpdatedTime(String lastUpdatedTime)
-
gatewayVendor
public APIProductDTO gatewayVendor(String gatewayVendor)
-
getGatewayVendor
@Nullable public String getGatewayVendor()
Get gatewayVendor- Returns:
- gatewayVendor
-
setGatewayVendor
public void setGatewayVendor(String gatewayVendor)
-
apis
public APIProductDTO apis(List<ProductAPIDTO> apis)
-
getApis
@Nullable 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)
-
getScopes
@Nullable public List<APIScopeDTO> getScopes()
Get scopes- Returns:
- scopes
-
setScopes
public void setScopes(List<APIScopeDTO> scopes)
-
categories
public APIProductDTO categories(List<String> categories)
-
workflowStatus
public APIProductDTO workflowStatus(String workflowStatus)
-
getWorkflowStatus
@Nullable public String getWorkflowStatus()
Get workflowStatus- Returns:
- workflowStatus
-
setWorkflowStatus
public void setWorkflowStatus(String workflowStatus)
-
-