com.hpe.adm.nga.sdk.metadata

Class Metadata

java.lang.Object

com.hpe.adm.nga.sdk.metadata.Metadata

public class Metadata
extends Object

This class hold the metadata object and serves all functionality concern to fields metadata and entity metadata.
The REST API metadata is split into two: entities and fields. For each context the correct method used:

[server_url]/metadata/entities use entities()

[server_url]/metadata/fields use fields()

In addition you can use the API to retrieve specific entities and fields. For example:

[server_url]/metadata/entities?query="name EQ 'story'" use entities(String...) with "story" as the parameter

[server_url]/metadata/fields?query="entity_name EQ 'pipeline'" use fields(String...) with "pipeline" as the parameter

Metadata can only be read (HTTP GET) so after the correct method is called the execute() method should be used.

See Also:

for more information about entity metadata, for more information about field metadata

Constructor Summary

Constructors

Constructor and Description
Metadata(OctaneHttpClient octaneHttpClient, String strMetadataDomain) Creates a new Metadata object

Method Summary

Modifier and Type	Method and Description
GetEntityMetadata	entities() GetEntities metadata entity object
GetEntityMetadata	entities(String... entities) GetEntities metadata entity object based on given entities names
GetFieldMetadata	fields() GetEntities metadata field object
GetFieldMetadata	fields(String... entities) GetEntities metadata field object based on given field names

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

public Metadata(OctaneHttpClient octaneHttpClient,
                String strMetadataDomain)

Creates a new Metadata object

Parameters:

octaneHttpClient - - Http Request Factory

strMetadataDomain - - metadata Domain Name

Method Detail

entities

public GetEntityMetadata entities()

GetEntities metadata entity object

Returns:

new metadata entity object

entities

public GetEntityMetadata entities(String... entities)

GetEntities metadata entity object based on given entities names

Parameters:

entities - A comma separated array of entities that will be created to the context

Returns:

new metadata entity object

fields

public GetFieldMetadata fields()

GetEntities metadata field object

Returns:

new field object

fields

public GetFieldMetadata fields(String... entities)

GetEntities metadata field object based on given field names

Parameters:

entities - list of entities that will be returned

Returns:

an object containing field metadata