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

Class APIDTO

  • public class APIDTO
extends Object
    APIDTO

    • Constructor Detail

      • APIDTO

        public APIDTO()

    • Method Detail

      • setId

        public void setId​(String id)

      • getName

        public String getName()
        Name of the API
        Returns:
        name

      • setName

        public void setName​(String name)

      • description

        public APIDTO description​(String description)

      • getDescription

        @Nullable
public String getDescription()
        A brief description about the API
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getContext

        public String getContext()
        A string that represents thecontext of the user's request
        Returns:
        context

      • setContext

        public void setContext​(String context)

      • getVersion

        public String getVersion()
        The version of the API
        Returns:
        version

      • setVersion

        public void setVersion​(String version)

      • 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)

      • apiDefinition

        public APIDTO apiDefinition​(String apiDefinition)

      • getApiDefinition

        @Nullable
public String getApiDefinition()
        Swagger definition of the API which contains details about URI templates and scopes
        Returns:
        apiDefinition

      • setApiDefinition

        public void setApiDefinition​(String apiDefinition)

      • getWsdlUri

        @Nullable
public String getWsdlUri()
        WSDL URL if the API is based on a WSDL endpoint
        Returns:
        wsdlUri

      • setWsdlUri

        public void setWsdlUri​(String wsdlUri)

      • lifeCycleStatus

        public APIDTO lifeCycleStatus​(String lifeCycleStatus)

      • getLifeCycleStatus

        public String getLifeCycleStatus()
        This describes in which status of the lifecycle the API is.
        Returns:
        lifeCycleStatus

      • setLifeCycleStatus

        public void setLifeCycleStatus​(String lifeCycleStatus)

      • isDefaultVersion

        public APIDTO isDefaultVersion​(Boolean isDefaultVersion)

      • isIsDefaultVersion

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

      • setIsDefaultVersion

        public void setIsDefaultVersion​(Boolean isDefaultVersion)

      • getType

        @Nullable
public String getType()
        This describes the transport type of the API
        Returns:
        type

      • setType

        public void setType​(String type)

      • setTransport

        public void setTransport​(List<String> transport)

      • 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)

      • getTags

        @Nullable
public List<String> getTags()
        Search keywords related to the API
        Returns:
        tags

      • setTags

        public void setTags​(List<String> tags)

      • getTiers

        @Nullable
public List<APITiersDTO> getTiers()
        The subscription tiers selected for the particular API
        Returns:
        tiers

      • hasThumbnail

        public APIDTO hasThumbnail​(Boolean hasThumbnail)

      • isHasThumbnail

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

      • setHasThumbnail

        public void setHasThumbnail​(Boolean hasThumbnail)

      • environmentList

        public APIDTO environmentList​(List<String> environmentList)

      • getEnvironmentList

        @Nullable
public List<String> getEnvironmentList()
        The environment list configured with non empty endpoint URLs for the particular API.
        Returns:
        environmentList

      • setEnvironmentList

        public void setEnvironmentList​(List<String> environmentList)

      • getAvgRating

        @Nullable
public String getAvgRating()
        The average rating of the API
        Returns:
        avgRating

      • setAvgRating

        public void setAvgRating​(String avgRating)

      • setAdvertiseInfo

        public void setAdvertiseInfo​(AdvertiseInfoDTO advertiseInfo)

      • isSubscriptionAvailable

        public APIDTO isSubscriptionAvailable​(Boolean isSubscriptionAvailable)

      • isIsSubscriptionAvailable

        @Nullable
public Boolean isIsSubscriptionAvailable()
        Get isSubscriptionAvailable
        Returns:
        isSubscriptionAvailable

      • setIsSubscriptionAvailable

        public void setIsSubscriptionAvailable​(Boolean isSubscriptionAvailable)

      • 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)

      • 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)

      • 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 aync API.
        Returns:
        asyncTransportProtocols

      • setAsyncTransportProtocols

        public void setAsyncTransportProtocols​(List<String> asyncTransportProtocols)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object