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

Class APIDTO

  • public class APIDTO
extends Object
    APIDTO

    • Constructor Detail

      • APIDTO

        public APIDTO()

    • Method Detail

      • getId

        @Nullable
public String getId()
        UUID of the api registry artifact
        Returns:
        id

      • setId

        public void setId​(String id)

      • getName

        public String getName()
        Get name
        Returns:
        name

      • setName

        public void setName​(String name)

      • description

        public APIDTO description​(String description)

      • getDescription

        @Nullable
public String getDescription()
        Get description
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getContext

        public String getContext()
        Get context
        Returns:
        context

      • setContext

        public void setContext​(String context)

      • getVersion

        public String getVersion()
        Get version
        Returns:
        version

      • setVersion

        public void setVersion​(String version)

      • getProvider

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

        @Nullable
public String getLifeCycleStatus()
        Get lifeCycleStatus
        Returns:
        lifeCycleStatus

      • setLifeCycleStatus

        public void setLifeCycleStatus​(String lifeCycleStatus)

      • setWsdlInfo

        public void setWsdlInfo​(WSDLInfoDTO wsdlInfo)

      • getWsdlUrl

        @Nullable
public String getWsdlUrl()
        Get wsdlUrl
        Returns:
        wsdlUrl

      • setWsdlUrl

        public void setWsdlUrl​(String wsdlUrl)

      • responseCachingEnabled

        public APIDTO responseCachingEnabled​(Boolean responseCachingEnabled)

      • isResponseCachingEnabled

        @Nullable
public Boolean isResponseCachingEnabled()
        Get responseCachingEnabled
        Returns:
        responseCachingEnabled

      • setResponseCachingEnabled

        public void setResponseCachingEnabled​(Boolean responseCachingEnabled)

      • cacheTimeout

        public APIDTO cacheTimeout​(Integer cacheTimeout)

      • getCacheTimeout

        @Nullable
public Integer getCacheTimeout()
        Get cacheTimeout
        Returns:
        cacheTimeout

      • setCacheTimeout

        public void setCacheTimeout​(Integer cacheTimeout)

      • hasThumbnail

        public APIDTO hasThumbnail​(Boolean hasThumbnail)

      • isHasThumbnail

        @Nullable
public Boolean isHasThumbnail()
        Get hasThumbnail
        Returns:
        hasThumbnail

      • setHasThumbnail

        public void setHasThumbnail​(Boolean hasThumbnail)

      • isDefaultVersion

        public APIDTO isDefaultVersion​(Boolean isDefaultVersion)

      • isIsDefaultVersion

        @Nullable
public Boolean isIsDefaultVersion()
        Get isDefaultVersion
        Returns:
        isDefaultVersion

      • setIsDefaultVersion

        public void setIsDefaultVersion​(Boolean isDefaultVersion)

      • isIsRevision

        @Nullable
public Boolean isIsRevision()
        Get isRevision
        Returns:
        isRevision

      • setIsRevision

        public void setIsRevision​(Boolean isRevision)

      • revisionedApiId

        public APIDTO revisionedApiId​(String revisionedApiId)

      • getRevisionedApiId

        @Nullable
public String getRevisionedApiId()
        UUID of the api registry artifact
        Returns:
        revisionedApiId

      • setRevisionedApiId

        public void setRevisionedApiId​(String revisionedApiId)

      • getRevisionId

        @Nullable
public Integer getRevisionId()
        Get revisionId
        Returns:
        revisionId

      • setRevisionId

        public void setRevisionId​(Integer revisionId)

      • enableSchemaValidation

        public APIDTO enableSchemaValidation​(Boolean enableSchemaValidation)

      • isEnableSchemaValidation

        @Nullable
public Boolean isEnableSchemaValidation()
        Get enableSchemaValidation
        Returns:
        enableSchemaValidation

      • setEnableSchemaValidation

        public void setEnableSchemaValidation​(Boolean enableSchemaValidation)

      • enableSubscriberVerification

        public APIDTO enableSubscriberVerification​(Boolean enableSubscriberVerification)

      • isEnableSubscriberVerification

        @Nullable
public Boolean isEnableSubscriberVerification()
        Get enableSubscriberVerification
        Returns:
        enableSubscriberVerification

      • setEnableSubscriberVerification

        public void setEnableSubscriberVerification​(Boolean enableSubscriberVerification)

      • getType

        @Nullable
public APIDTO.TypeEnum getType()
        The api creation type to be used. Accepted values are HTTP, WS, SOAPTOREST, GRAPHQL, WEBSUB, SSE, WEBHOOK, ASYNC
        Returns:
        type

      • getAudience

        @Nullable
