org.apache.nifi.web.api.dto

Class DocumentedTypeDTO

java.lang.Object

org.apache.nifi.web.api.dto.DocumentedTypeDTO

public class DocumentedTypeDTO
extends Object

Class used for providing documentation of a specified type.

Field Summary

Fields

Modifier and Type	Field and Description
private BundleDTO	bundle
private List<ControllerServiceApiDTO>	controllerServiceApis
private String	deprecationReason
private String	description
private Set<ExplicitRestrictionDTO>	explicitRestrictions
private boolean	restricted
private Set<String>	tags
private String	type
private String	usageRestriction

Constructor Summary

Constructors

Constructor and Description
DocumentedTypeDTO()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
BundleDTO	getBundle() The details of the artifact that bundled this type.
List<ControllerServiceApiDTO>	getControllerServiceApis() If this type represents a ControllerService, this lists the APIs it implements.
String	getDeprecationReason()
String	getDescription()
Set<ExplicitRestrictionDTO>	getExplicitRestrictions()
Set<String>	getTags()
String	getType()
String	getUsageRestriction()
int	hashCode()
boolean	isRestricted()
void	setBundle(BundleDTO bundle)
void	setControllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)
void	setDeprecationReason(String deprecationReason)
void	setDescription(String description)
void	setExplicitRestrictions(Set<ExplicitRestrictionDTO> explicitRestrictions)
void	setRestricted(boolean restricted)
void	setTags(Set<String> tags)
void	setType(String type)
void	setUsageRestriction(String usageRestriction)

Methods inherited from class java.lang.Object

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

Field Detail

type

private String type

bundle

private BundleDTO bundle

controllerServiceApis

private List<ControllerServiceApiDTO> controllerServiceApis

description

private String description

restricted

private boolean restricted

usageRestriction

private String usageRestriction

explicitRestrictions

private Set<ExplicitRestrictionDTO> explicitRestrictions

deprecationReason

private String deprecationReason

tags

private Set<String> tags

Constructor Detail

DocumentedTypeDTO

public DocumentedTypeDTO()

Method Detail

getDescription

public String getDescription()

Returns:

An optional description of the corresponding type

setDescription

public void setDescription(String description)

isRestricted

public boolean isRestricted()

Returns:

Whether this type is restricted

setRestricted

public void setRestricted(boolean restricted)

getExplicitRestrictions

public Set<ExplicitRestrictionDTO> getExplicitRestrictions()

Returns:

An optional collection of explicit restrictions

setExplicitRestrictions

public void setExplicitRestrictions(Set<ExplicitRestrictionDTO> explicitRestrictions)

getUsageRestriction

public String getUsageRestriction()

Returns:

An optional description of why the usage of this component is restricted

setUsageRestriction

public void setUsageRestriction(String usageRestriction)

getDeprecationReason

public String getDeprecationReason()

Returns:

An optional description of why the usage of this component is deprecated

setDeprecationReason

public void setDeprecationReason(String deprecationReason)

getType

public String getType()

Returns:

The type is the fully-qualified name of a Java class

setType

public void setType(String type)

getBundle

public BundleDTO getBundle()

The details of the artifact that bundled this type.

Returns:

The bundle details

setBundle

public void setBundle(BundleDTO bundle)

getControllerServiceApis

public List<ControllerServiceApiDTO> getControllerServiceApis()

If this type represents a ControllerService, this lists the APIs it implements.

Returns:

The listing of implemented APIs

setControllerServiceApis

public void setControllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)

getTags

public Set<String> getTags()

Returns:

The tags associated with this type

setTags

public void setTags(Set<String> tags)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object