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

Class APIProductInfoDTO

java.lang.Object

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

public class APIProductInfoDTO
extends Object

APIProductInfoDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIProductInfoDTO.StateEnum State of the API product.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CONTEXT
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_HAS_THUMBNAIL
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_PROVIDER
static String	SERIALIZED_NAME_SECURITY_SCHEME
static String	SERIALIZED_NAME_STATE

Constructor Summary

Constructors

Constructor and Description
APIProductInfoDTO()

Method Summary

Modifier and Type	Method and Description
APIProductInfoDTO	context(String context)
APIProductInfoDTO	description(String description)
boolean	equals(Object o)
String	getContext() Get context
String	getDescription() A brief description about the API
String	getId() UUID of the api product
String	getName() Name of the API Product
String	getProvider() If the provider value is not given, the user invoking the API will be used as the provider.
List<String>	getSecurityScheme() Types of API security, the current API secured with.
APIProductInfoDTO.StateEnum	getState() State of the API product.
int	hashCode()
APIProductInfoDTO	hasThumbnail(Boolean hasThumbnail)
APIProductInfoDTO	id(String id)
Boolean	isHasThumbnail() Get hasThumbnail
APIProductInfoDTO	name(String name)
APIProductInfoDTO	provider(String provider)
APIProductInfoDTO	securityScheme(List<String> securityScheme)
void	setContext(String context)
void	setDescription(String description)
void	setHasThumbnail(Boolean hasThumbnail)
void	setId(String id)
void	setName(String name)
void	setProvider(String provider)
void	setSecurityScheme(List<String> securityScheme)
void	setState(APIProductInfoDTO.StateEnum state)
APIProductInfoDTO	state(APIProductInfoDTO.StateEnum state)
String	toString()

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_CONTEXT

public static final String SERIALIZED_NAME_CONTEXT

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_PROVIDER

public static final String SERIALIZED_NAME_PROVIDER

See Also:

Constant Field Values

SERIALIZED_NAME_HAS_THUMBNAIL

public static final String SERIALIZED_NAME_HAS_THUMBNAIL

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_SECURITY_SCHEME

public static final String SERIALIZED_NAME_SECURITY_SCHEME

See Also:

Constant Field Values

Constructor Detail

APIProductInfoDTO

public APIProductInfoDTO()

Method Detail

id

public APIProductInfoDTO id(String id)

getId

@Nullable
public String getId()

UUID of the api product

Returns:

id

setId

public void setId(String id)

name

public APIProductInfoDTO name(String name)

getName

@Nullable
public String getName()

Name of the API Product

Returns:

name

setName

public void setName(String name)

context

public APIProductInfoDTO context(String context)

getContext

@Nullable
public String getContext()

Get context

Returns:

context

setContext

public void setContext(String context)

description

public APIProductInfoDTO description(String description)

getDescription

@Nullable
public String getDescription()

A brief description about the API

Returns:

description

setDescription

public void setDescription(String description)

provider

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

hasThumbnail

public APIProductInfoDTO hasThumbnail(Boolean hasThumbnail)

isHasThumbnail

@Nullable
public Boolean isHasThumbnail()

Get hasThumbnail

Returns:

hasThumbnail

setHasThumbnail

public void setHasThumbnail(Boolean hasThumbnail)

state

public APIProductInfoDTO state(APIProductInfoDTO.StateEnum state)

getState

@Nullable
public APIProductInfoDTO.StateEnum getState()

State of the API product. Only published api products are visible on the Developer Portal

Returns:

state

setState

public void setState(APIProductInfoDTO.StateEnum state)

securityScheme

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

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