io.cdap.cdap.api.metadata

Interface MetadataReader

All Known Subinterfaces:

CustomActionContext, HttpServiceContext, MapReduceContext, ServiceContext, SparkClientContext, WorkerContext, WorkflowContext

@Beta
public interface MetadataReader

The context for reading metadata from program

Method Summary

Modifier and Type	Method and Description
Map<MetadataScope,Metadata>	getMetadata(MetadataEntity metadataEntity) Returns a Map of MetadataScope to Metadata representing all metadata (including properties and tags) for the specified MetadataEntity in both MetadataScope.USER and MetadataScope.SYSTEM.
Metadata	getMetadata(MetadataScope scope, MetadataEntity metadataEntity) Returns a Metadata representing all metadata (including properties and tags) for the specified MetadataEntity in the specified MetadataScope.

Method Detail

getMetadata

Map<MetadataScope,Metadata> getMetadata(MetadataEntity metadataEntity)
                                 throws MetadataException

Returns a Map of MetadataScope to Metadata representing all metadata (including properties and tags) for the specified MetadataEntity in both MetadataScope.USER and MetadataScope.SYSTEM. The map will be empty if the there is no metadata associated with the given metadataEntity.

Throws:

MetadataException - if the metadata operation fails

getMetadata

Metadata getMetadata(MetadataScope scope,
                     MetadataEntity metadataEntity)
              throws MetadataException

Returns a Metadata representing all metadata (including properties and tags) for the specified MetadataEntity in the specified MetadataScope. Metadata will be empty if the there is no metadata associated with the given metadataEntity.

Throws:

MetadataException - if the metadata operation fails