APIDTO (Publisher API client 3.2.0 API)

java.lang.Object
- org.wso2.am.integration.clients.publisher.api.v1.dto.APIDTO

```
public class APIDTO
extends Object
```
APIDTO

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`APIDTO.AccessControlEnum` Is the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators.
`static class`	`APIDTO.EndpointImplementationTypeEnum` Gets or Sets endpointImplementationType
`static class`	`APIDTO.SubscriptionAvailabilityEnum` The subscription availability.
`static class`	`APIDTO.TypeEnum` The api creation type to be used.
`static class`	`APIDTO.VisibilityEnum` The visibility level of the API.

Constructor Summary

Constructors
Constructor and Description

APIDTO()

Constructors
Constructor and Description
`APIDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APIDTO`	`accessControl(APIDTO.AccessControlEnum accessControl)`
`APIDTO`	`accessControlRoles(List<String> accessControlRoles)`
`APIDTO`	`addAccessControlRolesItem(String accessControlRolesItem)`
`APIDTO`	`addCategoriesItem(String categoriesItem)`
`APIDTO`	`addGatewayEnvironmentsItem(String gatewayEnvironmentsItem)`
`APIDTO`	`additionalProperties(Map<String,String> additionalProperties)`
`APIDTO`	`addLabelsItem(String labelsItem)`
`APIDTO`	`addMediationPoliciesItem(MediationPolicyDTO mediationPoliciesItem)`
`APIDTO`	`addOperationsItem(APIOperationsDTO operationsItem)`
`APIDTO`	`addPoliciesItem(String policiesItem)`
`APIDTO`	`addScopesItem(APIScopeDTO scopesItem)`
`APIDTO`	`addSecuritySchemeItem(String securitySchemeItem)`
`APIDTO`	`addSubscriptionAvailableTenantsItem(String subscriptionAvailableTenantsItem)`
`APIDTO`	`addTagsItem(String tagsItem)`
`APIDTO`	`addTransportItem(String transportItem)`
`APIDTO`	`addVisibleRolesItem(String visibleRolesItem)`
`APIDTO`	`addVisibleTenantsItem(String visibleTenantsItem)`
`APIDTO`	`apiThrottlingPolicy(String apiThrottlingPolicy)`
`APIDTO`	`authorizationHeader(String authorizationHeader)`
`APIDTO`	`businessInformation(Object businessInformation)`
`APIDTO`	`cacheTimeout(Integer cacheTimeout)`
`APIDTO`	`categories(List<String> categories)`
`APIDTO`	`context(String context)`
`APIDTO`	`corsConfiguration(APICorsConfigurationDTO corsConfiguration)`
`APIDTO`	`createdTime(String createdTime)`
`APIDTO`	`description(String description)`
`APIDTO`	`destinationStatsEnabled(String destinationStatsEnabled)`
`APIDTO`	`enableSchemaValidation(Boolean enableSchemaValidation)`
`APIDTO`	`enableStore(Boolean enableStore)`
`APIDTO`	`endpointConfig(Object endpointConfig)`
`APIDTO`	`endpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType)`
`APIDTO`	`endpointSecurity(APIEndpointSecurityDTO endpointSecurity)`
`boolean`	`equals(Object o)`
`APIDTO`	`gatewayEnvironments(List<String> gatewayEnvironments)`
`APIDTO.AccessControlEnum`	`getAccessControl()` Is the API 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 publisher or creator.
`Map<String,String>`	`getAdditionalProperties()` Map of custom properties of API
`String`	`getApiThrottlingPolicy()` The API level throttling policy selected for the particular API
`String`	`getAuthorizationHeader()` Name of the Authorization header used for invoking the API.
`Object`	`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()` Get description
`String`	`getDestinationStatsEnabled()` Get destinationStatsEnabled
`Object`	`getEndpointConfig()` Endpoint configuration of the API.
`APIDTO.EndpointImplementationTypeEnum`	`getEndpointImplementationType()` Get endpointImplementationType
`APIEndpointSecurityDTO`	`getEndpointSecurity()` Get endpointSecurity
`List<String>`	`getGatewayEnvironments()` List of gateway environments the API is available
`String`	`getId()` UUID of the api registry artifact
`Object`	`getKeyManagers()` API Key Managers
`List<String>`	`getLabels()` Labels of micro-gateway environments attached to the API.
`String`	`getLastUpdatedTime()` Get lastUpdatedTime
`String`	`getLifeCycleStatus()` Get lifeCycleStatus
`APIMaxTpsDTO`	`getMaxTps()` Get maxTps
`List<MediationPolicyDTO>`	`getMediationPolicies()` Get mediationPolicies
`APIMonetizationInfoDTO`	`getMonetization()` Get monetization
`String`	`getName()` Get name
`List<APIOperationsDTO>`	`getOperations()` Get operations
`List<String>`	`getPolicies()` Get policies
`String`	`getProvider()` If the provider value is not given 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.
`APIDTO.SubscriptionAvailabilityEnum`	`getSubscriptionAvailability()` The subscription availability.
`List<String>`	`getSubscriptionAvailableTenants()` Get subscriptionAvailableTenants
`List<String>`	`getTags()` Get tags
`APIThreatProtectionPoliciesDTO`	`getThreatProtectionPolicies()` Get threatProtectionPolicies
`List<String>`	`getTransport()` Supported transports for the API (http and/or https).
`APIDTO.TypeEnum`	`getType()` The api creation type to be used.
`String`	`getVersion()` Get version
`APIDTO.VisibilityEnum`	`getVisibility()` The visibility level of the API.
`List<String>`	`getVisibleRoles()` The user roles that are able to access the API in Store
`List<String>`	`getVisibleTenants()` Get visibleTenants
`String`	`getWorkflowStatus()` Get workflowStatus
`WSDLInfoDTO`	`getWsdlInfo()` Get wsdlInfo
`String`	`getWsdlUrl()` Get wsdlUrl
`int`	`hashCode()`
`APIDTO`	`hasThumbnail(Boolean hasThumbnail)`
`APIDTO`	`id(String id)`
`APIDTO`	`isDefaultVersion(Boolean isDefaultVersion)`
`Boolean`	`isEnableSchemaValidation()` Get enableSchemaValidation
`Boolean`	`isEnableStore()` Get enableStore
`Boolean`	`isHasThumbnail()` Get hasThumbnail
`Boolean`	`isIsDefaultVersion()` Get isDefaultVersion
`Boolean`	`isResponseCachingEnabled()` Get responseCachingEnabled
`APIDTO`	`keyManagers(Object keyManagers)`
`APIDTO`	`labels(List<String> labels)`
`APIDTO`	`lastUpdatedTime(String lastUpdatedTime)`
`APIDTO`	`lifeCycleStatus(String lifeCycleStatus)`
`APIDTO`	`maxTps(APIMaxTpsDTO maxTps)`
`APIDTO`	`mediationPolicies(List<MediationPolicyDTO> mediationPolicies)`
`APIDTO`	`monetization(APIMonetizationInfoDTO monetization)`
`APIDTO`	`name(String name)`
`APIDTO`	`operations(List<APIOperationsDTO> operations)`
`APIDTO`	`policies(List<String> policies)`
`APIDTO`	`provider(String provider)`
`APIDTO`	`putAdditionalPropertiesItem(String key, String additionalPropertiesItem)`
`APIDTO`	`responseCachingEnabled(Boolean responseCachingEnabled)`
`APIDTO`	`scopes(List<APIScopeDTO> scopes)`
`APIDTO`	`securityScheme(List<String> securityScheme)`
`void`	`setAccessControl(APIDTO.AccessControlEnum accessControl)`
`void`	`setAccessControlRoles(List<String> accessControlRoles)`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setApiThrottlingPolicy(String apiThrottlingPolicy)`
`void`	`setAuthorizationHeader(String authorizationHeader)`
`void`	`setBusinessInformation(Object 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`	`setDestinationStatsEnabled(String destinationStatsEnabled)`
`void`	`setEnableSchemaValidation(Boolean enableSchemaValidation)`
`void`	`setEnableStore(Boolean enableStore)`
`void`	`setEndpointConfig(Object endpointConfig)`
`void`	`setEndpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType)`
`void`	`setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)`
`void`	`setGatewayEnvironments(List<String> gatewayEnvironments)`
`void`	`setHasThumbnail(Boolean hasThumbnail)`
`void`	`setId(String id)`
`void`	`setIsDefaultVersion(Boolean isDefaultVersion)`
`void`	`setKeyManagers(Object keyManagers)`
`void`	`setLabels(List<String> labels)`
`void`	`setLastUpdatedTime(String lastUpdatedTime)`
`void`	`setLifeCycleStatus(String lifeCycleStatus)`
`void`	`setMaxTps(APIMaxTpsDTO maxTps)`
`void`	`setMediationPolicies(List<MediationPolicyDTO> mediationPolicies)`
`void`	`setMonetization(APIMonetizationInfoDTO monetization)`
`void`	`setName(String name)`
`void`	`setOperations(List<APIOperationsDTO> operations)`
`void`	`setPolicies(List<String> policies)`
`void`	`setProvider(String provider)`
`void`	`setResponseCachingEnabled(Boolean responseCachingEnabled)`
`void`	`setScopes(List<APIScopeDTO> scopes)`
`void`	`setSecurityScheme(List<String> securityScheme)`
`void`	`setSubscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability)`
`void`	`setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)`
`void`	`setTags(List<String> tags)`
`void`	`setThreatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies)`
`void`	`setTransport(List<String> transport)`
`void`	`setType(APIDTO.TypeEnum type)`
`void`	`setVersion(String version)`
`void`	`setVisibility(APIDTO.VisibilityEnum visibility)`
`void`	`setVisibleRoles(List<String> visibleRoles)`
`void`	`setVisibleTenants(List<String> visibleTenants)`
`void`	`setWorkflowStatus(String workflowStatus)`
`void`	`setWsdlInfo(WSDLInfoDTO wsdlInfo)`
`void`	`setWsdlUrl(String wsdlUrl)`
`APIDTO`	`subscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability)`
`APIDTO`	`subscriptionAvailableTenants(List<String> subscriptionAvailableTenants)`
`APIDTO`	`tags(List<String> tags)`
`APIDTO`	`threatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies)`
`String`	`toString()`
`APIDTO`	`transport(List<String> transport)`
`APIDTO`	`type(APIDTO.TypeEnum type)`
`APIDTO`	`version(String version)`
`APIDTO`	`visibility(APIDTO.VisibilityEnum visibility)`
`APIDTO`	`visibleRoles(List<String> visibleRoles)`
`APIDTO`	`visibleTenants(List<String> visibleTenants)`
`APIDTO`	`workflowStatus(String workflowStatus)`
`APIDTO`	`wsdlInfo(WSDLInfoDTO wsdlInfo)`
`APIDTO`	`wsdlUrl(String wsdlUrl)`

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 registry artifact

Returns:

id

setId
```
public void setId(String id)
```

name
```
public APIDTO name(String name)
```

getName
```
public String getName()
```
Get name

Returns:

name

setName
```
public void setName(String name)
```

description

public APIDTO description(String description)

getDescription
```
public String getDescription()
```
Get description

Returns:

description

setDescription

public void setDescription(String description)

context

public APIDTO context(String context)

getContext
```
public String getContext()
```
Get context

Returns:

context

setContext

public void setContext(String context)

version

public APIDTO version(String version)

getVersion
```
public String getVersion()
```
Get version

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)

lifeCycleStatus

public APIDTO lifeCycleStatus(String lifeCycleStatus)

getLifeCycleStatus
```
public String getLifeCycleStatus()
```
Get lifeCycleStatus

Returns:

lifeCycleStatus

setLifeCycleStatus

public void setLifeCycleStatus(String lifeCycleStatus)

wsdlInfo

public APIDTO wsdlInfo(WSDLInfoDTO wsdlInfo)

getWsdlInfo
```
public WSDLInfoDTO getWsdlInfo()
```
Get wsdlInfo

Returns:

wsdlInfo

setWsdlInfo

public void setWsdlInfo(WSDLInfoDTO wsdlInfo)

wsdlUrl

public APIDTO wsdlUrl(String wsdlUrl)

getWsdlUrl
```
public String getWsdlUrl()
```
Get wsdlUrl

Returns:

wsdlUrl

setWsdlUrl

public void setWsdlUrl(String wsdlUrl)

responseCachingEnabled

public APIDTO responseCachingEnabled(Boolean responseCachingEnabled)

isResponseCachingEnabled
```
public Boolean isResponseCachingEnabled()
```
Get responseCachingEnabled

Returns:

responseCachingEnabled

setResponseCachingEnabled

public void setResponseCachingEnabled(Boolean responseCachingEnabled)

cacheTimeout

public APIDTO cacheTimeout(Integer cacheTimeout)

getCacheTimeout
```
public Integer getCacheTimeout()
```
Get cacheTimeout

Returns:

cacheTimeout

setCacheTimeout

public void setCacheTimeout(Integer cacheTimeout)

destinationStatsEnabled

public APIDTO destinationStatsEnabled(String destinationStatsEnabled)

getDestinationStatsEnabled
```
public String getDestinationStatsEnabled()
```
Get destinationStatsEnabled

Returns:

destinationStatsEnabled

setDestinationStatsEnabled

public void setDestinationStatsEnabled(String destinationStatsEnabled)

hasThumbnail

public APIDTO hasThumbnail(Boolean hasThumbnail)

isHasThumbnail
```
public Boolean isHasThumbnail()
```
Get hasThumbnail

Returns:

hasThumbnail

setHasThumbnail

public void setHasThumbnail(Boolean hasThumbnail)

isDefaultVersion

public APIDTO isDefaultVersion(Boolean isDefaultVersion)

isIsDefaultVersion
```
public Boolean isIsDefaultVersion()
```
Get isDefaultVersion

Returns:

isDefaultVersion

setIsDefaultVersion

public void setIsDefaultVersion(Boolean isDefaultVersion)

enableSchemaValidation

public APIDTO enableSchemaValidation(Boolean enableSchemaValidation)

isEnableSchemaValidation
```
public Boolean isEnableSchemaValidation()
```
Get enableSchemaValidation

Returns:

enableSchemaValidation

setEnableSchemaValidation

public void setEnableSchemaValidation(Boolean enableSchemaValidation)

enableStore

public APIDTO enableStore(Boolean enableStore)

isEnableStore
```
public Boolean isEnableStore()
```
Get enableStore

Returns:

enableStore

setEnableStore

public void setEnableStore(Boolean enableStore)

type

public APIDTO type(APIDTO.TypeEnum type)

getType
```
public APIDTO.TypeEnum getType()
```
The api creation type to be used. Accepted values are HTTP, WS, SOAPTOREST, GRAPHQL

Returns:

type

setType

public void setType(APIDTO.TypeEnum type)

transport

public APIDTO transport(List<String> transport)

addTransportItem

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

addTagsItem

public APIDTO addTagsItem(String tagsItem)

getTags
```
public List<String> getTags()
```
Get tags

Returns:

tags

setTags

public void setTags(List<String> tags)

policies

public APIDTO policies(List<String> policies)

addPoliciesItem

public APIDTO addPoliciesItem(String policiesItem)

getPolicies
```
public List<String> getPolicies()
```
Get policies

Returns:

policies

setPolicies

public void setPolicies(List<String> policies)

apiThrottlingPolicy

public APIDTO apiThrottlingPolicy(String apiThrottlingPolicy)

getApiThrottlingPolicy
```
public String getApiThrottlingPolicy()
```
The API level throttling policy selected for the particular API

Returns:

apiThrottlingPolicy

setApiThrottlingPolicy

public void setApiThrottlingPolicy(String apiThrottlingPolicy)

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)

maxTps

public APIDTO maxTps(APIMaxTpsDTO maxTps)

getMaxTps
```
public APIMaxTpsDTO getMaxTps()
```
Get maxTps

Returns:

maxTps

setMaxTps

public void setMaxTps(APIMaxTpsDTO maxTps)

visibility

public APIDTO visibility(APIDTO.VisibilityEnum visibility)

getVisibility
```
public APIDTO.VisibilityEnum getVisibility()
```
The visibility level of the API. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED.

Returns:

visibility

setVisibility

public void setVisibility(APIDTO.VisibilityEnum visibility)

visibleRoles

public APIDTO visibleRoles(List<String> visibleRoles)

addVisibleRolesItem

public APIDTO addVisibleRolesItem(String visibleRolesItem)

getVisibleRoles
```
public List<String> getVisibleRoles()
```
The user roles that are able to access the API in Store

Returns:

visibleRoles

setVisibleRoles

public void setVisibleRoles(List<String> visibleRoles)

visibleTenants

public APIDTO visibleTenants(List<String> visibleTenants)

addVisibleTenantsItem

public APIDTO addVisibleTenantsItem(String visibleTenantsItem)

getVisibleTenants
```
public List<String> getVisibleTenants()
```
Get visibleTenants

Returns:

visibleTenants

setVisibleTenants

public void setVisibleTenants(List<String> visibleTenants)

endpointSecurity

public APIDTO endpointSecurity(APIEndpointSecurityDTO endpointSecurity)

getEndpointSecurity
```
public APIEndpointSecurityDTO getEndpointSecurity()
```
Get endpointSecurity

Returns:

endpointSecurity

setEndpointSecurity

public void setEndpointSecurity(APIEndpointSecurityDTO endpointSecurity)

gatewayEnvironments

public APIDTO gatewayEnvironments(List<String> gatewayEnvironments)

addGatewayEnvironmentsItem

public APIDTO addGatewayEnvironmentsItem(String gatewayEnvironmentsItem)

getGatewayEnvironments
```
public List<String> getGatewayEnvironments()
```
List of gateway environments the API is available

Returns:

gatewayEnvironments

setGatewayEnvironments

public void setGatewayEnvironments(List<String> gatewayEnvironments)

labels

public APIDTO labels(List<String> labels)

addLabelsItem

public APIDTO addLabelsItem(String labelsItem)

getLabels
```
public List<String> getLabels()
```
Labels of micro-gateway environments attached to the API.

Returns:

labels

setLabels

public void setLabels(List<String> labels)

mediationPolicies

public APIDTO mediationPolicies(List<MediationPolicyDTO> mediationPolicies)

addMediationPoliciesItem

public APIDTO addMediationPoliciesItem(MediationPolicyDTO mediationPoliciesItem)

getMediationPolicies
```
public List<MediationPolicyDTO> getMediationPolicies()
```
Get mediationPolicies

Returns:

mediationPolicies

setMediationPolicies

public void setMediationPolicies(List<MediationPolicyDTO> mediationPolicies)

subscriptionAvailability

public APIDTO subscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability)

getSubscriptionAvailability
```
public APIDTO.SubscriptionAvailabilityEnum getSubscriptionAvailability()
```
The subscription availability. Accepts one of the following. CURRENT_TENANT, ALL_TENANTS or SPECIFIC_TENANTS.

Returns:

subscriptionAvailability

setSubscriptionAvailability

public void setSubscriptionAvailability(APIDTO.SubscriptionAvailabilityEnum subscriptionAvailability)

subscriptionAvailableTenants

public APIDTO subscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

addSubscriptionAvailableTenantsItem

public APIDTO addSubscriptionAvailableTenantsItem(String subscriptionAvailableTenantsItem)

getSubscriptionAvailableTenants
```
public List<String> getSubscriptionAvailableTenants()
```
Get subscriptionAvailableTenants

Returns:

subscriptionAvailableTenants

setSubscriptionAvailableTenants

public void setSubscriptionAvailableTenants(List<String> subscriptionAvailableTenants)

additionalProperties

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

putAdditionalPropertiesItem

public APIDTO 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 APIDTO monetization(APIMonetizationInfoDTO monetization)

getMonetization

public APIMonetizationInfoDTO getMonetization()

Get monetization

Returns:: monetization

setMonetization

public void setMonetization(APIMonetizationInfoDTO monetization)

accessControl

public APIDTO accessControl(APIDTO.AccessControlEnum accessControl)

getAccessControl
```
public APIDTO.AccessControlEnum getAccessControl()
```
Is the API 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 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(APIDTO.AccessControlEnum accessControl)

accessControlRoles

public APIDTO accessControlRoles(List<String> accessControlRoles)

addAccessControlRolesItem

public APIDTO addAccessControlRolesItem(String accessControlRolesItem)

getAccessControlRoles
```
public List<String> getAccessControlRoles()
```
The user roles that are able to view/modify as API publisher or creator.

Returns:

accessControlRoles

setAccessControlRoles

public void setAccessControlRoles(List<String> accessControlRoles)

businessInformation

public APIDTO businessInformation(Object businessInformation)

getBusinessInformation
```
public Object getBusinessInformation()
```
Get businessInformation

Returns:

businessInformation

setBusinessInformation

public void setBusinessInformation(Object businessInformation)

corsConfiguration

public APIDTO corsConfiguration(APICorsConfigurationDTO corsConfiguration)

getCorsConfiguration
```
public APICorsConfigurationDTO getCorsConfiguration()
```
Get corsConfiguration

Returns:

corsConfiguration

setCorsConfiguration

public void setCorsConfiguration(APICorsConfigurationDTO corsConfiguration)

workflowStatus

public APIDTO workflowStatus(String workflowStatus)

getWorkflowStatus
```
public String getWorkflowStatus()
```
Get workflowStatus

Returns:

workflowStatus

setWorkflowStatus

public void setWorkflowStatus(String workflowStatus)

createdTime

public APIDTO createdTime(String createdTime)

getCreatedTime
```
public String getCreatedTime()
```
Get createdTime

Returns:

createdTime

setCreatedTime

public void setCreatedTime(String createdTime)

lastUpdatedTime

public APIDTO lastUpdatedTime(String lastUpdatedTime)

getLastUpdatedTime
```
public String getLastUpdatedTime()
```
Get lastUpdatedTime

Returns:

lastUpdatedTime

setLastUpdatedTime

public void setLastUpdatedTime(String lastUpdatedTime)

endpointConfig

public APIDTO endpointConfig(Object endpointConfig)

getEndpointConfig
```
public Object getEndpointConfig()
```
Endpoint configuration of the API. This can be used to provide different types of endpoints including Simple REST Endpoints, Loadbalanced and Failover. `Simple REST Endpoint` { \"endpoint_type\": \"http\", \"sandbox_endpoints\": { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/\" }, \"production_endpoints\": { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/\" } } `Loadbalanced Endpoint` { \"endpoint_type\": \"load_balance\", \"algoCombo\": \"org.apache.synapse.endpoints.algorithms.RoundRobin\", \"sessionManagement\": \"\", \"sandbox_endpoints\": [ { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/1\" }, { \"endpoint_type\": \"http\", \"template_not_supported\": false, \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/2\" } ], \"production_endpoints\": [ { \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/3\" }, { \"endpoint_type\": \"http\", \"template_not_supported\": false, \"url\": \"https://localhost:9443/am/sample/pizzashack/v1/api/4\" } ], \"sessionTimeOut\": \"\", \"algoClassName\": \"org.apache.synapse.endpoints.algorithms.RoundRobin\" } `Failover Endpoint` { \"production_failovers\":[ { \"endpoint_type\":\"http\", \"template_not_supported\":false, \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/1\" } ], \"endpoint_type\":\"failover\", \"sandbox_endpoints\":{ \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/2\" }, \"production_endpoints\":{ \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/3\" }, \"sandbox_failovers\":[ { \"endpoint_type\":\"http\", \"template_not_supported\":false, \"url\":\"https://localhost:9443/am/sample/pizzashack/v1/api/4\" } ] } `Default Endpoint` { \"endpoint_type\":\"default\", \"sandbox_endpoints\":{ \"url\":\"default\" }, \"production_endpoints\":{ \"url\":\"default\" } } `Endpoint from Endpoint Registry` { \"endpoint_type\": \"Registry\", \"endpoint_id\": \"{registry-name:entry-name:version}\", }

Returns:

endpointConfig

setEndpointConfig

public void setEndpointConfig(Object endpointConfig)

endpointImplementationType

public APIDTO endpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType)

getEndpointImplementationType
```
public APIDTO.EndpointImplementationTypeEnum getEndpointImplementationType()
```
Get endpointImplementationType

Returns:

endpointImplementationType

setEndpointImplementationType

public void setEndpointImplementationType(APIDTO.EndpointImplementationTypeEnum endpointImplementationType)

scopes

public APIDTO scopes(List<APIScopeDTO> scopes)

addScopesItem

public APIDTO addScopesItem(APIScopeDTO scopesItem)

getScopes
```
public List<APIScopeDTO> getScopes()
```
Get scopes

Returns:

scopes

setScopes

public void setScopes(List<APIScopeDTO> scopes)

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)

threatProtectionPolicies

public APIDTO threatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies)

getThreatProtectionPolicies
```
public APIThreatProtectionPoliciesDTO getThreatProtectionPolicies()
```
Get threatProtectionPolicies

Returns:

threatProtectionPolicies

setThreatProtectionPolicies

public void setThreatProtectionPolicies(APIThreatProtectionPoliciesDTO threatProtectionPolicies)

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

Class APIDTO

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APIDTO

Method Detail

id

getId

setId

name

getName

setName

description

getDescription

setDescription

context

getContext

setContext

version

getVersion

setVersion

provider

getProvider

setProvider

lifeCycleStatus

getLifeCycleStatus

setLifeCycleStatus

wsdlInfo

getWsdlInfo

setWsdlInfo

wsdlUrl

getWsdlUrl

setWsdlUrl

responseCachingEnabled

isResponseCachingEnabled

setResponseCachingEnabled

cacheTimeout

getCacheTimeout

setCacheTimeout

destinationStatsEnabled

getDestinationStatsEnabled

setDestinationStatsEnabled

hasThumbnail

isHasThumbnail

setHasThumbnail

isDefaultVersion

isIsDefaultVersion

setIsDefaultVersion

enableSchemaValidation

isEnableSchemaValidation

setEnableSchemaValidation

enableStore

isEnableStore

setEnableStore

type

getType

setType

transport

addTransportItem

getTransport

setTransport

tags

addTagsItem

getTags

setTags

policies

addPoliciesItem

getPolicies

setPolicies

apiThrottlingPolicy

getApiThrottlingPolicy

setApiThrottlingPolicy

authorizationHeader

getAuthorizationHeader

setAuthorizationHeader

securityScheme

addSecuritySchemeItem

getSecurityScheme