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

Class APIDTO

java.lang.Object

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

public class APIDTO
extends Object

APIDTO

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ADDITIONAL_PROPERTIES
static String	SERIALIZED_NAME_ADVERTISE_INFO
static String	SERIALIZED_NAME_API_DEFINITION
static String	SERIALIZED_NAME_AUTHORIZATION_HEADER
static String	SERIALIZED_NAME_AVG_RATING
static String	SERIALIZED_NAME_BUSINESS_INFORMATION
static String	SERIALIZED_NAME_CATEGORIES
static String	SERIALIZED_NAME_CONTEXT
static String	SERIALIZED_NAME_CREATED_TIME
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_ENDPOINT_U_R_LS
static String	SERIALIZED_NAME_ENVIRONMENT_LIST
static String	SERIALIZED_NAME_HAS_THUMBNAIL
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_INGRESS_U_R_LS
static String	SERIALIZED_NAME_IS_DEFAULT_VERSION
static String	SERIALIZED_NAME_IS_SUBSCRIPTION_AVAILABLE
static String	SERIALIZED_NAME_KEY_MANAGERS
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_LAST_UPDATED_TIME
static String	SERIALIZED_NAME_LIFE_CYCLE_STATUS
static String	SERIALIZED_NAME_MONETIZATION
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_OPERATIONS
static String	SERIALIZED_NAME_PROVIDER
static String	SERIALIZED_NAME_SCOPES
static String	SERIALIZED_NAME_SECURITY_SCHEME
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_TIERS
static String	SERIALIZED_NAME_TRANSPORT
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_VERSION
static String	SERIALIZED_NAME_WSDL_URI

Constructor Summary

Constructors

Constructor and Description
APIDTO()

Method Summary

Modifier and Type	Method and Description
APIDTO	additionalProperties(List<APIAdditionalPropertiesDTO> additionalProperties)
APIDTO	advertiseInfo(AdvertiseInfoDTO advertiseInfo)
APIDTO	apiDefinition(String apiDefinition)
APIDTO	authorizationHeader(String authorizationHeader)
APIDTO	avgRating(String avgRating)
APIDTO	businessInformation(APIBusinessInformationDTO businessInformation)
APIDTO	categories(List<String> categories)
APIDTO	context(String context)
APIDTO	createdTime(String createdTime)
APIDTO	description(String description)
APIDTO	endpointURLs(List<APIEndpointURLsDTO> endpointURLs)
APIDTO	environmentList(List<String> environmentList)
boolean	equals(Object o)
List<APIAdditionalPropertiesDTO>	getAdditionalProperties() Custom(user defined) properties of API
AdvertiseInfoDTO	getAdvertiseInfo() Get advertiseInfo
String	getApiDefinition() Swagger definition of the API which contains details about URI templates and scopes
String	getAuthorizationHeader() Name of the Authorization header used for invoking the API.
String	getAvgRating() The average rating of the API
APIBusinessInformationDTO	getBusinessInformation() Get businessInformation
List<String>	getCategories() API categories
String	getContext() A string that represents thecontext of the user's request
String	getCreatedTime() Get createdTime
String	getDescription() A brief description about the API
List<APIEndpointURLsDTO>	getEndpointURLs() Get endpointURLs
List<String>	getEnvironmentList() The environment list configured with non empty endpoint URLs for the particular API.
String	getId() UUID of the api
List<APIIngressURLsDTO>	getIngressURLs() Get ingressURLs
Object	getKeyManagers() API Key Managers
List<LabelDTO>	getLabels() Labels of micro-gateway environments attached to the API.
String	getLastUpdatedTime() Get lastUpdatedTime
String	getLifeCycleStatus() This describes in which status of the lifecycle the API is.
APIMonetizationInfoDTO	getMonetization() Get monetization
String	getName() Name of the API
List<APIOperationsDTO>	getOperations() Get operations
String	getProvider() If the provider value is not given user invoking the api will be used as the provider.
List<ScopeInfoDTO>	getScopes() Get scopes
List<String>	getSecurityScheme() Types of API security, the current API secured with.
List<String>	getTags() Search keywords related to the API
List<APITiersDTO>	getTiers() The subscription tiers selected for the particular API
List<String>	getTransport() Get transport
String	getType() This describes the transport type of the API
String	getVersion() The version of the API
String	getWsdlUri() WSDL URL if the API is based on a WSDL endpoint
int	hashCode()
APIDTO	hasThumbnail(Boolean hasThumbnail)
APIDTO	id(String id)
APIDTO	ingressURLs(List<APIIngressURLsDTO> ingressURLs)
APIDTO	isDefaultVersion(Boolean isDefaultVersion)
Boolean	isHasThumbnail() Get hasThumbnail
Boolean	isIsDefaultVersion() Get isDefaultVersion
Boolean	isIsSubscriptionAvailable() Get isSubscriptionAvailable
APIDTO	isSubscriptionAvailable(Boolean isSubscriptionAvailable)
APIDTO	keyManagers(Object keyManagers)
APIDTO	labels(List<LabelDTO> labels)
APIDTO	lastUpdatedTime(String lastUpdatedTime)
APIDTO	lifeCycleStatus(String lifeCycleStatus)
APIDTO	monetization(APIMonetizationInfoDTO monetization)
APIDTO	name(String name)
APIDTO	operations(List<APIOperationsDTO> operations)
APIDTO	provider(String provider)
APIDTO	scopes(List<ScopeInfoDTO> scopes)
APIDTO	securityScheme(List<String> securityScheme)
void	setAdditionalProperties(List<APIAdditionalPropertiesDTO> additionalProperties)
void	setAdvertiseInfo(AdvertiseInfoDTO advertiseInfo)
void	setApiDefinition(String apiDefinition)
void	setAuthorizationHeader(String authorizationHeader)
void	setAvgRating(String avgRating)
void	setBusinessInformation(APIBusinessInformationDTO businessInformation)
void	setCategories(List<String> categories)
void	setContext(String context)
void	setCreatedTime(String createdTime)
void	setDescription(String description)
void	setEndpointURLs(List<APIEndpointURLsDTO> endpointURLs)
void	setEnvironmentList(List<String> environmentList)
void	setHasThumbnail(Boolean hasThumbnail)
void	setId(String id)
void	setIngressURLs(List<APIIngressURLsDTO> ingressURLs)
void	setIsDefaultVersion(Boolean isDefaultVersion)
void	setIsSubscriptionAvailable(Boolean isSubscriptionAvailable)
void	setKeyManagers(Object keyManagers)
void	setLabels(List<LabelDTO> labels)
void	setLastUpdatedTime(String lastUpdatedTime)
void	setLifeCycleStatus(String lifeCycleStatus)
void	setMonetization(APIMonetizationInfoDTO monetization)
void	setName(String name)
void	setOperations(List<APIOperationsDTO> operations)
void	setProvider(String provider)
void	setScopes(List<ScopeInfoDTO> scopes)
void	setSecurityScheme(List<String> securityScheme)
void	setTags(List<String> tags)
void	setTiers(List<APITiersDTO> tiers)
void	setTransport(List<String> transport)
void	setType(String type)
void	setVersion(String version)
void	setWsdlUri(String wsdlUri)
APIDTO	tags(List<String> tags)
APIDTO	tiers(List<APITiersDTO> tiers)
String	toString()
APIDTO	transport(List<String> transport)
APIDTO	type(String type)
APIDTO	version(String version)
APIDTO	wsdlUri(String wsdlUri)

