Package 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	Description
static enum	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 enum	APIProductDTO.ApiTypeEnum	The API type to be used.
static enum	APIProductDTO.SubscriptionAvailabilityEnum	The subscription availability.
static enum	APIProductDTO.VisibilityEnum	The visibility level of the API.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_ACCESS_CONTROL
static final String	SERIALIZED_NAME_ACCESS_CONTROL_ROLES
static final String	SERIALIZED_NAME_ADDITIONAL_PROPERTIES
static final String	SERIALIZED_NAME_ADDITIONAL_PROPERTIES_MAP
static final String	SERIALIZED_NAME_API_KEY_HEADER
static final String	SERIALIZED_NAME_API_THROTTLING_POLICY
static final String	SERIALIZED_NAME_API_TYPE
static final String	SERIALIZED_NAME_APIS
static final String	SERIALIZED_NAME_AUDIENCES
static final String	SERIALIZED_NAME_AUTHORIZATION_HEADER
static final String	SERIALIZED_NAME_BUSINESS_INFORMATION
static final String	SERIALIZED_NAME_CACHE_TIMEOUT
static final String	SERIALIZED_NAME_CATEGORIES
static final String	SERIALIZED_NAME_CONTEXT
static final String	SERIALIZED_NAME_CORS_CONFIGURATION
static final String	SERIALIZED_NAME_CREATED_TIME
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_ENABLE_SCHEMA_VALIDATION
static final String	SERIALIZED_NAME_GATEWAY_VENDOR
static final String	SERIALIZED_NAME_HAS_THUMBNAIL
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_IS_DEFAULT_VERSION
static final String	SERIALIZED_NAME_IS_REVISION
static final String	SERIALIZED_NAME_LAST_UPDATED_TIME
static final String	SERIALIZED_NAME_LAST_UPDATED_TIMESTAMP
static final String	SERIALIZED_NAME_MONETIZATION
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_POLICIES
static final String	SERIALIZED_NAME_PROVIDER
static final String	SERIALIZED_NAME_RESPONSE_CACHING_ENABLED
static final String	SERIALIZED_NAME_REVISION_ID
static final String	SERIALIZED_NAME_REVISIONED_API_PRODUCT_ID
static final String	SERIALIZED_NAME_SCOPES
static final String	SERIALIZED_NAME_SECURITY_SCHEME
static final String	SERIALIZED_NAME_STATE
static final String	SERIALIZED_NAME_SUBSCRIPTION_AVAILABILITY
static final String	SERIALIZED_NAME_SUBSCRIPTION_AVAILABLE_TENANTS
static final String	SERIALIZED_NAME_TAGS
static final String	SERIALIZED_NAME_TRANSPORT
static final String	SERIALIZED_NAME_VERSION
static final String	SERIALIZED_NAME_VISIBILITY
static final String	SERIALIZED_NAME_VISIBLE_ROLES
static final String	SERIALIZED_NAME_VISIBLE_TENANTS
static final String	SERIALIZED_NAME_WORKFLOW_STATUS

Constructor Summary

Constructors

Constructor	Description
APIProductDTO()

Method Summary

