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

Class APISearchResultDTO

java.lang.Object

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

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

public class APISearchResultDTO
extends SearchResultDTO

APISearchResultDTO

Nested Class Summary

Nested classes/interfaces inherited from class org.wso2.am.integration.clients.publisher.api.v1.dto.SearchResultDTO

SearchResultDTO.TypeEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_ADVERTISE_ONLY
static final String	SERIALIZED_NAME_CONTEXT
static final String	SERIALIZED_NAME_CONTEXT_TEMPLATE
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_PROVIDER
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_THUMBNAIL_URI
static final String	SERIALIZED_NAME_VERSION

Fields inherited from class org.wso2.am.integration.clients.publisher.api.v1.dto.SearchResultDTO

name, SERIALIZED_NAME_ID, SERIALIZED_NAME_NAME, SERIALIZED_NAME_TRANSPORT_TYPE, SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
APISearchResultDTO()

Method Summary

Modifier and Type	Method	Description
APISearchResultDTO	advertiseOnly(Boolean advertiseOnly)
APISearchResultDTO	context(String context)
APISearchResultDTO	contextTemplate(String contextTemplate)
APISearchResultDTO	description(String description)
boolean	equals(Object o)
String	getContext()	A string that represents the context of the user's request
String	getContextTemplate()	The templated context of the API
String	getDescription()	A brief description about the API
String	getProvider()	If the provider value is not given, the user invoking the API will be used as the provider.
String	getStatus()	This describes in which status of the lifecycle the API is
String	getThumbnailUri()	Get thumbnailUri
String	getVersion()	The version of the API
int	hashCode()
Boolean	isAdvertiseOnly()	Get advertiseOnly
APISearchResultDTO	provider(String provider)
void	setAdvertiseOnly(Boolean advertiseOnly)
void	setContext(String context)
void	setContextTemplate(String contextTemplate)
void	setDescription(String description)
void	setProvider(String provider)
void	setStatus(String status)
void	setThumbnailUri(String thumbnailUri)
void	setVersion(String version)
APISearchResultDTO	status(String status)
APISearchResultDTO	thumbnailUri(String thumbnailUri)
String	toString()
APISearchResultDTO	version(String version)

Methods inherited from class org.wso2.am.integration.clients.publisher.api.v1.dto.SearchResultDTO

getId, getName, getTransportType, getType, id, name, setId, setName, setTransportType, setType, transportType, type

Methods inherited from class java.lang.Object

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

Field Details

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_CONTEXT_TEMPLATE

public static final String SERIALIZED_NAME_CONTEXT_TEMPLATE

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_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_THUMBNAIL_URI

public static final String SERIALIZED_NAME_THUMBNAIL_URI

See Also:

• Constant Field Values

SERIALIZED_NAME_ADVERTISE_ONLY

public static final String SERIALIZED_NAME_ADVERTISE_ONLY

See Also:

• Constant Field Values

Constructor Details

APISearchResultDTO

public APISearchResultDTO()

Method Details

description

public APISearchResultDTO description(String description)

getDescription

@Nullable
public String getDescription()

A brief description about the API

Returns:

description

setDescription

public void setDescription(String description)

context

public APISearchResultDTO context(String context)

getContext

@Nullable
public String getContext()

A string that represents the context of the user's request

Returns:

context

setContext

public void setContext(String context)

contextTemplate

public APISearchResultDTO contextTemplate(String contextTemplate)

getContextTemplate

@Nullable
public String getContextTemplate()

The templated context of the API

Returns:

contextTemplate

setContextTemplate

public void setContextTemplate(String contextTemplate)

version

public APISearchResultDTO version(String version)

getVersion

@Nullable
public String getVersion()

The version of the API

Returns:

version

setVersion

public void setVersion(String version)

provider

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

status

public APISearchResultDTO status(String status)

getStatus

@Nullable
public String getStatus()

This describes in which status of the lifecycle the API is

Returns:

status

setStatus

public void setStatus(String status)

thumbnailUri

public APISearchResultDTO thumbnailUri(String thumbnailUri)

getThumbnailUri

@Nullable
public String getThumbnailUri()

Get thumbnailUri

Returns:

thumbnailUri

setThumbnailUri

public void setThumbnailUri(String thumbnailUri)

advertiseOnly

public APISearchResultDTO advertiseOnly(Boolean advertiseOnly)

isAdvertiseOnly

@Nullable
public Boolean isAdvertiseOnly()

Get advertiseOnly

Returns:

advertiseOnly

setAdvertiseOnly

public void setAdvertiseOnly(Boolean advertiseOnly)

equals

public boolean equals(Object o)

Overrides:

equals in class SearchResultDTO

hashCode

public int hashCode()

Overrides:

hashCode in class SearchResultDTO

toString

public String toString()

Overrides:

toString in class SearchResultDTO