Methods inherited from class java.lang.Object

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

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_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

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_PROVIDER

public static final String SERIALIZED_NAME_PROVIDER

See Also:

Constant Field Values

SERIALIZED_NAME_API_DEFINITION

public static final String SERIALIZED_NAME_API_DEFINITION

See Also:

Constant Field Values

SERIALIZED_NAME_WSDL_URI

public static final String SERIALIZED_NAME_WSDL_URI

See Also:

Constant Field Values

SERIALIZED_NAME_LIFE_CYCLE_STATUS

public static final String SERIALIZED_NAME_LIFE_CYCLE_STATUS

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_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSPORT

public static final String SERIALIZED_NAME_TRANSPORT

See Also:

Constant Field Values

SERIALIZED_NAME_OPERATIONS

public static final String SERIALIZED_NAME_OPERATIONS

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_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_TIERS

public static final String SERIALIZED_NAME_TIERS

See Also:

Constant Field Values

SERIALIZED_NAME_HAS_THUMBNAIL

public static final String SERIALIZED_NAME_HAS_THUMBNAIL

See Also:

Constant Field Values

SERIALIZED_NAME_ADDITIONAL_PROPERTIES

public static final String SERIALIZED_NAME_ADDITIONAL_PROPERTIES

See Also:

Constant Field Values

SERIALIZED_NAME_MONETIZATION

public static final String SERIALIZED_NAME_MONETIZATION

See Also:

Constant Field Values

SERIALIZED_NAME_INGRESS_U_R_LS

public static final String SERIALIZED_NAME_INGRESS_U_R_LS

See Also:

Constant Field Values

SERIALIZED_NAME_ENDPOINT_U_R_LS

public static final String SERIALIZED_NAME_ENDPOINT_U_R_LS

See Also:

Constant Field Values

SERIALIZED_NAME_BUSINESS_INFORMATION

public static final String SERIALIZED_NAME_BUSINESS_INFORMATION

See Also:

Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

Constant Field Values

SERIALIZED_NAME_ENVIRONMENT_LIST

public static final String SERIALIZED_NAME_ENVIRONMENT_LIST

See Also:

Constant Field Values

SERIALIZED_NAME_SCOPES

public static final String SERIALIZED_NAME_SCOPES

See Also:

Constant Field Values

SERIALIZED_NAME_AVG_RATING

public static final String SERIALIZED_NAME_AVG_RATING

See Also:

Constant Field Values

SERIALIZED_NAME_ADVERTISE_INFO

public static final String SERIALIZED_NAME_ADVERTISE_INFO

See Also:

Constant Field Values

SERIALIZED_NAME_IS_SUBSCRIPTION_AVAILABLE

public static final String SERIALIZED_NAME_IS_SUBSCRIPTION_AVAILABLE