Modifier and Type	Method	Description
APIProductDTO	accessControl(APIProductDTO.AccessControlEnum accessControl)
APIProductDTO	accessControlRoles(List<String> accessControlRoles)
APIProductDTO	additionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties)
APIProductDTO	additionalPropertiesMap(Map<String,APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap)
APIProductDTO	apiKeyHeader(String apiKeyHeader)
APIProductDTO	apis(List<ProductAPIDTO> apis)
APIProductDTO	apiThrottlingPolicy(String apiThrottlingPolicy)
APIProductDTO	apiType(APIProductDTO.ApiTypeEnum apiType)
APIProductDTO	audiences(List<String> audiences)
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)
boolean	equals(Object o)
APIProductDTO	gatewayVendor(String gatewayVendor)
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.
List<APIInfoAdditionalPropertiesDTO>	getAdditionalProperties()	Map of custom properties of API
Map<String,APIInfoAdditionalPropertiesMapDTO>	getAdditionalPropertiesMap()	Get additionalPropertiesMap
String	getApiKeyHeader()	Name of the API key header used for invoking the API.
List<ProductAPIDTO>	getApis()	APIs and resources in the API Product.
String	getApiThrottlingPolicy()	The API level throttling policy selected for the particular API Product
APIProductDTO.ApiTypeEnum	getApiType()	The API type to be used.
List<String>	getAudiences()	The audiences of the API for jwt validation.
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
String	getGatewayVendor()	Get gatewayVendor
String	getId()	UUID of the api product
String	getLastUpdatedTime()	Get lastUpdatedTime
String	getLastUpdatedTimestamp()	Get lastUpdatedTimestamp
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.
String	getRevisionedApiProductId()	UUID of the api product registry artifact
Integer	getRevisionId()	Get revisionId
List<APIScopeDTO>	getScopes()	Get scopes
List<String>	getSecurityScheme()	Types of API security, the current API secured with.
String	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).
String	getVersion()	Get version
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
String	getWorkflowStatus()	Get workflowStatus
int	hashCode()
APIProductDTO	hasThumbnail(Boolean hasThumbnail)
APIProductDTO	id(String id)
APIProductDTO	isDefaultVersion(Boolean isDefaultVersion)
Boolean	isEnableSchemaValidation()	Get enableSchemaValidation
Boolean	isHasThumbnail()	Get hasThumbnail
Boolean	isIsDefaultVersion()	Get isDefaultVersion
Boolean	isIsRevision()	Get isRevision
Boolean	isResponseCachingEnabled()	Get responseCachingEnabled
APIProductDTO	isRevision(Boolean isRevision)
APIProductDTO	lastUpdatedTime(String lastUpdatedTime)
APIProductDTO	lastUpdatedTimestamp(String lastUpdatedTimestamp)
APIProductDTO	monetization(APIMonetizationInfoDTO monetization)
APIProductDTO	name(String name)
APIProductDTO	policies(List<String> policies)
APIProductDTO	provider(String provider)
APIProductDTO	responseCachingEnabled(Boolean responseCachingEnabled)
APIProductDTO	revisionedApiProductId(String revisionedApiProductId)
APIProductDTO	revisionId(Integer revisionId)
APIProductDTO	scopes(List<APIScopeDTO> scopes)
APIProductDTO	securityScheme(List<String> securityScheme)
void	setAccessControl(APIProductDTO.AccessControlEnum accessControl)
void	setAccessControlRoles(List<String> accessControlRoles)
void	setAdditionalProperties(List<APIInfoAdditionalPropertiesDTO> additionalProperties)
void	setAdditionalPropertiesMap(Map<String,APIInfoAdditionalPropertiesMapDTO> additionalPropertiesMap)
void	setApiKeyHeader(String apiKeyHeader)
void	setApis(List<ProductAPIDTO> apis)
void	setApiThrottlingPolicy(String apiThrottlingPolicy)
void	setApiType(APIProductDTO.ApiTypeEnum apiType)
void	setAudiences(List<String> audiences)
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	setGatewayVendor(String gatewayVendor)
void	setHasThumbnail(Boolean hasThumbnail)
void	setId(String id)
void	setIsDefaultVersion(Boolean isDefaultVersion)
void	setIsRevision(Boolean isRevision)
void	setLastUpdatedTime(String lastUpdatedTime)
void	setLastUpdatedTimestamp(String lastUpdatedTimestamp)
void	setMonetization(APIMonetizationInfoDTO monetization)
void	setName(String name)
void	setPolicies(List<String> policies)
void	setProvider(String provider)
void	setResponseCachingEnabled(Boolean responseCachingEnabled)
void	setRevisionedApiProductId(String revisionedApiProductId)
void	setRevisionId(Integer revisionId)
void	setScopes(List<APIScopeDTO> scopes)
void	setSecurityScheme(List<String> securityScheme)
void	setState(String state)
void	setSubscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
void	setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
void	setTags(List<String> tags)
void	setTransport(List<String> transport)
void	setVersion(String version)
void	setVisibility(APIProductDTO.VisibilityEnum visibility)
void	setVisibleRoles(List<String> visibleRoles)
void	setVisibleTenants(List<String> visibleTenants)
void	setWorkflowStatus(String workflowStatus)
APIProductDTO	state(String state)
APIProductDTO	subscriptionAvailability(APIProductDTO.SubscriptionAvailabilityEnum subscriptionAvailability)
APIProductDTO	subscriptionAvailableTenants(List<String> subscriptionAvailableTenants)
APIProductDTO	tags(List<String> tags)
String	toString()
APIProductDTO	transport(List<String> transport)
APIProductDTO	version(String version)
APIProductDTO	visibility(APIProductDTO.VisibilityEnum visibility)
APIProductDTO	visibleRoles(List<String> visibleRoles)
APIProductDTO	visibleTenants(List<String> visibleTenants)
APIProductDTO	workflowStatus(String workflowStatus)

