@ProviderType public interface ModelDescription
Modifier and Type | Method and Description |
---|---|
Iterable<ActionDescription> |
getActions()
Get the descriptions of the actions defined in the model.
|
String |
getCategory()
Gets the model's category.
|
Iterable<EntityDescription> |
getEntities()
Get the descriptions of the entities defined in the model.
|
int |
getEntityCount()
Get the count of entities to be serialized into the response.
|
Iterable<HeaderDescription> |
getHeaders()
Get the descriptions of the headers defined in the model.
|
Iterable<LinkDescription> |
getLinks()
Get the descriptions of the links defined in the model.
|
ModelPathMapper |
getMapper()
Gets the ModelPathMapper used by the model.
|
Object |
getModel()
Gets the model object.
|
String[] |
getModelTypes()
Get the model types, as defined by the type property on the ApiModel annotation.
|
String |
getNextOffsetValue()
Get the value to use as the next offset for paginated requests.
|
Iterable<PropertyDescription> |
getProperties()
Get the descriptions of properties defined in the model.
|
PropertyDescription |
getProperty(String name)
Get the description for a specific property defined in the model by name.
|
@Nonnull ModelPathMapper getMapper()
Object getModel()
@Nonnull String[] getModelTypes()
@CheckForNull String getNextOffsetValue()
int getEntityCount()
@Nonnull Iterable<ActionDescription> getActions()
@Nonnull Iterable<LinkDescription> getLinks()
@Nonnull Iterable<EntityDescription> getEntities()
@Nonnull Iterable<PropertyDescription> getProperties()
@CheckForNull PropertyDescription getProperty(String name)
name
- The property name.@Nonnull Iterable<HeaderDescription> getHeaders()
Copyright © 2010 - 2020 Adobe. All Rights Reserved