See Also:

Constant Field Values

SERIALIZED_NAME_CATEGORIES

public static final String SERIALIZED_NAME_CATEGORIES

See Also:

Constant Field Values

SERIALIZED_NAME_KEY_MANAGERS

public static final String SERIALIZED_NAME_KEY_MANAGERS

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

Constructor Detail

APIDTO

public APIDTO()

Method Detail

id

public APIDTO id(String id)

getId

@Nullable
public String getId()

UUID of the api

Returns:

id

setId

public void setId(String id)

name

public APIDTO name(String name)

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)

context

public APIDTO context(String context)

getContext

public String getContext()

A string that represents thecontext of the user's request

Returns:

context

setContext

public void setContext(String context)

version

public APIDTO version(String version)

getVersion

public String getVersion()

The version of the API

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)

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)

wsdlUri

public APIDTO wsdlUri(String wsdlUri)

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)

type

public APIDTO type(String type)

getType

@Nullable
public String getType()

This describes the transport type of the API

Returns:

type

setType

public void setType(String type)

transport

public APIDTO transport(List<String> transport)

getTransport

@Nullable
public List<String> getTransport()

Get transport

Returns:

transport

setTransport

public void setTransport(List<String> transport)

operations

public APIDTO operations(List<APIOperationsDTO> operations)

getOperations

@Nullable
public List<APIOperationsDTO> getOperations()

Get operations

Returns:

operations

setOperations

public void setOperations(List<APIOperationsDTO> operations)

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)

tags

public APIDTO tags(List<String> tags)

getTags

@Nullable
public List<String> getTags()

Search keywords related to the API

Returns:

tags

setTags

public void setTags(List<String> tags)

tiers

public APIDTO tiers(List<APITiersDTO> tiers)

getTiers

@Nullable
public List<APITiersDTO> getTiers()

The subscription tiers selected for the particular API

Returns:

tiers

setTiers

public void setTiers(List<APITiersDTO> tiers)

hasThumbnail

public APIDTO hasThumbnail(Boolean hasThumbnail)

isHasThumbnail

@Nullable
public Boolean isHasThumbnail()

Get hasThumbnail

Returns:

hasThumbnail

setHasThumbnail

public void setHasThumbnail(Boolean hasThumbnail)

additionalProperties

public APIDTO additionalProperties(List<APIAdditionalPropertiesDTO> additionalProperties)

getAdditionalProperties

@Nullable
public List<APIAdditionalPropertiesDTO> getAdditionalProperties()

Custom(user defined) properties of API

Returns:

additionalProperties

setAdditionalProperties

public void setAdditionalProperties(List<APIAdditionalPropertiesDTO> additionalProperties)

monetization

public APIDTO monetization(APIMonetizationInfoDTO monetization)

getMonetization

@Nullable
public APIMonetizationInfoDTO getMonetization()

Get monetization

Returns:

monetization

setMonetization

public void setMonetization(APIMonetizationInfoDTO monetization)

ingressURLs

public APIDTO ingressURLs(List<APIIngressURLsDTO> ingressURLs)

getIngressURLs

@Nullable
public List<APIIngressURLsDTO> getIngressURLs()

Get ingressURLs

Returns:

ingressURLs

setIngressURLs

public void setIngressURLs(List<APIIngressURLsDTO> ingressURLs)

endpointURLs

public APIDTO endpointURLs(List<APIEndpointURLsDTO> endpointURLs)

getEndpointURLs

@Nullable
public List<APIEndpointURLsDTO> getEndpointURLs()

Get endpointURLs

Returns:

endpointURLs

setEndpointURLs

public void setEndpointURLs(List<APIEndpointURLsDTO> endpointURLs)

businessInformation

public APIDTO businessInformation(APIBusinessInformationDTO businessInformation)

getBusinessInformation

@Nullable
public APIBusinessInformationDTO getBusinessInformation()

Get businessInformation

Returns:

businessInformation

setBusinessInformation

public void setBusinessInformation(APIBusinessInformationDTO businessInformation)

labels

public APIDTO labels(List<LabelDTO> labels)

getLabels

@Nullable
public List<LabelDTO> getLabels()

Labels of micro-gateway environments attached to the API.

Returns:

labels

setLabels

public void setLabels(List<LabelDTO> labels)

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)

scopes

public APIDTO scopes(List<ScopeInfoDTO> scopes)

getScopes

@Nullable
public List<ScopeInfoDTO> getScopes()

Get scopes

Returns:

scopes

setScopes

public void setScopes(List<ScopeInfoDTO> scopes)

avgRating

public APIDTO avgRating(String avgRating)

getAvgRating

@Nullable
public String getAvgRating()

The average rating of the API

Returns:

avgRating

setAvgRating

public void setAvgRating(String avgRating)

advertiseInfo

public APIDTO advertiseInfo(AdvertiseInfoDTO advertiseInfo)

getAdvertiseInfo

@Nullable
public AdvertiseInfoDTO getAdvertiseInfo()

Get advertiseInfo

Returns:

advertiseInfo

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)

categories

public APIDTO categories(List<String> categories)

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)

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