Methods inherited from class java.lang.Object

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

Field Details

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_VERSION

public static final String SERIALIZED_NAME_VERSION

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_DEFAULT_VERSION

public static final String SERIALIZED_NAME_IS_DEFAULT_VERSION

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_API_KEY_HEADER

public static final String SERIALIZED_NAME_API_KEY_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_TIMESTAMP

public static final String SERIALIZED_NAME_LAST_UPDATED_TIMESTAMP

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

SERIALIZED_NAME_AUDIENCES

public static final String SERIALIZED_NAME_AUDIENCES

See Also:

• Constant Field Values

Constructor Details

APIProductDTO

public APIProductDTO()

Method Details

id

public APIProductDTO id(String id)

getId

@Nullable
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

@Nullable
public String getContext()

Get context

Returns:

context

setContext

public void setContext(String context)

version

public APIProductDTO version(String version)

getVersion

@Nullable
public String getVersion()

Get version

Returns:

version

setVersion

public void setVersion(String version)

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)

isHasThumbnail

@Nullable
public Boolean isHasThumbnail()

Get hasThumbnail

Returns:

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)

isDefaultVersion

public APIProductDTO isDefaultVersion(Boolean isDefaultVersion)

isIsDefaultVersion

@Nullable
public Boolean isIsDefaultVersion()

Get isDefaultVersion

Returns:

isDefaultVersion

setIsDefaultVersion

public void setIsDefaultVersion(Boolean isDefaultVersion)

isRevision

public APIProductDTO isRevision(Boolean isRevision)

isIsRevision

@Nullable
public Boolean isIsRevision()

Get isRevision

Returns:

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)

getRevisionId

@Nullable
public Integer getRevisionId()

Get revisionId

Returns:

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)

getCacheTimeout

@Nullable
public Integer getCacheTimeout()

Get cacheTimeout

Returns:

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

setVisibleRoles

public void setVisibleRoles(List<String> visibleRoles)

visibleTenants

public APIProductDTO visibleTenants(List<String> visibleTenants)

getVisibleTenants

@Nullable
public List<String> getVisibleTenants()

Get visibleTenants

Returns:

visibleTenants

setVisibleTenants

public void setVisibleTenants(List<String> 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

setAccessControlRoles

public void setAccessControlRoles(List<String> 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

setTransport

public void setTransport(List<String> transport)

tags

public APIProductDTO tags(List<String> tags)

getTags

@Nullable
public List<String> getTags()

Get tags

Returns:

tags

setTags

public void setTags(List<String> tags)

policies

public APIProductDTO policies(List<String> policies)

getPolicies

@Nullable
public List<String> getPolicies()

Get policies

Returns:

policies

setPolicies

public void setPolicies(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)

apiKeyHeader

public APIProductDTO apiKeyHeader(String apiKeyHeader)

getApiKeyHeader

@Nullable
public String getApiKeyHeader()

Name of the API key header used for invoking the API. If it is not set, default value `apiKey` will be used.

Returns:

apiKeyHeader

setApiKeyHeader

public void setApiKeyHeader(String apiKeyHeader)

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

setSecurityScheme

public void setSecurityScheme(List<String> 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)

getCreatedTime

@Nullable
public String getCreatedTime()

Get createdTime

Returns:

createdTime

setCreatedTime

public void setCreatedTime(String createdTime)

lastUpdatedTimestamp

public APIProductDTO lastUpdatedTimestamp(String lastUpdatedTimestamp)

getLastUpdatedTimestamp

@Nullable
public String getLastUpdatedTimestamp()

Get lastUpdatedTimestamp

Returns:

lastUpdatedTimestamp

setLastUpdatedTimestamp

public void setLastUpdatedTimestamp(String lastUpdatedTimestamp)

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)

getCategories

@Nullable
public List<String> getCategories()

API categories

Returns:

categories

setCategories

public void setCategories(List<String> categories)

workflowStatus

public APIProductDTO workflowStatus(String workflowStatus)

getWorkflowStatus

@Nullable
public String getWorkflowStatus()

Get workflowStatus

Returns:

workflowStatus

setWorkflowStatus

public void setWorkflowStatus(String workflowStatus)

audiences

public APIProductDTO audiences(List<String> audiences)

getAudiences

@Nullable
public List<String> getAudiences()

The audiences of the API for jwt validation. Accepted values are any String values

Returns:

audiences

setAudiences

public void setAudiences(List<String> audiences)

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