public APIDTO.AudienceEnum getAudience()
        The audience of the API. Accepted values are PUBLIC, SINGLE
        Returns:
        audience

      • getTransport

        @Nullable
public List<String> getTransport()
        Supported transports for the API (http and/or https).
        Returns:
        transport

      • setTransport

        public void setTransport​(List<String> transport)

      • setTags

        public void setTags​(List<String> tags)

      • setPolicies

        public void setPolicies​(List<String> policies)

      • apiThrottlingPolicy

        public APIDTO apiThrottlingPolicy​(String apiThrottlingPolicy)

      • getApiThrottlingPolicy

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

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

      • setMaxTps

        public void setMaxTps​(APIMaxTpsDTO maxTps)

      • getVisibility

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

      • getVisibleRoles

        @Nullable
public List<String> getVisibleRoles()
        The user roles that are able to access the API in Developer Portal
        Returns:
        visibleRoles

      • setVisibleRoles

        public void setVisibleRoles​(List<String> visibleRoles)

      • visibleTenants

        public APIDTO visibleTenants​(List<String> visibleTenants)

      • getVisibleTenants

        @Nullable
public List<String> getVisibleTenants()
        Get visibleTenants
        Returns:
        visibleTenants

      • setVisibleTenants

        public void setVisibleTenants​(List<String> visibleTenants)

      • getSubscriptionAvailability

        @Nullable
public APIDTO.SubscriptionAvailabilityEnum getSubscriptionAvailability()
        The subscription availability. Accepts one of the following. CURRENT_TENANT, ALL_TENANTS or SPECIFIC_TENANTS.
        Returns:
        subscriptionAvailability

      • subscriptionAvailableTenants

        public APIDTO subscriptionAvailableTenants​(List<String> subscriptionAvailableTenants)

      • getSubscriptionAvailableTenants

        @Nullable
public List<String> getSubscriptionAvailableTenants()
        Get subscriptionAvailableTenants
        Returns:
        subscriptionAvailableTenants

      • setSubscriptionAvailableTenants

        public void setSubscriptionAvailableTenants​(List<String> subscriptionAvailableTenants)

      • getAccessControl

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

      • accessControlRoles

        public APIDTO accessControlRoles​(List<String> accessControlRoles)

      • getAccessControlRoles

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

      • workflowStatus

        public APIDTO workflowStatus​(String workflowStatus)

      • getWorkflowStatus

        @Nullable
public String getWorkflowStatus()
        Get workflowStatus
        Returns:
        workflowStatus

      • setWorkflowStatus

        public void setWorkflowStatus​(String workflowStatus)

      • createdTime

        public APIDTO createdTime​(String createdTime)

      • getCreatedTime

        @Nullable
public String getCreatedTime()
        Get createdTime
        Returns:
        createdTime

      • setCreatedTime

        public void setCreatedTime​(String createdTime)

      • lastUpdatedTime

        public APIDTO lastUpdatedTime​(String lastUpdatedTime)

      • getLastUpdatedTime

        @Nullable
public String getLastUpdatedTime()
        Get lastUpdatedTime
        Returns:
        lastUpdatedTime

      • setLastUpdatedTime

        public void setLastUpdatedTime​(String lastUpdatedTime)

      • endpointConfig

        public APIDTO endpointConfig​(Object endpointConfig)

      • getEndpointConfig

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

      • getCategories

        @Nullable
public List<String> getCategories()
        API categories
        Returns:
        categories

      • setCategories

        public void setCategories​(List<String> categories)

      • keyManagers

        public APIDTO keyManagers​(Object keyManagers)

      • getKeyManagers

        @Nullable
public Object getKeyManagers()
        API Key Managers
        Returns:
        keyManagers

      • setKeyManagers

        public void setKeyManagers​(Object keyManagers)

      • setAdvertiseInfo

        public void setAdvertiseInfo​(AdvertiseInfoDTO advertiseInfo)

      • gatewayVendor

        public APIDTO gatewayVendor​(String gatewayVendor)

      • getGatewayVendor

        @Nullable
public String getGatewayVendor()
        Get gatewayVendor
        Returns:
        gatewayVendor

      • setGatewayVendor

        public void setGatewayVendor​(String gatewayVendor)

      • asyncTransportProtocols

        public APIDTO asyncTransportProtocols​(List<String> asyncTransportProtocols)

      • getAsyncTransportProtocols

        @Nullable
public List<String> getAsyncTransportProtocols()
        Supported transports for the async API (http and/or https).
        Returns:
        asyncTransportProtocols

      • setAsyncTransportProtocols

        public void setAsyncTransportProtocols​(List<String> asyncTransportProtocols)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object